Installations

npm install storybook-addon-next-router

Pull Requests

Open

0

Total

39

Closed

14

Merged

25

Issues

Open

3

Total

33

Closed

30

Releases

15

v4.0.2

Published on 12 Dec 2022

4.0.1 release

v4.0.1

Published on 09 Oct 2022

React 18 Support

v4.0.0

Published on 20 May 2022

v3.1.1

Published on 22 Dec 2021

Fix: parameters override bug

v3.1.0

Published on 03 Dec 2021

v3.0.10

Published on 30 Nov 2021

View all 15 releases

Developer

lifeiscontent

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

Yes

Node Version

16.18.1

NPM Version

8.19.2 Statistics

108 Stars

92 Commits

22 Forks

4 Watching

2 Branches

15 Contributors

Updated on 29 Sept 2024

Languages

TypeScript (95.64%)

JavaScript (2.34%)

Shell (2.01%)

Total Downloads

Cumulative downloads

Total Downloads

24,492,022

Last day

7%

10,134

Compared to previous day

Last week

12.5%

54,990

Compared to previous week

Last month

3.7%

223,585

Compared to previous month

Last year

-54.3%

4,341,843

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

tslib

Peer Dependencies

6

@storybook/addon-actions @storybook/addons @storybook/client-api next react react-dom

Dev Dependencies

17

@storybook/addon-actions @storybook/addons @storybook/client-api @types/react @types/react-dom @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-react eslint-plugin-react-hooks husky next prettier react react-dom typescript

Versions

You might not need this project

https://storybook.js.org/blog/integrate-nextjs-and-storybook-automatically/

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 { AppRouterContext } from "next/dist/shared/lib/app-router-context"; // next 13 next 13 (using next/navigation)
2// import { RouterContext } from "next/dist/shared/lib/router-context"; // next 13 (using next/router) / next 12
3// import { RouterContext } from "next/dist/shared/lib/router-context"; // next 11.1
4// import { RouterContext } from "next/dist/next-server/lib/router-context"; // next < 11.1
5
6export const parameters = {
7  nextRouter: {
8    Provider: AppRouterContext.Provider, // next 13 next 13 (using next/navigation)
9    // Provider: RouterContext.Provider, // next 13 (using next/router) / next < 12
10  },
11}

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    pathname: "/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        pathname: '/', // 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

Code-Review

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

3

Pinned-Dependencies

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

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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.

Score

3.2

/10

Last Scanned on 2024-11-18

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

Pull Requests

0

39

14

25

Issues

3

33

30

Releases

Developer

lifeiscontent

Developer Guide

CommonJS

>=10

Yes

16.18.1

8.19.2

Statistics

Languages

Total Downloads

24,492,022

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

You might not need this project

Storybook Addon Next Router

Versions

Usage in story

Custom defaults

Example App

10

10

10

3

3

2

0

0

0

0

0

0

0

3.2

/10