Skip to content

A Web Component widget displaying Baseline status of a web feature

License

Notifications You must be signed in to change notification settings

web-platform-dx/baseline-status

Repository files navigation

<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>

Data source

The widget fetches data from the Web Features API endpoint: https://api.webstatus.dev/v1/features/ which exposes data from the web-platform-dx/web-features project.

Feature IDs come from the github.com/web-platform-dx/web-features repo.

Alternatively, you can find the feature ID by browsing the webstatus.dev site and reading the ID from the URL. E.g. for Intl.ListFormat feature the page URL is https://webstatus.dev/features/intl-list-format, so the ID for this feature is intl-list-format.

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/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.

Copyright and license

Code is released under the Apache License, Version 2.0 with the following notice:

Copyright baseline-status contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

A Web Component widget displaying Baseline status of a web feature

Resources

License

Stars

Watchers

Forks