Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeplin/storybook-zeplin
Storybook addon to view Zeplin resources in story panel
https://github.com/zeplin/storybook-zeplin
storybook storybook-addon zeplin
Last synced: 2 days ago
JSON representation
Storybook addon to view Zeplin resources in story panel
- Host: GitHub
- URL: https://github.com/zeplin/storybook-zeplin
- Owner: zeplin
- License: mit
- Created: 2020-05-03T16:08:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T08:41:41.000Z (6 months ago)
- Last Synced: 2025-01-13T06:06:11.028Z (9 days ago)
- Topics: storybook, storybook-addon, zeplin
- Language: TypeScript
- Homepage: https://storybook-zeplin.netlify.app
- Size: 1.46 MB
- Stars: 116
- Watchers: 16
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/storybook-zeplin)
[](https://www.npmjs.com/package/storybook-zeplin)
[](https://github.com/mertkahyaoglu/storybook-zeplin/blob/master/LICENSE)
[](https://app.netlify.com/sites/storybook-zeplin/deploys)
[](https://opencollective.com/storybook-zeplin)
## Storybook Zeplin addon
[Storybook](https://github.com/storybooks/storybook) addon that embeds Zeplin resources such as screens and components in the addon panel for better design-development workflow.
## Links
- [Demo](https://storybook-zeplin.netlify.app)
- [Blog Post](https://blog.zeplin.io/storybook-and-zeplin-a-new-integration-228951e336e9)
- [Highlight Components](https://blog.zeplin.io/announcing-improved-storybook-integration-highlight-components)
## Requirements
Storybook Zeplin addon v3 is compatible with Storybook 8 and Node Version >18.
For Storybook versions 5-7, please use Storybook Zeplin addon v2.0.3
## Getting started
### 1. Install
For using Storybook 8:
```sh
npm install --save-dev storybook-zeplin
# yarn add -D storybook-zeplin
```
For using Storybook version 5-7:
```sh
npm install --save-dev [email protected]
# yarn add -D [email protected]
```
### 2. Register the addon in `main.js`
```js
// .storybook/main.js
module.exports = {
addons: ["storybook-zeplin/register"],
};
```
If you're using [email protected]:
```js
// .storybook/addons.js
import "storybook-zeplin/register";
```
### 3. Linking components
There are two ways to do this, you can link your entire Zeplin project or styleguide to your global story parameters (recommended) or link individual components one by one.
#### Option A: Linking entire project or styleguide (Recommended)
Add `zeplinLink` to `.storybook/preview.js` file. This value is a link to the project or styleguide that contains correspondent designs in Zeplin as shown below examples.
When this parameter is provided, you will automatically view Zeplin components linked to your stories on the addon panel using the Storybook integration.
Using a Zeplin web link
```js
//.storybook/preview.js
export const parameters = {
zeplinLink: "https://app.zeplin.io/project/5e7a6d478204d59183a1c76b",
};
```
Using a Zeplin app link
```js
//.storybook/preview.js
export const parameters = {
zeplinLink: "zpl://project?pid=61f164b064e363a52fbb295f",
};
```
When the addon setup is done, go and check out below articles to learn more about how to initialize Storybook integration on Zeplin.
- [Connecting your Storybook instance with Zeplin](https://support.zeplin.io/en/articles/5674596-connecting-your-storybook-instance-with-zeplin)
- [Linking your components in Zeplin with stories in Storybook](https://support.zeplin.io/en/articles/5679812-linking-your-components-in-zeplin-with-stories-in-storybook).
#### Option B: Linking individual stories manually
Storybook Zeplin takes parameter `zeplinLink` as an array of elements containing a name and a link or just a string for the link.
For the link, you can use full web URL or app URI of Zeplin components/screens.
Example of adding Zeplin link to all stories in a file:
```jsx
export default {
title: "Button",
component: Button,
parameters: {
zeplinLink: "https://app.zeplin.io/project/5e7a6d478204d59183a1c76b/styleguide/components?coid=5eac833c5f1f2f1cb19f4f19",
},
};
export const Default = () => Click me;
export const Secondary = () => Click me;
Default.story = {
name: "Primary Button",
};
Secondary.story = {
name: "Secondary Button",
};
```
Example of adding multiple Zeplin links to a story:
```jsx
export default {
title: "Button",
component: Button,
};
export const Default = () => Click me;
export const Secondary = () => Click me;
Default.story = {
name: "Responsive Button",
parameters: {
zeplinLink: [
{
name: "Desktop",
link: "zpl://components?pid=pid1&coid=coid1",
},
{
name: "Tablet",
link: "zpl://components?pid=pid1&coid=coid2",
},
{
name: "Mobile",
link: "zpl://components?pid=pid1&coid=coid3",
},
],
},
};
```
### 4. Set Zeplin access token
To access your Zeplin resources, you need to provide an access token with your Zeplin account permissions.
You can create one from [Developer](https://app.zeplin.io/profile/developer) tab in your profile page.
The addon prompts to set the token when you open the addon's tab. This token is kept in the browser storage, so each user needs to create and set their own token to access Zeplin resources via Storybook.
#### (Optional) Setting the access token using environment variable
If you want to skip creating tokens for each user,
you can provide the access token as an environment variable called `STORYBOOK_ZEPLIN_TOKEN`.
You can create `.env` file in your project's root folder, or you can provide the environment variable as a command line parameter when building or dynamically running Storybook.
#### ⚠️ Disclaimer
**Please note that access token can be viewed by anyone with access to the Storybook instance if you set it using environment variable.
For security reasons, never use the environment variable, if the Storybook instance can be accessed by 3rd parties.**
```shell
# .env
STORYBOOK_ZEPLIN_TOKEN="eyJhbGciOiJIUzI1N.."
```
## Development
Run following commands in separate tabs to start development
```shell
npm run watch
npm run storybook
```
## Notes
- This addon extracts the Storybook data and sends to parent frame to make stories reachable from Zeplin apps. For more information: [Zeplin Storybook integration](https://zpl.io/article/storybook-integration)
## License
MIT © [Mert Kahyaoğlu](https://mert-kahyaoglu.com)