JSPM

@storybook/addon-queryparams

5.2.0-beta.17
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 60361
  • Score
    100M100P100Q170916F
  • License MIT

parameter addon for storybook

Package Exports

  • @storybook/addon-queryparams

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@storybook/addon-queryparams) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

storybook-addon-queryparams

This storybook addon can be helpful if your components need special query parameters to work the way you want them.

Getting started

First, install the addon.

$ yarn add @storybook/addon-queryparams --dev

import the withQuery decorator so the url will be changed before rendering stories.

import React from 'react';
import { storiesOf, addDecorator } from '@storybook/react';
import { withQuery } from '@storybook/addon-queryparams';

storiesOf('button', module)
  .addDecorator(withQuery)
  .addParameters({
    query: {
      mock: true,
    }
  })
  .add('Prints the document.search', () => (
    <div>
      This is the current document.search: {document.search}, it includes `mock`!
    </div>
  ));