search

web-platform-dx / baseline-status

Apache License 2.0
112 stars 8 forks source link

readme

<baseline-status> web component

A widget displaying Baseline status of a web feature based on https://github.com/web-platform-dx/web-features data

baseline_widget_example

Example

Show Baseline status widget for anchor-positioning:

<baseline-status featureId="anchor-positioning"></baseline-status>

Usage

Option 1. Install and bundle with your application

Install

npm install baseline-status

See docs for example usage in HTML.

See rollup.config.js for an example of a bundler configuration.

Option 2: Precompiled from e.g. CDN.

This method is less optimal from performance perspective, as it can introduce multiple versions of Lit into your application since npm can't deduplicate the packages Learn more.

It can be used for quick testing and prototyping.

<script src="https://cdn.jsdelivr.net/npm/baseline-status@1.0.8/baseline-status.min.js" type="module"></script>
<baseline-status featureId="anchor-positioning"></baseline-status>

Development

To run locally:

  1. Clone the repository.
  2. Install dependencies: npm install.
  3. Start dev server: npm run serve.
  4. Open demo page at http://localhost:8000/docs.

The local server uses wds @web/dev-server package. To enable web component related polyfills for legacy browsers, it uses @web/dev-server-legacy package. See web-dev-server.config file for the exact configuration.