{"id":13660595,"url":"https://github.com/open-wc/api-viewer-element","last_synced_at":"2025-05-16T14:06:02.562Z","repository":{"id":42386969,"uuid":"216638621","full_name":"open-wc/api-viewer-element","owner":"open-wc","description":"API documentation and live playground for Web Components. Based on Custom Elements Manifest format","archived":false,"fork":false,"pushed_at":"2025-04-10T07:17:44.000Z","size":3242,"stargazers_count":275,"open_issues_count":18,"forks_count":29,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-10T10:37:54.873Z","etag":null,"topics":["custom-elements","lit-element","webcomponents"],"latest_commit_sha":null,"homepage":"https://api-viewer.open-wc.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-wc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-21T18:32:03.000Z","updated_at":"2025-04-14T19:00:14.000Z","dependencies_parsed_at":"2023-02-08T17:30:30.402Z","dependency_job_id":"fdf738d5-9021-46b7-a4f2-4cea47792d2e","html_url":"https://github.com/open-wc/api-viewer-element","commit_stats":{"total_commits":452,"total_committers":8,"mean_commits":56.5,"dds":0.1415929203539823,"last_synced_commit":"bb5678096591de02bcfe639fc10d6ceaaadbcf71"},"previous_names":["web-padawan/api-viewer-element"],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-wc%2Fapi-viewer-element","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-wc%2Fapi-viewer-element/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-wc%2Fapi-viewer-element/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-wc%2Fapi-viewer-element/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-wc","download_url":"https://codeload.github.com/open-wc/api-viewer-element/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-elements","lit-element","webcomponents"],"created_at":"2024-08-02T05:01:23.435Z","updated_at":"2025-05-16T14:05:57.548Z","avatar_url":"https://github.com/open-wc.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# \u0026lt;api-viewer\u0026gt;\n\nAPI documentation and live playground for Web Components. Based on [custom elements manifest](https://github.com/webcomponents/custom-elements-manifest) JSON format.\n\n```html\n\u003capi-viewer src=\"./custom-elements.json\"\u003e\u003c/api-viewer\u003e\n```\n\n[Documentation →](https://api-viewer.open-wc.org/docs/guide/intro/)\n\n[Live Demo →](https://api-viewer.open-wc.org/docs/examples/api-viewer/)\n\n[\u003cimg src=\"https://raw.githubusercontent.com/open-wc/api-viewer-element/master/screenshot-docs.png\" alt=\"Screenshot of api-viewer docs\" width=\"800\"\u003e](https://api-viewer.open-wc.org)\n\n[\u003cimg src=\"https://raw.githubusercontent.com/open-wc/api-viewer-element/master/screenshot-demo.png\" alt=\"Screenshot of api-viewer demo\" width=\"800\"\u003e](https://api-viewer.open-wc.org)\n\n## Features\n\n- [API docs viewer](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/)\n  - [Properties](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#properties) - JS properties publicly exposed by the component.\n  - [Attributes](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#attributes) - HTML attributes (except those that match properties).\n  - [Events](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#events) - DOM events dispatched by the component.\n  - [Slots](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#slots) - Default `\u003cslot\u003e` and / or named slots, if any.\n  - [CSS Custom Properties](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-custom-properties) - Styling API of the component.\n  - [CSS Shadow Parts](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-shadow-parts) - Elements that can be styled using `::part()`.\n- [Live playground](https://api-viewer.open-wc.org/docs/guide/using-demo/)\n  - [Source](https://api-viewer.open-wc.org/docs/guide/using-demo/#source) - Code snippet matching the rendered component.\n  - [Knobs](https://api-viewer.open-wc.org/docs/guide/using-demo/#knobs) - Change properties and slotted content dynamically.\n  - [Styles](https://api-viewer.open-wc.org/docs/guide/using-demo/#styles) - Change values of the custom CSS properties.\n  - [Event log](https://api-viewer.open-wc.org/docs/guide/using-demo/#events) - Output the events fired by the component.\n  - [Templates](https://api-viewer.open-wc.org/docs/api/templates/) - Provide additional HTML to be shown.\n\n## Install\n\n```sh\nnpm install api-viewer-element\n```\n\nCheck out the [Getting Started](https://api-viewer.open-wc.org/docs/guide/intro/#usage) guide.\n\n## Usage\n\nThe following web components are available:\n\n- [`\u003capi-viewer\u003e`](https://api-viewer.open-wc.org/docs/api/elements/#api-viewer-element)\n- [`\u003capi-docs\u003e`](https://api-viewer.open-wc.org/docs/api/elements/#api-docs-element)\n- [`\u003capi-demo\u003e`](https://api-viewer.open-wc.org/docs/api/elements/#api-demo-element)\n\n## Contributing\n\n### Install dependencies\n\n```sh\nyarn\n```\n\n### Run demo in browser\n\n```sh\nyarn dev\n```\n\nOpen http://127.0.0.1:8000\n\n### Run the docs locally\n\n```sh\nyarn start\n```\n\nOpen http://127.0.0.1:8000\n\n### Build the docs site\n\n```sh\nyarn dist\n```\n\n## Acknowledgements\n\n- Big thanks to [@thepassle](https://github.com/thepassle) for creating Custom Elements Manifest Analyzer, that this project is built upon.\n- Big thanks to [@runem](http://github.com/runem) for creating [Web Component Analyzer](https://github.com/runem/web-component-analyzer) used in older versions of API Viewer.\n- Big thanks to [Modern Web](https://modern-web.dev) for [Web Dev Server](https://modern-web.dev/docs/dev-server/overview/) and [Rocket](https://rocket.modern-web.dev) used for the documentation website.\n- Thanks to [@bahrus](https://github.com/bahrus) for [wc-info](https://github.com/bahrus/wc-info), a similar web component that served as a source of inspiration for me.\n- The `@api-viewer/tabs` web component is based on [tabs example](https://github.com/GoogleChromeLabs/howto-components/tree/master/elements/howto-tabs) from [HowTo: Components](https://developers.google.com/web/fundamentals/web-components/examples) project.\n- The visual appearance is largely inspired by older version of [Vuetify](https://vuetifyjs.com/en/getting-started/quick-start) API documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-wc%2Fapi-viewer-element","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-wc%2Fapi-viewer-element","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-wc%2Fapi-viewer-element/lists"}