Skip to content

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

FIX: Keep the selected option in Safari when `DSelect` options re-render (#42169)

Régis Hanol8ff0214fd963
diff --git a/frontend/discourse/app/ui-kit/d-select.gjs b/frontend/discourse/app/ui-kit/d-select.gjs
index 7c97c6a82e6..cb62935af24 100644
--- a/frontend/discourse/app/ui-kit/d-select.gjs
+++ b/frontend/discourse/app/ui-kit/d-select.gjs
@@ -3,32 +3,45 @@ import { hash } from "@ember/helper";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
import { isNone } from "@ember/utils";
-import { eq } from "discourse/truth-helpers";
+import { modifier } from "ember-modifier";
import { i18n } from "discourse-i18n";
export const NO_VALUE_OPTION = "__NONE__";
+function optionValue(value) {
+ return isNone(value) ? NO_VALUE_OPTION : String(value);
+}
+
+const claimSelectedAfterRender = modifier((element, [selected]) => {
+ if (selected) {
+ element.selected = true;
+ }
+});
+
export class DSelectOption extends Component {
get value() {
- return isNone(this.args.value) ? NO_VALUE_OPTION : this.args.value;
+ return optionValue(this.args.value);
+ }
+
+ get isSelected() {
+ return optionValue(this.args.selected) === this.value;
}
<template>
{{! https://github.com/emberjs/ember.js/issues/19115 }}
- {{#if (eq @selected @value)}}
- <option
- class="d-select__option --selected"
- value={{this.value}}
- selected
- ...attributes
- >
- {{yield}}
- </option>
- {{else}}
- <option class="d-select__option" value={{this.value}} ...attributes>
- {{yield}}
- </option>
- {{/if}}
+ <option
+ class={{if
+ this.isSelected
+ "d-select__option --selected"
+ "d-select__option"
+ }}
+ value={{this.value}}
+ selected={{this.isSelected}}
+ {{claimSelectedAfterRender this.isSelected}}
+ ...attributes
+ >
+ {{yield}}
+ </option>
</template>
}
@@ -69,7 +82,10 @@ export default class DSelect extends Component {
{{on "input" this.handleInput}}
>
{{#if this.includeNone}}
- <DSelectOption @value={{NO_VALUE_OPTION}}>
+ <DSelectOption
+ @value={{NO_VALUE_OPTION}}
+ @selected={{this.htmlSelectValue}}
+ >
{{#if @nonePlaceholder}}
{{@nonePlaceholder}}
{{else}}
diff --git a/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs b/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs
index ede04753fee..b54895c097e 100644
--- a/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs
+++ b/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs
@@ -460,9 +460,7 @@ module("Integration | Component | SettingDefinitionField", function (hooks) {
</template>
);
- assert
- .dom("[data-name='my_enum'] select option[value='5']")
- .hasAttribute("selected");
+ assert.form().field("my_enum").hasValue("5");
});
test("compact_list offers created entries again after they are removed", async function (assert) {
diff --git a/frontend/discourse/tests/integration/ui-kit/d-select-test.gjs b/frontend/discourse/tests/integration/ui-kit/d-select-test.gjs
index 8056ed6038f..e3557602e85 100644
--- a/frontend/discourse/tests/integration/ui-kit/d-select-test.gjs
+++ b/frontend/discourse/tests/integration/ui-kit/d-select-test.gjs
@@ -1,4 +1,5 @@
-import { render, select } from "@ember/test-helpers";
+import { tracked } from "@glimmer/tracking";
+import { render, select, settled } from "@ember/test-helpers";
import { module, test } from "qunit";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import DSelect, { NO_VALUE_OPTION } from "discourse/ui-kit/d-select";
@@ -54,6 +55,73 @@ module("Integration | ui-kit | DSelect", function (hooks) {
});
});
+ test("keeps the selection when options are rebuilt", async function (assert) {
+ class State {
+ @tracked
+ options = [
+ { value: "foo", label: "The real foo" },
+ { value: "bar", label: "The real bar" },
+ ];
+ }
+
+ const state = new State();
+
+ await render(
+ <template>
+ <DSelect @value="bar" as |s|>
+ {{#each state.options as |option|}}
+ <s.Option @value={{option.value}}>{{option.label}}</s.Option>
+ {{/each}}
+ </DSelect>
+ </template>
+ );
+
+ assert.dselect().hasSelectedOption({
+ value: "bar",
+ label: "The real bar",
+ });
+
+ state.options = [
+ { value: "baz", label: "The real baz" },
+ { value: "foo", label: "The real foo" },
+ { value: "bar", label: "The real bar" },
+ ];
+ await settled();
+
+ assert.dselect().hasSelectedOption({
+ value: "bar",
+ label: "The real bar",
+ });
+ });
+
+ test("keeps the selection when the value is not a string", async function (assert) {
+ class State {
+ @tracked value = 30;
+ }
+
+ const state = new State();
+ const handleChange = (value) => (state.value = value);
+
+ await render(
+ <template>
+ <DSelect
+ @includeNone={{false}}
+ @value={{state.value}}
+ @onChange={{handleChange}}
+ as |s|
+ >
+ <s.Option @value={{1}}>One</s.Option>
+ <s.Option @value={{30}}>Thirty</s.Option>
+ <s.Option @value={{90}}>Ninety</s.Option>
+ </DSelect>
+ </template>
+ );
+
+ await select(".d-select", "90");
+
+ assert.dselect().hasSelectedOption({ value: "90", label: "Ninety" });
+ });
+
test("required field", async function (assert) {
await render(
<template>