@storybook/router
Advanced tools
Package description
@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.
Changelog
8.2.0
Hold onto your hats! Storybook 8.2 has dropped, packed with a treasure trove of new features and bug fixes:
beforeAllplay functiontocbot - #28318, thanks @shilman!--no-dev option to init - #26918, thanks @fastfrwrd!--dev and --no-dev options to storybook init CLI - #26918, thanks @fastfrwrd!@storybook/addon-svelte-csf when initializing new projects - #27070, thanks @benmccann!beforeAll hook - #28255, thanks @ghengeveld!pkg-dir to fd-package-json - #28270, thanks @43081j!loading -> rendering -> playing - #28431, thanks @kasperpeulen!.stories.mdx handling - #25973, thanks @JReinhold!CJS for core/components - #28440, thanks @ndelangen!preview.js globals to initialGlobals - #27517, thanks @shilman!markdown-to-jsx to v7.4.5 - #26694, thanks @xyy94813!webpack-virtual-modules to 0.6.0 - #27102, thanks @fyodorovandrei!read-pkg-up to fd-package-json - #28272, thanks @43081j!doctrine with jsdoc-type-pratt-parser - #26305, thanks @43081j!Stories block, error when referenced in MDX - #28434, thanks @kasperpeulen!Typeset Doc block fontSizes type - #26475, thanks @noranda!env.bugfixes in SWC so destructuring is never transpiled - #28363, thanks @kasperpeulen!mount in react, svelte, and vue renderers - #28385, thanks @kasperpeulen!CompatibleString - #27180, thanks @sni-J!FAQs
Core Storybook Router
The npm package @storybook/router receives a total of 6,694,075 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
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.