Skip to content

A platform for community discussion. Free, open, simple.

UX: Keep filter reset controls visible to avoid layout shifts

Régis Hanoldd9b3011331e
diff --git a/frontend/discourse/app/ui-kit/d-filter-controls.gjs b/frontend/discourse/app/ui-kit/d-filter-controls.gjs
index 747b5cb7900..a6cd4493e28 100644
--- a/frontend/discourse/app/ui-kit/d-filter-controls.gjs
+++ b/frontend/discourse/app/ui-kit/d-filter-controls.gjs
@@ -24,8 +24,11 @@ const ResetButton = <template>
<DButton
class="btn-default d-filter-controls__reset"
@action={{@action}}
+ @ariaLabel="filter_controls.reset"
+ @disabled={{@disabled}}
@icon="arrow-rotate-left"
- @label="filter_controls.reset"
+ @label={{@label}}
+ @title="filter_controls.reset"
/>
</template>;
@@ -176,14 +179,6 @@ export default class DFilterControls extends Component {
return !this.showDropdownFilterToggle;
}
- get showFilterResetButton() {
- return (
- this.showResetButton &&
- !this.showDropdownFilterToggle &&
- this.hasActiveFilters
- );
- }
-
get showTextFilter() {
return this.args.showTextFilter ?? true;
}
@@ -513,8 +508,11 @@ export default class DFilterControls extends Component {
}}
@title="filter_controls.toggle"
/>
- {{#if (and this.showResetButton this.hasActiveFilters)}}
- <ResetButton @action={{this.resetFilters}} />
+ {{#if this.showResetButton}}
+ <ResetButton
+ @action={{this.resetFilters}}
+ @disabled={{not this.hasActiveFilters}}
+ />
{{/if}}
{{/if}}
</div>
@@ -584,8 +582,11 @@ export default class DFilterControls extends Component {
</div>
{{/if}}
- {{#if this.showFilterResetButton}}
- <ResetButton @action={{this.resetFilters}} />
+ {{#if (and this.showResetButton (not this.showDropdownFilterToggle))}}
+ <ResetButton
+ @action={{this.resetFilters}}
+ @disabled={{not this.hasActiveFilters}}
+ />
{{/if}}
{{yield to="actions"}}
@@ -603,7 +604,10 @@ export default class DFilterControls extends Component {
<p>{{@noResultsMessage}}</p>
{{/if}}
{{#if this.showResetButton}}
- <ResetButton @action={{this.resetFilters}} />
+ <ResetButton
+ @action={{this.resetFilters}}
+ @label="filter_controls.reset"
+ />
{{/if}}
</div>
{{/if}}
diff --git a/frontend/discourse/tests/integration/ui-kit/d-filter-controls-test.gjs b/frontend/discourse/tests/integration/ui-kit/d-filter-controls-test.gjs
index 4b645887803..e15c200222b 100644
--- a/frontend/discourse/tests/integration/ui-kit/d-filter-controls-test.gjs
+++ b/frontend/discourse/tests/integration/ui-kit/d-filter-controls-test.gjs
@@ -5,6 +5,7 @@ import { click, fillIn, render, select, settled } from "@ember/test-helpers";
import { module, test } from "qunit";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import DFilterControls from "discourse/ui-kit/d-filter-controls";
+import { i18n } from "discourse-i18n";
const SAMPLE_DATA = [
{
@@ -169,13 +170,13 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
assert.dom(".custom-filter").exists("renders the additional filter");
assert
.dom(".d-filter-controls__reset")
- .doesNotExist("hides reset while the additional filter is inactive");
+ .isDisabled("disables reset while the additional filter is inactive");
this.set("additionalFiltersActive", true);
assert
.dom(".d-filter-controls__reset")
- .exists("shows reset while the additional filter is active");
+ .isEnabled("enables reset while the additional filter is active");
await click(".d-filter-controls__reset");
@@ -273,6 +274,16 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
assert
.dom(".d-filter-controls__dropdown")
.exists("reveals the dropdown after toggling filters");
+
+ await select(".d-filter-controls__dropdown", "feature");
+
+ assert
+ .dom(".d-filter-controls__reset")
+ .exists({ count: 1 }, "shows a single reset button")
+ .isEnabled("enables reset for the active dropdown");
+ assert
+ .dom(".d-filter-controls > .d-filter-controls__reset")
+ .doesNotExist("does not duplicate reset outside the drawer controls");
});
test("can show expanded dropdowns without a filter toggle", async function (assert) {
@@ -311,32 +322,6 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
.exists({ count: 1 }, "shows reset when an expanded filter is active");
});
- test("shows one reset button with a forced single-dropdown toggle", async function (assert) {
- this.set("data", SAMPLE_DATA);
- this.set("searchableProps", ["name"]);
- this.set("dropdownOptions", SAMPLE_DROPDOWN_OPTIONS);
-
- await render(
- <template>
- <DFilterControls
- @array={{this.data}}
- @dropdownOptions={{this.dropdownOptions}}
- @forceShowDropdownFilterToggle={{true}}
- @searchableProps={{this.searchableProps}}
- />
- </template>
- );
-
- await fillIn(".filter-input", "first");
-
- assert
- .dom(".d-filter-controls__reset")
- .exists({ count: 1 }, "shows a single reset button");
- assert
- .dom(".d-filter-controls > .d-filter-controls__reset")
- .doesNotExist("does not show a second reset button after the dropdowns");
- });
-
test("filters data by single dropdown (client-side)", async function (assert) {
this.set("data", SAMPLE_DATA);
this.set("dropdownOptions", SAMPLE_DROPDOWN_OPTIONS);
@@ -443,7 +428,7 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
assert.dom(".item[data-id='3']").exists("shows the correct item");
});
- test("shows reset button when filters are active", async function (assert) {
+ test("keeps reset visible and enables it only for active filters", async function (assert) {
this.set("data", SAMPLE_DATA);
this.set("searchableProps", ["name"]);
@@ -451,6 +436,7 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
<template>
<DFilterControls
@array={{this.data}}
+ @loading={{this.loading}}
@searchableProps={{this.searchableProps}}
>
<:content as |filteredData|>
@@ -466,8 +452,38 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
assert
.dom(".d-filter-controls__reset")
- .doesNotExist("no reset button initially");
+ .isDisabled("reset is visible and disabled initially");
+ assert
+ .dom(".d-filter-controls__reset .d-button-label")
+ .doesNotExist("Reset has no visible text label");
+ assert
+ .dom(".d-filter-controls__reset")
+ .hasAttribute(
+ "title",
+ i18n("filter_controls.reset"),
+ "provides a tooltip"
+ )
+ .hasAttribute(
+ "aria-label",
+ i18n("filter_controls.reset"),
+ "provides an accessible name"
+ );
+
+ await fillIn(".filter-input", "first");
+ assert.dom(".item").exists({ count: 1 }, "filters matching items");
+ assert
+ .dom(".d-filter-controls > .d-filter-controls__reset")
+ .isEnabled("enables reset when the search has results");
+
+ this.set("loading", true);
+ await settled();
+
+ assert
+ .dom(".d-filter-controls > .d-filter-controls__reset")
+ .isEnabled("reset stays available during a reload");
+
+ this.set("loading", false);
await fillIn(".filter-input", "nonexistent");
assert
@@ -475,7 +491,21 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
.exists("shows no results message");
assert
.dom(".d-filter-controls__reset")
- .exists("shows reset button after filtering");
+ .isEnabled("enables reset after filtering");
+ assert
+ .dom(".d-filter-controls__no-results .d-filter-controls__reset")
+ .hasText(i18n("filter_controls.reset"), "labels the empty-state reset");
+ assert
+ .dom(".d-filter-controls > .d-filter-controls__reset .d-button-label")
+ .doesNotExist("keeps the toolbar reset icon-only");
+
+ await click(".d-filter-controls > .d-filter-controls__reset");
+
+ assert
+ .dom(".d-filter-controls__reset")
+ .isDisabled("reset stays visible after restoring defaults");
+ assert.dom(".item").exists({ count: 3 }, "restores all items");
+ assert.dom(".filter-input").hasValue("", "clears the search");
});
test("can hide the built-in no-results state", async function (assert) {
@@ -523,97 +553,6 @@ module("Integration | ui-kit | DFilterControls", function (hooks) {
.doesNotExist("does not render the reset button");
});
- test("reset button clears filters", async function (assert) {
- this.set("data", SAMPLE_DATA);
- this.set("searchableProps", ["name"]);
-
- await render(
- <template>
- <DFilterControls
- @array={{this.data}}
- @searchableProps={{this.searchableProps}}
- >
- <:content as |filteredData|>
- <div class="results">
- {{#each filteredData as |item|}}
- <div class="item" data-id={{item.id}}>{{item.name}}</div>
- {{/each}}
- </div>
- </:content>
- </DFilterControls>
- </template>
- );
-
- await fillIn(".filter-input", "first");
-
- assert.dom(".item").exists({ count: 1 }, "shows filtered results");
-
- await fillIn(".filter-input", "firstblah");
- assert
- .dom(".item")
- .doesNotExist("does not show any results when filters find none");
-
- await click(".d-filter-controls__reset");
-
- assert.dom(".item").exists({ count: 3 }, "shows all items after reset");
- assert.dom(".filter-input").hasValue("", "clears text input");
- });
-
- test("shows the reset button next to the input when a text filter finds results", async function (assert) {
- this.set("data", SAMPLE_DATA);
- this.set("searchableProps", ["name"]);
-
- await render(
- <template>
- <DFilterControls
- @array={{this.data}}
- @searchableProps={{this.searchableProps}}
- >
- <:content as |filteredData|>
- <div class="results">
- {{#each filteredData as |item|}}
- <div class="item" data-id={{item.id}}>{{item.name}}</div>
- {{/each}}
- </div>
- </:content>
- </DFilterControls>
- </template>
- );
-
- await fillIn(".filter-input", "first");
- assert
- .dom(".d-filter-controls > .d-filter-controls__reset")
- .exists("shows the reset button beside the input");
- });
-
- test("keeps the reset button visible while loading", async function (assert) {
- this.set("data", SAMPLE_DATA);
- this.set("onTextFilterChange", () => {});
-
- await render(
- <template>
- <DFilterControls
- @array={{this.data}}
- @loading={{true}}
- @onTextFilterChange={{this.onTextFilterChange}}
- >
- <:content as |filteredData|>
- <div class="results">
- {{#each filteredData as |item|}}
- <div class="item" data-id={{item.id}}>{{item.name}}</div>
- {{/each}}
- </div>
- </:content>
- </DFilterControls>
- </template>
- );
-
- await fillIn(".filter-input", "first");
- assert
- .dom(".d-filter-controls > .d-filter-controls__reset")
- .exists("reset button stays put during a reload");
- });
-
test("respects minItemsForFilter parameter", async function (assert) {
this.set("data", [SAMPLE_DATA[0]]);
diff --git a/spec/system/d_filter_controls_spec.rb b/spec/system/d_filter_controls_spec.rb
index e8367cb2d6a..bd95e6ef30e 100644
--- a/spec/system/d_filter_controls_spec.rb
+++ b/spec/system/d_filter_controls_spec.rb
@@ -16,79 +16,48 @@ describe "DFilterControls" do
Discourse.stubs(:plugins_sorted_by_name).returns([poll_plugin, spoiler_alert_plugin])
end
- describe "text filtering" do
- it "filters plugins by text input" do
- page.visit("/admin/plugins")
+ it "lets admins search plugins and reset matching or empty results" do
+ page.visit("/admin/plugins")
- expect(page).to have_css(".d-filter-controls")
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
+ expect(filter_controls).to have_disabled_reset_button
+ expect(filter_controls).to have_no_no_results_reset_button
- filter_controls.type_in_search("poll")
- expect(page).to have_css(".admin-plugins-list__row", count: 1)
+ filter_controls.type_in_search("poll")
+ expect(page).to have_css(".admin-plugins-list__row", count: 1)
- filter_controls.clear_search
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
- end
- end
-
- describe "dropdown filtering" do
- it "filters plugins by dropdown selection" do
- page.visit("/admin/plugins")
+ filter_controls.clear_search
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
+ expect(filter_controls).to have_disabled_reset_button
- expect(page).to have_css(".d-filter-controls")
+ filter_controls.type_in_search("poll")
+ expect(page).to have_css(".admin-plugins-list__row", count: 1)
- filter_controls.select_dropdown_option("Enabled")
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
+ filter_controls.click_reset_button
+ expect(filter_controls.search_input_value).to eq("")
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
- filter_controls.select_dropdown_option("Disabled")
- expect(page).to have_css(".admin-plugins-list__row", count: 0)
+ filter_controls.type_in_search("xyznonexistent")
+ expect(page).to have_css(".admin-plugins-list__row", count: 0)
+ expect(filter_controls).to have_no_results_message
+ expect(filter_controls).to have_no_results_reset_button
- filter_controls.select_dropdown_option("All")
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
- end
+ filter_controls.click_no_results_reset_button
+ expect(filter_controls.search_input_value).to eq("")
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
+ expect(filter_controls).to have_disabled_reset_button
end
- describe "reset functionality" do
- it "shows reset button when filters are active and no results" do
- page.visit("/admin/plugins")
-
- expect(page).to have_css(".d-filter-controls")
-
- expect(filter_controls).to have_no_no_results_reset_button
- filter_controls.type_in_search("xyznonexistent")
- expect(page).to have_css(".admin-plugins-list__row", count: 0)
- expect(filter_controls).to have_no_results_reset_button
-
- filter_controls.click_no_results_reset_button
- expect(filter_controls.search_input_value).to eq("")
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
- end
-
- it "also shows reset button when there are results and active filters" do
- page.visit("/admin/plugins")
-
- expect(page).to have_css(".d-filter-controls")
-
- expect(filter_controls).to have_no_reset_button
- filter_controls.type_in_search("poll")
- expect(page).to have_css(".admin-plugins-list__row", count: 1)
- expect(filter_controls).to have_reset_button
-
- filter_controls.click_reset_button
- expect(filter_controls.search_input_value).to eq("")
- expect(page).to have_css(".admin-plugins-list__row", count: 2)
- end
- end
+ it "lets admins filter plugins by status" do
+ page.visit("/admin/plugins")
- describe "no results message" do
- it "shows configurable no results message" do
- page.visit("/admin/plugins")
+ filter_controls.select_dropdown_option("Enabled")
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
- expect(page).to have_css(".d-filter-controls")
+ filter_controls.select_dropdown_option("Disabled")
+ expect(page).to have_css(".admin-plugins-list__row", count: 0)
- filter_controls.type_in_search("xyznonexistent")
- expect(page).to have_css(".admin-plugins-list__row", count: 0)
- expect(filter_controls).to have_no_results_message
- end
+ filter_controls.select_dropdown_option("All")
+ expect(page).to have_css(".admin-plugins-list__row", count: 2)
end
end
diff --git a/spec/system/page_objects/components/d_filter_controls.rb b/spec/system/page_objects/components/d_filter_controls.rb
index 0347e806a4f..1496dfb2489 100644
--- a/spec/system/page_objects/components/d_filter_controls.rb
+++ b/spec/system/page_objects/components/d_filter_controls.rb
@@ -40,8 +40,8 @@ module PageObjects
page.has_css?(".d-filter-controls__no-results .d-filter-controls__reset")
end
- def has_reset_button?
- component.has_css?(".d-filter-controls__reset")
+ def has_disabled_reset_button?
+ component.has_css?(".d-filter-controls__reset:disabled")
end
def click_reset_button
@@ -56,10 +56,6 @@ module PageObjects
page.has_no_css?(".d-filter-controls__no-results .d-filter-controls__reset")
end
- def has_no_reset_button?
- component.has_no_css?(".d-filter-controls__reset")
- end
-
def has_no_results_message?
page.has_css?(".d-filter-controls__no-results")
end