0.1.1 • Published 1 year ago

storybook-version v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Storybook Addon Version

The Storybook Addon Version is used to highlight the version of a component or of a package within Storybook toolbar.

Installation

npm install storybook-version --save-dev

Basic Setup

Add the following code in the main.js of your Storybook configuration:

module.exports = {
  addons: ['storybook-version'],
};

Set the parameters of your story with the key value version in order to provide the necessary information to be displayed.

Configuration

PropertyRequiredType of ValueDescriptionExample
majorstringMajor version'1'
minorstringMinor version'2'
patchstringPatch version'3'
postfixstringPostifx version extra data'beta.1'
styleobject of keys string and values stringExtra css properties to overwrite default style of the Version'{ 'color' : 'red', 'border-width': '2px' }'

Implementation

export const parameters = {
  version: {
    major: '1',
    minor: '2',
    patch: '3'
  }
}

Story Setup Example

Add the version parameter in the default Story configuration:

import React from 'react'

export default {
  title: 'Component Button',
  parameters: {
    version: {
      major: '4',
      minor: '2',
      patch: '0',
      postfix: 'rc3',
      style: {
        color: 'red',
        'font-weight': '900',
        'font-size': '24px'
      }
    }
  }
}