You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
1.3 KiB
40 lines
1.3 KiB
# is-potential-custom-element-name [](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 |
|
|
|
| [](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.
|
|
|