GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 16:51:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update args.md

Browse Source
This commit is contained in:
Gert Hengeveld 2021-02-26 13:19:13 +01:00 committed by GitHub
parent 90dc07219f
commit 8395e545d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/writing-stories/args.md
View File

@ -110,12 +110,13 @@ Initial args for the currently active story can be overruled by setting the `arg
In order to protect against [XSS](https://owasp.org/www-community/attacks/xss/) attacks, keys and values of args specified through the URL are limited to alphanumeric characters, spaces, underscores and dashes. Any args that don't abide these restrictions will be ignored and stripped, but can still be used through code and manipulated through the Controls addon.
The `args` param is always a set of `key:value` pairs delimited with a semicolon `;`. Note that values will always be interpreted as strings. Objects and arrays are supported. For example, `args=obj.key:val;arr[]:one;arr[]:two` will be interpreted as:
The `args` param is always a set of `key:value` pairs delimited with a semicolon `;`. Values will be coerced (cast) to their respective `argTypes` (which may have been automatically inferred). Objects and arrays are supported. Special values `null` and `undefined` can be set by prefixing with a bang `!`. For example, `args=obj.key:val;arr[0]:one;arr[1]:two;nil:!null` will be interpreted as:
```
{
obj: { key: 'val' },
arr: ['one', 'two']
arr: ['one', 'two'],
nil: null
}
```