@storybook/addon-links5.0.11 • Public • Published
Story Links Addon
The Storybook Links addon can be used to create links that navigate between stories in Storybook.
Install this addon by adding the
yarn add @storybook/addon-links
First configure it as an addon by adding it to your addons.js file (located in the Storybook config directory).
Then you can import
linkTo in your stories and use like this:
Have a look at the linkTo function:
// Links to the first story in the 'Toggle' kind
With that, you can link an event in a component to any story in the Storybook.
- First parameter is the story kind name (what you named with
- Second (optional) parameter is the story name (what you named with
.add). If the second parameter is omitted, the link will point to the first story in the given kind.
You can also pass a function instead for any of above parameter. That function accepts arguments emitted by the event and it should return a string:
If you want to get an URL for a particular story, you may use
hrefTo function. It returns a promise, which resolves to string containing a relative URL:
withLinks decorator enables a declarative way of defining story links, using data attributes.
Here is an example in React, but it works with any framework:
LinkTo component (React only)
One possible way of using
hrefTo is to create a component that uses native
a element, but prevents page reloads on plain left click, so that one can still use default browser methods to open link in new tab.
A React implementation of such a component can be imported from
It accepts all the props the
a element does, plus
kind. It the
kind prop is omitted, the current kind will be preserved.
<LinkTokind="Toggle"story="off"target="_blank"title="link to second story"style=color: '#1474f3'>Go to Second</LinkTo>
To implement such a component for another framework, you need to add special handling for
click event on native
a element. See
RoutedLink sources for reference.