Skip to content

API documentation and live playground for Web Components. Based on Custom Elements Manifest format

License

Notifications You must be signed in to change notification settings

open-wc/api-viewer-element

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<api-viewer>

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

<api-viewer src="./custom-elements.json"></api-viewer>

Documentation →

Live Demo →

Screenshot of api-viewer docs

Screenshot of api-viewer demo

Features

Install

npm install api-viewer-element

Check out the Getting Started guide.

Usage

The following web components are available:

Contributing

Install dependencies

yarn

Run demo in browser

yarn dev

Open http://127.0.0.1:8000

Run the docs locally

yarn start

Open http://127.0.0.1:8000

Build the docs site

yarn dist

Acknowledgements