elements
Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
APACHE-2.0 License
Bot releases are visible (Hide)
elements
- v3.2.0
Published by stoplight-bot almost 5 years ago
elements
- v3.0.0
Published by stoplight-bot about 5 years ago
3.0.0 (2019-10-14)
Features
BREAKING CHANGES
- Containers and components no longer render tabs by default. Instead use the
tabsprop to render the tabs you need. For example:
import { Page } from '@stoplight/elements';
import { Docs } from '@stoplight/elements/components/Docs';
import { TryIt } from '@stoplight/elements/components/TryIt';
<Page
srn="gh/stoplightio/elements/README.md"
tabs={({ node }) => {
const tabs = [ { title: 'Docs', content: <Docs node={node} /> } ];
if (node.type === 'http_operation') {
tabs.push({ title: 'Try It', content: <TryIt value={node.value} /> })
}
return tabs;
}}
/>
- Only containers (Provider, Hub, Page, and TableOfContents) are exported from the root. If you need to import a component, do it directly from the component's file. For example:
import { Provider, Hub, Page, TableOfContents } from '@stoplight/elements';
import { Page as PageComponent } from '@stoplight/elements/components/Page';
import { TableOfContents as TableOfContentsComponent } from '@stoplight/elements/components/TableOfContents';
import { Docs } from '@stoplight/elements/components/Docs';
import { Changelog } from '@stoplight/elements/components/Changelog';
Package Rankings
Top 2.03% on Npmjs.org
Top 6.67% on Proxy.golang.org
Top 21.91% on Repo1.maven.org
Badges
Extracted from project README
