@api-viewer/docs
v1.0.0-pre.10
Published
API documentation viewer for Web Components
Downloads
8,271
Maintainers
Readme
@api-viewer/docs
API documentation for Web Components. Based on custom elements manifest JSON format.
<api-docs src="./custom-elements.json"></api-docs>
Install
npm install @api-viewer/docs
Check out the Getting Started guide.
Features
- Properties - JS properties publicly exposed by the component.
- Attributes - HTML attributes (except those that match properties).
- Events - DOM events dispatched by the component.
- Slots - Default
<slot>
and / or named slots, if any. - CSS Custom Properties - Styling API of the component.
- CSS Shadow Parts - Elements that can be styled using
::part()
.