@stoplight/elements
Advanced tools
UI components for composing beautiful developer documentation
Supported in modern browsers and node.
# latest stable
yarn add @stoplight/elements
import { Page, Provider, TableOfContents } from '@stoplight/elements';
<Provider>
<div className="flex">
<TableOfContents srn="gh/stoplightio/elements" />
<Page className="flex-1" srn="gh/stoplightio/elements/docs/README.md" />
</div>
</Provider>;
Elements can be used as a plain JS library.
Load the elements library:
Add the following script tag to the head tag of your website, BEFORE other css or script tags.
<head>
<!-- Stoplight Elements -->
<link rel="stylesheet" href="https://stoplight.io/static/elements/bundle.v1.css" media="print" onload="this.media='all'">
<script async defer src='https://stoplight.io/static/elements/bundle.v1.js' onload="__onElementsLoad()"></script>
<script>
function __onElementsLoad() {
// Let elements know where the Stoplight API is running
SL.config.host = "https://stoplight.io/api";
// Emit the SL.ready event so that any code that needs SL can start using it
window.dispatchEvent(new Event('SL.ready'));
}
</script>
<!-- End Stoplight Elements -->
<!-- ... other script and css elements -->
</head>
Global "SL" object:
The global variable made available on the page after the elements library has been loaded.
declare namespace SL {
interface IWidget {
srn: string;
render(htmlId: string, srn: string): void;
remove(): void;
}
// React.createElement
const createElement: any;
const config: {
host?: string;
token?: string;
components?: any;
};
const elements: {
hub: IWidget;
page: IWidget;
toc: IWidget;
};
}
Render a table of contents onto the page:
// Takes two arguments - the html element id, and a stoplight SRN for the project table of contents to render.
SL.elements.toc.render('my-container-element-id', 'gh/stoplightio/studio-demo');
Render a specific page:
// Takes two arguments - the html element id, and a stoplight SRN for the node to render (article, api, model, http operation, etc).
SL.elements.page.render('my-container-element-id', 'gh/stoplightio/studio-demo/docs/README.md');
feature/{name}, chore/{name}, or fix/{name} branch.yarn.yarn test.prod.yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.git push.master branch.FAQs
UI components for composing beautiful developer documentation.
The npm package @stoplight/elements receives a total of 24,883 weekly downloads. As such, @stoplight/elements popularity was classified as popular.
We found that @stoplight/elements demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.