An open API service indexing awesome lists of open source software.

https://github.com/jokeyrhyme/is-webcomponents-supported

does this JavaScript environment support WebComponents?
https://github.com/jokeyrhyme/is-webcomponents-supported

browser feature-detection javascript webcomponents

Last synced: about 2 months ago
JSON representation

does this JavaScript environment support WebComponents?

Awesome Lists containing this project

README

          

# is-webcomponents-supported.js [![npm module](https://img.shields.io/npm/v/is-webcomponents-supported.svg)](https://www.npmjs.com/package/is-webcomponents-supported) [![Travis CI Status](https://travis-ci.org/jokeyrhyme/is-webcomponents-supported.svg?branch=master)](https://travis-ci.org/jokeyrhyme/is-webcomponents-supported)

does this JavaScript environment support WebComponents?

## What is this?

I made this after reading [Polymer for the Performance obsessed](https://aerotwist.com/blog/polymer-for-the-performance-obsessed/)
by [Paul Lewis](https://twitter.com/aerotwist), who mentions a "good little
check" devised by [Glen Maddern](https://twitter.com/glenmaddern).

## Supported Environments

I've manually tested in a range of environments:

- `true`: Chrome (43)

- `false`: Node.js (0.12), Firefox (38)

## Usage

- CommonJS (e.g. Node.js, Browserify, etc) use [index.js](index.js)

```javascript
var isWebComponentsSupported = require('is-webcomponents-supported');
console.log(isWebComponentsSupported()); // `true` or `false`
```

- [dist/index.js](dist/index.js) is a UMD-wrapped version for browsers and AMD

```html

console.log(isWebComponentsSupported()); // `true` or `false`

```

## API

### `isWebComponentsSupported(doc)`

- @param {`Document`} [doc] a DOM Document to run tests against
- @returns {`Boolean`} does this JavaScript environment support WebComponents?

This project uses the global `document` object if you do not provide one. If you
are performing other tests against non-global implementations for some reason,
then this allows you to pass in any such object.