@api-viewer/docs

API documentation for Web Components. Based on custom elements manifest JSON format.

``html

`

Documentation →

Live Demo →

Install

`sh
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 and / or named slots, if any.
- CSS Custom Properties - Styling API of the component.
- CSS Shadow Parts - Elements that can be styled using ::part()`.