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

Apply suggestions from code review

Browse Source
This commit is contained in:
Tom Coleman 2021-09-10 18:36:52 +10:00
parent 5c833834b2
commit 9473f4db90
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/preview-web/src/PreviewWeb.mockdata.ts
View File

@ -1,6 +1,6 @@
import { EventEmitter } from 'events';
import Events from '@storybook/core-events';
import { StoriesList } from '@storybook/store';
import { StoryIndex } from '@storybook/store';
export const componentOneExports = {
default: {
@ -33,7 +33,7 @@ export const projectAnnotations = {
};
export const getProjectAnnotations = () => projectAnnotations;
export const storyIndex: StoriesList = {
export const storyIndex: StoryIndex = {
v: 3,
stories: {
'component-one--a': {

2
lib/preview-web/src/UrlStore.test.ts
View File

@ -75,7 +75,7 @@ describe('UrlStore', () => {
viewMode: 'story',
});
});
it('should redirect legacy queries', () => {
it('should parse legacy queries', () => {
document.location.search = '?selectedKind=kind&selectedStory=story';
expect(getSelectionSpecifierFromPath()).toEqual({
storySpecifier: { title: 'kind', name: 'story' },

10
lib/store/README.md
View File

@ -22,8 +22,8 @@ The first set of fields on a `Story` are the identifying fields for a story:
The main fields on a `Story` are the various annotations. Annotations can be set:
- At the project level in `preview.js` (or via addons)
- At the component level via `export default = { ... }` in a CSF file
- At the story level via `export Story = {...}` in a CSF file.
- At the component level via `export default { ... }` in a CSF file
- At the story level via `export const Story = {...}` in a CSF file.
Not all annotations can be set at every level but most can.
@ -97,7 +97,7 @@ Arg types add type information and metadata about args that are used to control
### ArgTypes enhancement
To add a argTypes enhancer, `export addArgTypesEnhancers = []` from `preview.js` or and addon
To add a argTypes enhancer, `export const argTypesEnhancers = []` from `preview.js` or and addon
There is a default enhancer that ensures that each `arg` in a story has a baseline `argType`. This value can be improved by subsequent enhancers, e.g. those provided by `@storybook/addon-docs`.
@ -105,11 +105,11 @@ There is a default enhancer that ensures that each `arg` in a story has a baseli
Globals are rendering information that is global across stories. They are used for things like themes and internationalization (i18n) in stories, where you want Storybook to "remember" your setting as you browse between stories.
They can be access in stories and decorators in the `context.globals` key.
They can be accessed in stories and decorators in the `context.globals` key.
### Initial values of globals
To set initial values of globals, `export globals = {...}` from `preview.js`
To set initial values of globals, `export const globals = {...}` from `preview.js`
### Using globals in an addon

6
lib/store/src/StoryStore.ts
View File

@ -34,8 +34,8 @@ import { inferControls } from './inferControls';
type MaybePromise<T> = Promise<T> | T;
// TODO -- what are reasonable values for these?
const CSF_CACHE_SIZE = 100;
const STORY_CACHE_SIZE = 1000;
const CSF_CACHE_SIZE = 1000;
const STORY_CACHE_SIZE = 10000;
function normalizeProjectAnnotations<TFramework extends AnyFramework>({
argTypes,
@ -166,7 +166,7 @@ export class StoryStore<TFramework extends AnyFramework> {
if (sync) {
throw new Error(
`importFn() returned a promise, did you pass an async version then call initializeSync()?`
`importFn() returned a promise, did you pass an async version then call initialize({sync: true})?`
);
}