docs(react-switch): cleanup stories & docs#23217
Conversation
| export type SwitchProps = Omit< | ||
| ComponentProps<Partial<SwitchSlots>, 'input'>, | ||
| 'checked' | 'defaultChecked' | 'onChange' | ||
| > & { |
There was a problem hiding this comment.
As we have own definition we need to exclude existing ones for checked & defaultChecked. It also solves problem with the description for props.
Before
After
| - Only replace the On/Off labels if there are more specific labels for the setting. For example, you might use Show/Hide if the setting is "Show images". | ||
| - Keep descriptive text short and concise—two to four words; preferably nouns. For example, "Focused inbox" or "WiFi". | ||
|
|
||
| </details> |
There was a problem hiding this comment.
Added best practices & component description, took it from existing docs (https://developer.microsoft.com/en-us/fluentui#/controls/web/toggle). We will probably need to follow up on it to cleanup, but it's better than we have currently:
| export { Label } from './SwitchLabel.stories'; | ||
| export { LabelWrapping } from './SwitchLabelWrapping.stories'; | ||
| export { Required } from './SwitchRequired.stories'; | ||
| export { Themed } from './SwitchThemed.stories'; |
There was a problem hiding this comment.
This story is redundant and does not match patterns that we have for other components. I removed it to avoid confusion. To check how a component looks in different themes customers can use the theme selector and exists on every page:
📊 Bundle size reportUnchanged fixtures
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit c4a8e67:
|
Perf Analysis (
|
| Scenario | Render type | Master Ticks | PR Ticks | Iterations | Status |
|---|---|---|---|---|---|
| Avatar | mount | 932 | 931 | 5000 | |
| Button | mount | 573 | 569 | 5000 | |
| FluentProvider | mount | 1944 | 1963 | 5000 | |
| FluentProviderWithTheme | mount | 269 | 256 | 10 | |
| FluentProviderWithTheme | virtual-rerender | 249 | 213 | 10 | |
| FluentProviderWithTheme | virtual-rerender-with-unmount | 280 | 284 | 10 | |
| MakeStyles | mount | 1719 | 1691 | 50000 |
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: 303947a3e3687058c902a9a8bee1ecd1f19a92c8 (build) |
* docs(react-switch): cleanup stories & docs * add changelog * update API file
4 participants
See comments on files 👇