Installations

npm install @netsells/storybook-router

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.18.1

NPM Version

6.14.15 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

netsells

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

13 Commits

2 Watchers

1 Branches

1 Contributors

Updated on Apr 07, 2022

Maintainers

5

View All 1 Contributors

Package Meta Information

Latest Version

1.3.0

Package Id

@netsells/storybook-router@1.3.0

Unpacked Size

5.60 kB

Size

2.07 kB

File Count

4

NPM Version

6.14.15

Node Version

14.18.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

5

@babel/cli @babel/core @babel/preset-env vue vue-router

@netsells/storybook-router

This package provides an easy and convenient way to provide routes to your Vue-based stories.

Installation

1$ yarn add -D @netsells/storybook-router

Usage

Setup

Provide the decorator in your storybook decorators config:

1import withStorybookRouter from '@netsells/storybook-router';
2
3export default [
4    withStorybookRouter,
5];

Stories

To register a route for your stories, you can simply provide an array of routes to the router.routes parameter like so:

1export default {
2    parameters: {
3        router: {
4            routes: [
5                {
6                    name: 'account',
7                    path: '/account',
8                },
9            ],
10        },
11    },
12};

You can also provide routes to specific stories if required:

1story.parameters = {
2    router: {
3        routes: [
4            {
5                name: 'account',
6                path: '/account',
7            },
8        ],
9    },
10};

Vue router config

You can adjust config values used in the set up of VueRouter by passing a config object in your parameters.

1export default {
2    parameters: {
3        router: {
4            config: {
5                mode: 'history',
6            },
7            routes: [],
8        },
9    },
10};

Testing

When used with the @netsells/vue-storybook-test-utils package, routes will automatically be registered for your tests based on the routes provided in this parameter. This means you don't have to maintain routes for both your tests and stories, and reduces the time spent setting up said tests.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More