Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@oddbird/browser-support

Package Overview
Dependencies
Maintainers
0
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@oddbird/browser-support

A web component for showing browser-support data from the Web Features project

  • 0.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
77
Maintainers
0
Weekly downloads
 
Created
Source

browser-support

A web component for showing browser-support data from the Web Features project.

This is inspired by the official baseline-status component from Google and the Web Platform DX community group. It currently uses their https://api.webstatus.dev/v1/features/ API.

Features

  • Stand-alone component, without Lit or other frameworks
  • Responsive to font sizes, available space, and light/dark schemes
  • Allows customization of the title markup (h2 by default)
  • 'Newly supported' web features show a timeline towards broad support
  • Allows for simple light-dom fallback & progressive enhancement

Demo

Examples

General usage example:

<script type="module" src="browser-support.js"></script>

<browser-support data-feature="container-queries"></browser-support>

<!-- With a light-dom fallback… -->
<browser-support>
  <h3 slot="title">Container Style Queries</h3>
  <a href="https://web-platform-dx.github.io/web-features-explorer/features/container-style-queries/">
    Browser support data
  </a>
</browser-support>

Installation

You have a few options (choose one):

  1. Install via npm: npm install @oddbird/browser-support
  2. Download the source manually from GitHub into your project.
  3. Skip this step and use the script directly via a 3rd party CDN (not recommended for production use)

Usage

Make sure you include the <script> in your project (choose one, and update the version number as needed):

<!-- Host yourself -->
<script type="module" src="browser-support.js"></script>
<!-- 3rd party CDN, not recommended for production use -->
<script
  type="module"
  src="https://www.unpkg.com/@oddbird/browser-support@0.1.0/browser-support.js"
></script>
<!-- 3rd party CDN, not recommended for production use -->
<script
  type="module"
  src="https://esm.sh/@oddbird/browser-support@0.1.0"
></script>

Or use the built-in WebC component with Eleventy, by adding "npm:@oddbird/browser-support/*.webc" to the Eleventy WebC Plugin components registry:

// Only one module.exports per configuration file, please!
module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(eleventyWebcPlugin, {
    components: [
      // Add as a global WebC component
      "npm:@oddbird/browser-support/*.webc",
    ],
  });
}

Slots

The title slot allows providing a fallback title, and also the desired markup. When the component is defined, the actual title text will be replaced with the name of the feature.

ToDo

  • Provide more clarity around the progress bar?
  • Improve and document styling options
  • List mobile browser support data
  • Show browser versions (or how many versions back?)
  • Allow changing title markup with an attribute?

Support

At OddBird, we enjoy collaborating and contributing as part of an open web community. But those contributions take time and effort. If you're interested in supporting our open-source work, consider becoming a GitHub sponsor, or contributing to our Open Collective.

❤️ Thanks!

Credit

With thanks to the following people:

Keywords

FAQs

Package last updated on 23 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc