npmpackage.info

Gathering detailed insights and metrics for storybook-addon-next-router

Other packages similar to storybook-addon-next-router

@gogaille/storybook-addon-next-router

4.0.0

Use Next.js Router in your Storybook stories.

Gathering detailed insights and metrics for storybook-addon-next-router

storybook-addon-next-router - 4.0.2 | npmpackage.info

storybook-addon-next-router

Addon to use Next.js Router in Storybook

4.0.2

109

MIT

TypeScript

14.18 kB

Installations

npm install storybook-addon-next-router

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=10

Node Version

16.18.1

NPM Version

8.19.2 Pull Requests

Open

0

Total

39

Closed

14

Merged

25

Issues

Open

3

Total

33

Closed

30

Releases

v4.0.2

Updated on Dec 12, 2022

4.0.1 release

v4.0.1

Updated on Oct 09, 2022

React 18 Support

v4.0.0

Updated on May 20, 2022

v3.1.1

Updated on Dec 22, 2021

Fix: parameters override bug

v3.1.0

Updated on Dec 03, 2021

v3.0.10

Updated on Nov 30, 2021

View All 15 releases

Languages

TypeScript

JavaScript

Shell

TypeScript (95.64%)

JavaScript (2.34%)

Shell (2.01%)

Developer

lifeiscontent

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

109 Stars

92 Commits

21 Forks

3 Watchers

2 Branches

15 Contributors

Updated on Jan 07, 2025

Maintainers

View All 15 Contributors

Package Meta Information

Latest Version

4.0.2

Package Id

storybook-addon-next-router@4.0.2

Unpacked Size

14.18 kB

Size

4.81 kB

File Count

NPM Version

8.19.2

Node Version

16.18.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Storybook Addon Next Router

Use Next.js Router in your Storybook stories.

Versions

Use 1.x if you're using storybook 5.x
Use 3.x if you're using storybook 6.x
Use 4.x if you're using storybook 6.x and react 18

Note: these docs refer to 3.0

Add the addon to your configuration in .storybook/main.js

1module.exports = {
2  ...config,
3  addons: [
4    ...your addons
5    "storybook-addon-next-router",
6  ],
7};

Add the RouterContext.Provider to .storybook/preview.js

1import { RouterContext } from "next/dist/shared/lib/router-context"; // next 12
2// import { RouterContext } from "next/dist/shared/lib/router-context"; // next 11.1
3// import { RouterContext } from "next/dist/next-server/lib/router-context"; // next < 11.1
4
5export const parameters = {
6  nextRouter: {
7    Provider: RouterContext.Provider,
8  },
9}

Usage in story

1import MyComponentThatHasANextLink from "../component-that-has-a-next-link";
2
3export default {
4  title: "My Story",
5};
6
7// if you have the actions addon
8// you can click the links and see the route change events there
9export const Example = () => <MyComponentThatHasANextLink />;
10
11Example.parameters = {
12  nextRouter: {
13    path: "/profile/[id]",
14    asPath: "/profile/lifeiscontent",
15    query: {
16      id: "lifeiscontent",
17    },
18  },
19};

Custom defaults

in preview.js

1export const parameters = {
2    nextRouter: {
3        path: '/', // defaults to `/`
4        asPath: '/', // defaults to `/`
5        query: {}, // defaults to `{}`
6        push() {
7        } // defaults to using addon actions integration,
8        //   can override any method in the router
9    }
10};
11

Read more about the options available for next/router at https://nextjs.org/docs/api-reference/next/router

Example App

To see real world usage of how to use this addon, check out the example app:

https://github.com/lifeiscontent/realworld

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

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

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

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

Other packages similar to storybook-addon-next-router

Other packages similar to storybook-addon-next-router

storybook-addon-next-router

Installations

Developer Guide

Yes

CommonJS

>=10

16.18.1

8.19.2

Pull Requests

0

39

14

25

Issues

3

33

30

Releases

Languages

Developer

lifeiscontent

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Storybook Addon Next Router

Versions

Usage in story

Custom defaults

Example App

10

10

10

3

3

0

0

0

0

0

0

0

0

3

/10