Giter Club home page Giter Club logo

storybook-addon-dependencies's Introduction

Storybook Addon Dependencies

This addon adds interactive dependencies trees to the autodocs page.

Demo

Dependents Dependencies

Getting started

This addon supports v7 and v8. To use it with storybook 7 install npm i -D [email protected]

  1. Install
npm i -D storybook-addon-dependencies
yarn add -D storybook-addon-dependencies
  1. Register the addon in main.js
export default {
  addons: ["storybook-addon-dependencies"],
};
  1. Build the dependency tree

  2. Run storybook

Development scripts

To build the dependency tree of storied components run:

npx storybook-addon-dependencies

Blocks

This addon overrides the default docs page, if there is a custom docs page use this custom doc blocks in your template.

import { Dependencies, Dependents } from "storybook-addon-dependencies/blocks";

Hooks

To create your own tree design with custom doc blocks, get the current story title with the hook and the titles tree with the api.

import { useCurrentStoryTitle } from "storybook-addon-dependencies/hooks";

API

import { getTree, getDependenciesTree, getDependentsTree } from "storybook-addon-dependencies/api";

Warnings

  • Don't write storied components in the same file. This may cause conflicts with the tree builder.

storybook-addon-dependencies's People

Contributors

aandrader avatar

Watchers

 avatar  avatar

storybook-addon-dependencies's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.