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/lib/client-api
History
Norbert de Langen b35951d5fc
Merge branch 'future/base' into future/deprecations-removal 
# Conflicts:
#	addons/toolbars/package.json
#	lib/core-client/package.json
#	yarn.lock
2022-06-17 09:47:46 +02:00
..
src
Merge commit '13b40e371555122513d307be94da2f0705df34ef' into future/modern-frameworks
2022-05-26 14:46:04 +02:00
package.json
Merge branch 'future/base' into future/deprecations-removal
2022-06-17 09:47:46 +02:00
README.md
Some documentation of what the four packages do now
2021-10-15 23:11:48 +11:00
tsconfig.json
wip
2022-05-25 16:50:16 +02: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.