1.0.9 • Published 2 years ago

@freightos/storybook-react-live v1.0.9

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

storybook-react-live

react-live decorator for Storybook v6+

npm NPM

Installation

npm i -D @freightos/storybook-react-live

Usage

import withLiveEdit from '@freightos/storybook-react-live';

const code = `() => (
  <Center>
    <Button type="primary" size="large">
      Default
    </Button>
  </Center>
)`;

stories.add(
  'Live edit',
  withLiveEdit({
    code,
    scope: { Button }
  })
)

Props of withLiveEdit()

All props accepted by \<LiveProvider /> and:

NamePropTypeDescription
themePropTypes.objectA prism-react-renderer theme object. See more here
editorStylePropTypes.objectStyles object for overriding editor styles
errorStylesPropTypes.objectStyles object for overriding error styles

Extend globally via .storybook/preview.js

Add property reactLive to parameters object. Accepts: scope and theme

export const parameters = {
  reactLive: {
    scope: { Button, Icon },
    theme: synthwave84
  },
};

:)