Skip to content

Commit 0b80723

Browse files
KristinLBradleyshleewhitemajedelass
authored
SuperSelect - docs for search position (HDS-4254) (#2620)
Co-authored-by: Lee White <lee.white@hashicorp.com> Co-authored-by: Majed Elass <majed.elass@hashicorp.com>
1 parent 5490daa commit 0b80723

File tree

3 files changed

+13
-21
lines changed

3 files changed

+13
-21
lines changed

website/docs/components/form/super-select/partials/code/component-api.md

+6-15
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@ While the [ember-power-select documentation](https://ember-power-select.com/docs
1313

1414
!!! Info
1515

16-
The default values of some [ember-power-select](https://ember-power-select.com/docs/api-reference) options have been overridden in some cases to either resolve accessibility issues or to customize according to our needs. These options are documented below.
16+
The default values of some [ember-power-select](https://ember-power-select.com/docs/api-reference) options have been overridden to either resolve accessibility issues or to customize according to our needs.
17+
18+
Overrides to fix accessibility issues:
19+
20+
- `renderInPlace`: Always set as `true`. The opener element or “trigger” must be next to dropdown content it hides & reveals.
21+
- `searchFieldPosition`: Always set to `"before-options"`. Rendering the search input within the trigger is not compliant because it nests interactive elements within each other.
1722

1823
!!!
1924

@@ -72,13 +77,6 @@ The default values of some [ember-power-select](https://ember-power-select.com/d
7277
<br><br>
7378
If a value for `dropdownMaxWidth` is set, `matchTriggerWidth` is automatically set to false.
7479
</C.Property>
75-
<C.Property @name="renderInPlace" @type="boolean">
76-
Determines whether the dropdown options are rendered in place within the DOM vs. being attached to the root of the HTML `<body>` and positioned with JavaScript.
77-
<br><br>
78-
Set as `true` in `SuperSelect` components to fix a `PowerSelect` accessibility issue. (The opener element or “trigger” should be next to dropdown content it hides & reveals.)
79-
<br><br>
80-
<strong>Note</strong>: It cannot be overridden.
81-
</C.Property>
8280
<C.Property @name="searchPlaceholder" @type="string" @default="Search">
8381
Displays placeholder text in the search input when `@searchEnabled` is set to `true`.
8482
</C.Property>
@@ -204,13 +202,6 @@ The default values of some [ember-power-select](https://ember-power-select.com/d
204202
<br><br>
205203
If a value for `dropdownMaxWidth` is set, `matchTriggerWidth` is automatically set to false.
206204
</C.Property>
207-
<C.Property @name="renderInPlace" @type="boolean">
208-
Determines whether the dropdown options are rendered in place within the DOM vs. being attached to the root of the HTML `<body>` and positioned with JavaScript.
209-
<br><br>
210-
Set as `true` in `SuperSelect` components to fix a `PowerSelect` accessibility issue. (The opener element or “trigger” should be next to dropdown content it hides & reveals.)
211-
<br><br>
212-
Note: It cannot be overridden.
213-
</C.Property>
214205
<C.Property @name="searchPlaceholder" @type="string" @default="Search">
215206
Displays placeholder text in the search input when `@searchEnabled` is set to `true`.
216207
<br><br>

website/docs/components/form/super-select/partials/guidelines/guidelines.md

-6
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,6 @@ The before and after options are areas above and below the list, independent fro
5353

5454
BeforeOptions allows for either a search field or generic content to be displayed before the options list.
5555

56-
!!! Warning
57-
58-
Currently, the Multiple component includes search within an area of the trigger instead of displaying it in the beforeOptions. This causes a nested interaction which is an accessibility violation. We are in the process of working with the Ember Power Select maintainers to resolve this issue and make it the same as in the Single component.
59-
60-
!!!
61-
6256
#### Search
6357

6458
If enabled, search allows the user to filter results based on a query.

website/docs/components/form/super-select/partials/version-history/version-history.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## 4.16.0
2+
3+
### Updated
4+
5+
- Updated `ember-power-select` from `8.2.0` to `8.6.0`
6+
- Added `searchFieldPosition="before-options"` to fix a11y issue in `Multiple` component
7+
18
## 4.15.0
29

310
Aligned private class properties to follow a standardized notation

0 commit comments

Comments
 (0)