use Floating UI for Select and Combobox #6452
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "prerelease", | ||
| "comment": "use floating-ui for select and combobox", | ||
| "packageName": "@microsoft/fast-foundation", | ||
| "email": "[email protected]", | ||
| "dependentChangeType": "prerelease" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,15 @@ | ||
| import { autoUpdate, computePosition, flip, hide, size } from "@floating-ui/dom"; | ||
| import { | ||
| attr, | ||
| Observable, | ||
| observable, | ||
| SyntheticViewTemplate, | ||
| Updates, | ||
| } from "@microsoft/fast-element"; | ||
| import { limit, uniqueId } from "@microsoft/fast-web-utilities"; | ||
| import type { FASTListboxOption } from "../listbox-option/listbox-option.js"; | ||
| import { DelegatesARIAListbox } from "../listbox/listbox.js"; | ||
| import { StartEnd, StartEndOptions } from "../patterns/index.js"; | ||
| import { applyMixins } from "../utilities/apply-mixins.js"; | ||
| import { FormAssociatedCombobox } from "./combobox.form-associated.js"; | ||
| import { ComboboxAutocomplete } from "./combobox.options.js"; | ||
|
|
@@ -80,13 +85,6 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| */ | ||
| private filter: string = ""; | ||
|
|
||
| /** | ||
| * Reset the element to its first selectable option when its parent form is reset. | ||
| * | ||
|
|
@@ -130,14 +128,6 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| */ | ||
| public listboxId: string = uniqueId("listbox-"); | ||
|
|
||
| /** | ||
| * The open attribute. | ||
| * | ||
|
|
@@ -161,7 +151,7 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| this.ariaControls = this.listboxId; | ||
| this.ariaExpanded = "true"; | ||
|
|
||
| Updates.enqueue(() => this.setPositioning()); | ||
| this.focusAndScrollOptionIntoView(); | ||
|
|
||
| // focus is directed to the element when `open` is changed programmatically | ||
|
|
@@ -211,29 +201,6 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * The value property. | ||
| * | ||
|
|
@@ -270,6 +237,13 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Cleanup function for the listbox positioner. | ||
| * | ||
| * @public | ||
| */ | ||
| public cleanup: () => void; | ||
|
|
||
| /** | ||
| * Handle opening and closing the listbox when the combobox is clicked. | ||
| * | ||
|
|
@@ -307,7 +281,6 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
|
|
||
| public connectedCallback() { | ||
| super.connectedCallback(); | ||
| if (this.value) { | ||
| this.initialValue = this.value; | ||
| } | ||
|
|
@@ -328,6 +301,11 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| this.ariaDisabled = this.disabled ? "true" : "false"; | ||
| } | ||
|
|
||
| public disconnectedCallback(): void { | ||
| this.cleanup?.(); | ||
| super.disconnectedCallback(); | ||
| } | ||
|
|
||
| /** | ||
| * Filter available options by text value. | ||
| * | ||
|
|
@@ -608,26 +586,46 @@ export class FASTCombobox extends FormAssociatedCombobox { | |
| /** | ||
| * Calculate and apply listbox positioning based on available viewport space. | ||
| * | ||
| * @public | ||
| */ | ||
| public setPositioning(): void { | ||
| if (this.$fastController.isConnected) { | ||
| this.cleanup = autoUpdate(this, this.listbox, async () => { | ||
| const { middlewareData, x, y } = await computePosition( | ||
| this, | ||
| this.listbox, | ||
| { | ||
| placement: "bottom", | ||
| strategy: "fixed", | ||
| middleware: [ | ||
| flip(), | ||
|
There was a problem hiding this comment. Am I correct in assuming that though is is positioned to the bottom, if there's not enough space, this will "flip" it to the top? There was a problem hiding this comment. Yep, that's what this middleware does: https://floating-ui.com/docs/flip |
||
| size({ | ||
| apply: ({ availableHeight, rects }) => { | ||
| Object.assign(this.listbox.style, { | ||
| maxHeight: `${availableHeight}px`, | ||
| width: `${rects.reference.width}px`, | ||
| }); | ||
| }, | ||
| }), | ||
| hide(), | ||
| ], | ||
| } | ||
| ); | ||
|
|
||
| if (middlewareData.hide?.referenceHidden) { | ||
| this.open = false; | ||
| this.cleanup(); | ||
| return; | ||
| } | ||
|
|
||
| Object.assign(this.listbox.style, { | ||
| position: "fixed", | ||
| top: "0", | ||
| left: "0", | ||
| transform: `translate(${x}px, ${y}px)`, | ||
| }); | ||
| }); | ||
|
Comment on lines
+593
to
+627
There was a problem hiding this comment. I'd love to see us look into abstracting this into a utility which could be shared rather than repeated once we have a good baseline for implementation. |
||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice use of the operator here!