Skip to content

docs(react-search): Add README, description, best practices #28507

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.

Sign up for GitHub

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
emmayjiang merged 4 commits into from
Jul 13, 2023
Merged

docs(react-search): Add README, description, best practices #28507

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
174c6d2
add missing documentation
emmayjiang Jul 12, 2023
174d6cb
small styles story fixes
emmayjiang Jul 12, 2023
898b72d
Update packages/react-components/react-search-preview/stories/SearchB…
emmayjiang Jul 12, 2023
919e461
small styles story fixes
emmayjiang Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/react-components/react-search-preview/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

These are not production-ready components and **should never be used in product**. This space is useful for testing new components whose APIs might change before final release.

SearchBox allows the users to access information with ease, providing flexibility and the ability to clear and filter the input to provide the best experience.
The `SearchBox` component allows the users to access information with ease, providing flexibility and the ability to clear and filter the search.

### Usage

Expand Down
6 changes: 6 additions & 0 deletions ...act-components/react-search-preview/stories/SearchBox/SearchBoxBestPractices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@

### Do

- **Consider wrapping `SearchBox` in a role="search" container for top-level site or app search fields.** This role exposes the search field as a landmark, and makes it easier to find for screen reader users. It should not be used unless the SearchBox is the primary search area for the entire site or app.

- **Consider using `SearchBox` with underline or outline appearances.** When the contrast ratio against the immediate surrounding color is less than 3:1, consider using underline or outline styles which has a bottom border stroke. But please ensure the color of bottom border stroke has a sufficient contrast which is greater than 3 to 1 against the immediate surrounding.

### Don't

- **Don't place `SearchBox` on a surface which doesn't have a sufficient contrast.** The colors adjacent to the input should have a sufficient contrast. Particularly, the color of input with filled darker and lighter styles needs to provide greater than 3 to 1 contrast ratio against the immediate surrounding color to pass accessibility requirements.
14 changes: 14 additions & 0 deletions ...react-components/react-search-preview/stories/SearchBox/SearchBoxDescription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Don't allow prettier to collapse code block into single line -->
<!-- prettier-ignore -->
> **⚠️ Preview components are considered unstable:**
>
> ```jsx
>
> import { SearchBox } from '@fluentui/react-search-preview';
>
> ```
>
> - Features and APIs may change before final release
> - Please contact us if you intend to use this in your product

The `SearchBox` component allows the users to access information with ease, providing flexibility and the ability to clear and filter the search.