storybook-addon-versions

KO | EN

gitlite — search

#python #golang #android #deep-learning #docker #nodejs #java #awesome #vue #pytorch #security #ios #openai #open-source

storybook-addon-versions

(★ 15)

Storybook addon providing navigation to previous published versions

storybook-addon-versions Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# storybook-addon-versions

### Install
```
npm i @panosvoudouris/addon-versions
```

This addon allows you to navigate different versions of your components, if you have a setup that produces a different static Storybook build for each of your versions. As such, if you build a static Storybook and host it in, say, the following directory structure:
```
- static-storybook
|-- 0.0.1
|-- 0.0.2
|-- 0.1.2
|-- 0.2.5
```

the addon will allow you to navigate the various versions via the `Versions` panel:

![Versions demo](https://raw.githubusercontent.com/panosvoudouris/storybook-addon-versions/master/docs/versions-demo.gif)

## Configuration
The addon attempts to get a list of available style guide versions from the root of your host. If they are found it will show a dropdown which then lets you navigate to the various versions, as such allowing users to see how a component may have changed over different versions.

### Usage
1. Include the addon in your `addons.js`
    - `import '@panosvoudouris/addon-versions/register';`
1. Create the Versions config at `.storybook/storybook-config.json`
    - ```
      {
        "storybook": {
          "versions": {
            "availableVersions": [
              "0.0.1",
              "0.0.2",
              "0.1.2",
              "0.2.5"
            ],
            "hostname": "localhost:8000",
            "localhost": "localhost:9001",
            "regex": "\/([^\/]+?)\/?$"
          }
        }
      }
      ```

### Options
- `availableVersions`: An array of available versions.
- `hostname`: The hostname of where the static builds are. For now you need to add the path if you are expecting links to 
work in a local dev build but *not* in your normal hosted config.
- `localhost`: Where the local dev build is, when running in dev mode
- `regex`: This is for a regular expression that will extract the version number for your URL. This is dependant on the way you store the static storybook builds. The example above will work for the format `http://localhost:port/<version>/` so for example, version `0.1.2` would be expected to be found like this `http://mystorybook/0.1.2/`.

### Notes

This is a fork of https://github.com/buildit/storybook-addon-versions It appears that repo is now defunct and no longer maintained so I've forked it to continue maintenance (eg upgrade for latest storybook etc) and upgrades.

storybook-addon-versions

storybook-addon-versions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

storybook-addon-versions

storybook-addon-versions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README