Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
storybook-docs-toc
Advanced tools
Readme
Table of contents addon for Storybook Docs.
Get auto generated list of links next to your content.
It uses tocbot under the hood.
npm i -D storybook-docs-toc
Be aware that styled-components
is a peer dependency.
Add this to your preview.js file
- import { DocsContainer } from '@storybook/addon-docs';
+ import { withTableOfContents } from 'storybook-docs-toc';
- addParameters({
- docs: {
- container: DocsContainer,
- },
-});
+ addParameters(withTableOfContents());
or if you need more flexibility
+ import React from 'react';
- import { DocsContainer } from '@storybook/addon-docs';
+ import { BackToTop, TableOfContents } from 'storybook-docs-toc';
export const parameters = {
docs: {
- container: DocsContainer,
+ container: ({ children, ...rest }) => (
+ <React.Fragment>
+ <DocsContainer {...rest}>
+ <TableOfContents className="sbdocs sbdocs-toc--custom" />
+ {children}
+ <BackToTop className="sbdocs sbdocs-top--custom" />
+ </DocsContainer>
+ </React.Fragment>
+ ),
},
};
You can override the default selectors for tocbot via the config
prop on DocsContainerHOC
or TableOfContents
. These also take a custom title
.
Some CSS custom properties are available to customize the styles of the table of contents, and the back to top button.
.sbdocs.sbdocs-toc--custom {
--toc-color: #202020;
--toc-background: #fff;
--toc-indicator-color: #efefef;
--toc-indicator-color--active: #fbd476;
}
.sbdocs.sbdocs-top--custom {
--toc-button-color: #66bf3cff;
--toc-button-color--hover: #66bf3ccc;
--toc-button-color--active: #66bf3caa;
--toc-button-background: #e7fdd8ff;
--toc-button-background--hover: #e7fdd8cc;
--toc-button-background--active: #e7fdd8aa;
}
FAQs
Table of contents addon for Storybook Docs
The npm package storybook-docs-toc receives a total of 5,950 weekly downloads. As such, storybook-docs-toc popularity was classified as popular.
We found that storybook-docs-toc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.