Björn
b963b3396c
|
5 years ago | |
---|---|---|
.. | ||
LICENSE | 5 years ago | |
README.md | 5 years ago | |
dom-nodes.js | 5 years ago | |
index.next.js | 5 years ago | |
package.json | 5 years ago |
README.md
dom-nodes
Installation
$ npm i dom-nodes -S
Usage
import {isVoid} from 'dom-nodes'
isVoid('div') // false
isVoid('img') // true
dom-nodes
exports all the methods listed below giving you some simple tests to understand which kind of node you are dealing with.
This project includes html-tags and svg-tag-names directly in its source code avoiding to rely on third party npm modules for such simple list of strings. This project couldn't have been made without the projects above!
API
Table of Contents
- VOID_SVG_TAGS_LIST
- HTML_ELEMENTS_HAVING_VALUE_ATTRIBUTE_LIST
- SVG_TAGS_LIST
- VOID_HTML_TAGS_LIST
- HTML_TAGS_LIST
- BOOLEAN_ATTRIBUTES_LIST
- HTML_TAGS_RE
- SVG_TAGS_RE
- VOID_HTML_TAGS_RE
- VOID_SVG_TAGS_RE
- HTML_ELEMENTS_HAVING_VALUE_ATTRIBUTE_RE
- BOOLEAN_ATTRIBUTES_RE
- isVoid
- isHtml
- isSvg
- isCustom
- hasValueAttribute
- isBoolAttribute
VOID_SVG_TAGS_LIST
SVG void elements that cannot be auto-closed and shouldn't contain child nodes.
Type: Array
HTML_ELEMENTS_HAVING_VALUE_ATTRIBUTE_LIST
List of html elements where the value attribute is allowed
Type: Array
SVG_TAGS_LIST
List of all the available svg tags
Type: Array
VOID_HTML_TAGS_LIST
- See: http://www.w3.org/TR/html-markup/syntax.html#syntax-elements
- See: http://www.w3.org/TR/html5/syntax.html#void-elements
HTML void elements that cannot be auto-closed and shouldn't contain child nodes.
Type: Array
HTML_TAGS_LIST
List of all the html tags
Type: Array
BOOLEAN_ATTRIBUTES_LIST
List of all boolean HTML attributes
Type: RegExp
HTML_TAGS_RE
Regex matching all the html tags ignoring the cases
Type: RegExp
SVG_TAGS_RE
Regex matching all the svg tags ignoring the cases
Type: RegExp
VOID_HTML_TAGS_RE
Regex matching all the void html tags ignoring the cases
Type: RegExp
VOID_SVG_TAGS_RE
Regex matching all the void svg tags ignoring the cases
Type: RegExp
HTML_ELEMENTS_HAVING_VALUE_ATTRIBUTE_RE
Regex matching all the html tags where the value tag is allowed
Type: RegExp
BOOLEAN_ATTRIBUTES_RE
Regex matching all the boolean attributes
Type: RegExp
isVoid
True if it's a self closing tag
Parameters
tag
string test tag
Examples
isVoid('meta') // true
isVoid('circle') // true
isVoid('IMG') // true
isVoid('div') // false
isVoid('mask') // false
Returns boolean true if void
isHtml
True if it's a known HTML tag
Parameters
tag
string test tag
Examples
isHtml('img') // true
isHtml('IMG') // true
isHtml('Img') // true
isHtml('path') // false
Returns boolean true if html tag
isSvg
True if it's a known SVG tag
Parameters
tag
string test tag
Examples
isSvg('g') // true
isSvg('radialGradient') // true
isSvg('radialgradient') // true
isSvg('div') // false
Returns boolean true if svg tag
isCustom
True if it's not SVG nor a HTML known tag
Parameters
tag
string test tag
Examples
isCustom('my-component') // true
isCustom('div') // false
Returns boolean true if custom element
hasValueAttribute
True if the value attribute is allowed on this tag
Parameters
tag
string test tag
Examples
hasValueAttribute('input') // true
hasValueAttribute('div') // false
Returns boolean true if the value attribute is allowed
isBoolAttribute
True if it's a boolean attribute
Parameters
attribute
string test attribute
Examples
isBoolAttribute('selected') // true
isBoolAttribute('class') // false
Returns boolean true if the attribute is a boolean type