GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 15:31:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
storybook/code/lib/client-api
History
Kasper Peulen a972ff2470
Merge pull request #19833 from storybookjs/kasper/expose-more-types 
Expose more CSF types in all renderers
2022-11-16 10:17:59 +01:00
..
src
Rename Framework to Renderer
2022-11-13 20:37:10 +01:00
package.json
Expose more types in the renderer
2022-11-14 17:12:13 +01:00
README.md
stage0
2022-07-21 11:24:07 +02:00
tsconfig.json
do not ts ignore test
2022-11-14 14:18:39 +01:00

README.md

@storybook/client-api -- Deprecated Story APIs (storiesOf)

NOTE This API is deprecated, and the CSF format is preferred for all stories.

storiesOf API

The @storybook/client API provides the storiesOf() API, which is proxied through to the CSF API.

Internals

In order to appear to the store like the CSF API, a call to storiesOf().add() does the following:

  • Tracks the story added in a synthetic StoryIndex data structure
  • Constructs a moduleExports object that is equivalent to the exports from a CSF file that produced the same stories.

In order to achieve the old storySort functionality, the client API also needs access to the project annotations.