@aantonio/yoda
v0.1.11
Published
Design System based on Storybook
Downloads
36
Readme
YODA
It's a foundation Design System based on the Storybook tutorial is a subset of the full Storybook design system, created as a learning resource for those interested in learning how to write and publish a design system using best in practice techniques.
Learn more in Storybook tutorials.
📝 How it work
As a Design System foundation, we can import this package in another Design System that can inherit from foundation.
Or import directly in the product.
Installation.
# Install package npm install --save @aantonio/yoda
Integration in another Storybook.
In
.storybook/main.js
module.exports = { stories: ["../src/**/*.stories.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"], refs: { "design-system": { title: "YODA", //👇 The url provided by Chromatic when it was deployed url: "https://master--61dec7167fec2d003aa60e29.chromatic.com", }, }, addons: [ "@storybook/addon-links", "@storybook/addon-essentials", "@storybook/preset-create-react-app", ], framework: "@storybook/react", staticDirs: ["../public"], core: { builder: "webpack5", }, };
In
.storybook/preview.js
import React from 'react'; // The styles imported from the design system. import { global as designSystemGlobal } from '@your-npm-username/learnstorybook-design-system'; const { GlobalStyle } = designSystemGlobal; /* * Adds a global decorator to include the imported styles from the design system. * More on Storybook decorators at: * https://storybook.js.org/docs/react/writing-stories/decorators#global-decorators */ export const decorators = [ Story => ( <> <GlobalStyle /> <Story /> </> ), ]; /* * More on Storybook parameters at: * https://storybook.js.org/docs/react/writing-stories/parameters#global-parameters */ export const parameters = { actions: { argTypesRegex: '^on[A-Z].*' }, };
Importation.
import { Avatar } from '@aantonio/yoda';