# is-potential-custom-element-name

> Check whether a given string matches the `PotentialCustomElementName` production as defined in the HTML Standard.

Latest version **1.0.1** (published 2021-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-potential-custom-element-name
pnpm add is-potential-custom-element-name
yarn add is-potential-custom-element-name
bun add is-potential-custom-element-name
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-04-07 |
| First published | 2016-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/is-potential-custom-element-name) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Mathias Bynens |
| Maintainers | mathias |
| Keywords | html, custom element, custom element name, web components |

## Links

- npm: https://www.npmjs.com/package/is-potential-custom-element-name
- Repository: https://github.com/mathiasbynens/is-potential-custom-element-name
- Issues: https://github.com/mathiasbynens/is-potential-custom-element-name/issues
- npm.io page: https://npm.io/package/is-potential-custom-element-name

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-04-07
- 1.0.0 — 2016-06-21

## README

# is-potential-custom-element-name [![Build status](https://travis-ci.org/mathiasbynens/is-potential-custom-element-name.svg?branch=master)](https://travis-ci.org/mathiasbynens/is-potential-custom-element-name)

_is-potential-custom-element-name_ checks whether a given string matches [the `PotentialCustomElementName` production](https://html.spec.whatwg.org/multipage/scripting.html#prod-potentialcustomelementname) as defined in the HTML Standard.

## Installation

To use _is-potential-custom-element-name_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):

```bash
$ npm install is-potential-custom-element-name
```

Then, `require` it:

```js
const isPotentialCustomElementName = require('is-potential-custom-element-name');
```

## Usage

```js
isPotentialCustomElementName('foo-bar');
// → true
isPotentialCustomElementName('Foo-bar');
// → false
isPotentialCustomElementName('baz-©');
// → false
isPotentialCustomElementName('annotation-xml');
// → true
```

## Author

| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
|---|
| [Mathias Bynens](https://mathiasbynens.be/) |

## License

_is-potential-custom-element-name_ is available under the [MIT](https://mths.be/mit) license.

---
_Source: https://npm.io/package/is-potential-custom-element-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._