-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs: Add initial Autocomplete docs #7581
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,121 @@ | ||
{/* Copyright 2025 Adobe. All rights reserved. | ||
This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. You may obtain a copy | ||
of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software distributed under | ||
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
OF ANY KIND, either express or implied. See the License for the specific language | ||
governing permissions and limitations under the License. */} | ||
|
||
import {Layout} from '@react-spectrum/docs'; | ||
export default Layout; | ||
|
||
import docs from 'docs:react-aria-components'; | ||
import {PropTable, HeaderInfo, TypeLink, PageDescription, StateTable, ContextTable} from '@react-spectrum/docs'; | ||
import styles from '@react-spectrum/docs/src/docs.css'; | ||
import packageData from 'react-aria-components/package.json'; | ||
import ChevronRight from '@spectrum-icons/workflow/ChevronRight'; | ||
import {InlineAlert, Content, Heading} from '@adobe/react-spectrum'; | ||
|
||
--- | ||
category: Pickers | ||
keywords: [autocomplete, search, menu, command palette, aria] | ||
type: component | ||
preRelease: alpha | ||
--- | ||
|
||
# Autocomplete | ||
|
||
<PageDescription>{docs.exports.UNSTABLE_Autocomplete.description}</PageDescription> | ||
|
||
<HeaderInfo | ||
packageData={packageData} | ||
componentNames={['UNSTABLE_Autocomplete']} | ||
sourceData={[ | ||
{type: 'W3C', url: 'https://w3c.github.io/aria/#aria-autocomplete'} | ||
]} /> | ||
|
||
<InlineAlert variant="notice" marginTop={60}> | ||
<Heading>Under construction</Heading> | ||
<Content>This component is in <strong>alpha</strong>. More documentation is coming soon!</Content> | ||
</InlineAlert> | ||
|
||
## Example | ||
|
||
```tsx example | ||
import {UNSTABLE_Autocomplete, Menu, MenuItem, useFilter} from 'react-aria-components'; | ||
import {MySearchField} from './SearchField'; | ||
|
||
function Example() { | ||
let {contains} = useFilter({sensitivity: 'base'}); | ||
return ( | ||
<div className="autocomplete"> | ||
<UNSTABLE_Autocomplete filter={contains}> | ||
<MySearchField placeholder="Search commands..." /> | ||
<Menu> | ||
<MenuItem>Create new file...</MenuItem> | ||
<MenuItem>Create new folder...</MenuItem> | ||
<MenuItem>Assign to...</MenuItem> | ||
<MenuItem>Assign to me</MenuItem> | ||
<MenuItem>Change status...</MenuItem> | ||
<MenuItem>Change priority...</MenuItem> | ||
<MenuItem>Add label...</MenuItem> | ||
<MenuItem>Remove label...</MenuItem> | ||
</Menu> | ||
</UNSTABLE_Autocomplete> | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
<details> | ||
<summary style={{fontWeight: 'bold'}}><ChevronRight size="S" /> Show CSS</summary> | ||
```css hidden | ||
@import './Menu.mdx' layer(listbox); | ||
@import './Button.mdx' layer(button); | ||
@import './SearchField.mdx' layer(searchfield); | ||
``` | ||
|
||
```css | ||
@import "@react-aria/example-theme"; | ||
|
||
.autocomplete { | ||
display: flex; | ||
flex-direction: column; | ||
gap: 12px; | ||
max-width: 300px; | ||
height: 180px; | ||
border: 1px solid var(--border-color); | ||
padding: 16px; | ||
border-radius: 10px; | ||
background: var(--overlay-background); | ||
|
||
.react-aria-SearchField { | ||
width: 100%; | ||
} | ||
|
||
.react-aria-Menu { | ||
flex: 1; | ||
overflow: auto; | ||
} | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
## Anatomy | ||
|
||
`Autocomplete` is a controller for a child text input, such as a [TextField](TextField.html) or [SearchField](SearchField), and a collection component such as a [Menu](Menu.html) or [ListBox](ListBox.html). It enables the user to filter a list of items, and navigate via the arrow keys while keeping focus on the input. | ||
|
||
```tsx | ||
import {UNSTABLE_Autocomplete, SearchField, Menu} from 'react-aria-components'; | ||
|
||
<UNSTABLE_Autocomplete> | ||
<SearchField /> | ||
<Menu /> | ||
</UNSTABLE_Autocomplete> | ||
``` | ||
|
||
## Props | ||
|
||
<PropTable component={docs.exports.UNSTABLE_Autocomplete} links={docs.links} /> |
This file contains hidden or 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 hidden or 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.