html-enumerated-attributes

html-enumerated-attributes

Utility with info on enumerated attributes.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • enumeratedAttributes
  • Definition
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package contains info on enumerated attributes (attributes that have a limited list of acceptable values).

When should I use this?

You can use this package for linting and minification purposes.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install html-enumerated-attributes

In Deno with esm.sh:

import {enumeratedAttributes} from 'https://esm.sh/html-enumerated-attributes@1'

In browsers with esm.sh:

<script type="module">
  import {enumeratedAttributes} from 'https://esm.sh/html-enumerated-attributes@1?bundle'
</script>

Use

import {enumeratedAttributes} from 'html-enumerated-attributes'

console.log(enumeratedAttributes.loading)
//=> {selector: 'iframe, img', invalid: 'eager', missing: 'eager', states: ['eager', 'lazy']}

API

This package exports the identifier enumeratedAttributes. There is no default export.

enumeratedAttributes

Enumerated HTML attributes (Record<string, Array<Definition> | Definition>).

Definition

Info (TypeScript type).

Fields

• allowUnknown (boolean, default: false) — whether arbitrary values are allowed
• caseSensitive (boolean, default: false) — enumerated values are often treated case-insensitive, except when this field is on
• invalid (string, null, optional) — invalid value default; null means a particular unnamed state
• missing (string, null, optional) — missing value default; null means a particular unnamed state
• selector (string, optional, example: 'meta, script') — simple CSS selector; can contain commas; missing means it applies to all elements
• states (Array<Array<string> | string | null>) — possible states

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, html-enumerated-attributes@^1, 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.

License

MIT © Titus Wormer