@storybook/router
Advanced tools
@storybook/router is a package used within the Storybook ecosystem to handle routing. It provides utilities to manage navigation and URL state within Storybook, making it easier to create and manage complex story hierarchies and navigation patterns.
Route Handling
The Route component allows you to define a route and associate it with a specific component. This is useful for rendering different components based on the URL path.
import { Route } from '@storybook/router';
<Route path="/my-component" component={MyComponent} />;Link Component
The Link component is used to create navigational links within Storybook. It helps in navigating to different routes defined in the Storybook environment.
import { Link } from '@storybook/router';
<Link to="/my-component">Go to My Component</Link>;Location Context
The Location component provides access to the current location object, which includes information like the current pathname. This is useful for conditionally rendering content based on the current route.
import { Location } from '@storybook/router';
<Location>{({ pathname }) => <div>Current path: {pathname}</div>}</Location>;React Router is a popular library for handling routing in React applications. It provides a comprehensive set of tools for managing navigation, URL parameters, and nested routes. Compared to @storybook/router, React Router is more feature-rich and is designed for general use in React applications, not just within Storybook.
Reach Router is a smaller, simpler alternative to React Router. It focuses on accessibility and simplicity, making it a good choice for projects that don't need the full feature set of React Router. Like React Router, it is designed for general use in React applications, whereas @storybook/router is specifically tailored for Storybook.
Storybook Router is a wrapper library for react-router. It ensures a single version of the router is used everywhere. It also includes some ready to use utils to read the path, query, viewMode and storyId from location.
7.0.0-alpha.40 (October 20, 2022)
FAQs
Core Storybook Router
The npm package @storybook/router receives a total of 3,635,066 weekly downloads. As such, @storybook/router popularity was classified as popular.
We found that @storybook/router demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.