hast-util-is-css-style
v3.0.1
Published
hast utility to check if an element is a css style
Downloads
85,201
Readme
hast-util-is-css-style
hast
utility to check if an element is a CSS <style>
element.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a utility to check whether a hast node is a <style>
that
contains CSS.
When should I use this?
You can use this package to check whether <style>
elements contain CSS or
something else.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install hast-util-is-css-style
In Deno with esm.sh
:
import {isCssStyle} from 'https://esm.sh/hast-util-is-css-style@3'
In browsers with esm.sh
:
<script type="module">
import {isCssStyle} from 'https://esm.sh/hast-util-is-css-style@3?bundle'
</script>
Use
import {h} from 'hastscript'
import {isCssStyle} from 'hast-util-is-css-style'
isCssStyle(h('style')) //=> true
isCssStyle(h('style', {type: ' TEXT/CSS '})) //=> true
isCssStyle(h('style', {type: 'text/foo'})) //=> false
API
This package exports the identifier
isCssStyle
.
There is no default export.
isCssStyle(node)
Check whether a hast node is a <style>
that contains CSS.
Returns true
if node
is a <style>
element that has no type
, an empty
type
, or 'text/css'
as its type
.
Parameters
node
(Node
) — node to check
Returns
Whether node
is a CSS style element (boolean
).
Syntax
HTML is parsed according to WHATWG HTML (the living standard), which is also followed by all browsers.
Syntax tree
The syntax tree used is hast.
Types
This package is fully typed with TypeScript.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
hast-util-is-css-style@^3
,
compatible with Node.js 16.
Security
As rehype works on HTML and improper use of HTML can open you up to a
cross-site scripting (XSS) attack, use of rehype can also be unsafe.
Use rehype-sanitize
to make the tree safe.
Contribute
See contributing.md
in rehypejs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.