Skip to content
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

docs(addon-controls): custom matchers are no longer default #18726

Merged
merged 3 commits into from
Nov 23, 2022
Merged

docs(addon-controls): custom matchers are no longer default #18726

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
897f09f
docs(addon-controls): custom matchers are no longer default
JReinhold Jul 16, 2022
8cc06ac
Fix regex typo
JReinhold Jul 16, 2022
9cb56e9
change wording
JReinhold Nov 23, 2022
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
6 changes: 3 additions & 3 deletions docs/essentials/controls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,14 @@ This replaces the input with a radio group for a more intuitive experience.

## Custom control type matchers

For a few types, Controls will automatically infer them by using [regex](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp). You can change the matchers for a regex that suits you better.
For a few types, Controls can automatically be inferred with [regex](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp). If you've used the Storybook CLI to setup your project it should have automatically created the following defaults in `.storybook/preview.js`:

| Data type | Default regex | Description |
| :-------: | :-----------------------: | :-------------------------------------------------------: |
| **color** | `/(background\|color)$/i` | Will display a color picker UI for the args that match it |
| **color** | `/(background|color)$/i` | Will display a color picker UI for the args that match it |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a regex typo to me, but a pretty weird one so I might be wrong on that. It works without the \, but not with.

| **date** | `/Date$/` | Will display a date picker UI for the args that match it |

To do so, use the `matchers` property in the `controls` parameter:
If you haven't used the CLI to setup the configuration, or if you want to define your own patterns, use the `matchers` property in the `controls` parameter:

<!-- prettier-ignore-start -->

Expand Down