wooorm / html-element-attributes

Map of HTML elements to allowed attributes

html-element-attributes

Map of HTML elements to allowed attributes.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • htmlElementAttributes
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This is a map of tag names to lists of allowed attributes. Global attributes are stored at the special tag name *. All attributes from HTML 4 and the current living HTML spec are included.

👉 Note: Includes deprecated attributes.

👉 Note: Attributes which were not global in HTML 4 but are in HTML, are only included in the list of global attributes.

When should I use this?

You can use this to figure out if certain attributes are allowed on certain HTML elements.

Install

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

npm install html-element-attributes

In Deno with esm.sh:

import {htmlElementAttributes} from 'https://esm.sh/html-element-attributes@3'

In browsers with esm.sh:

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

Use

import {htmlElementAttributes} from 'html-element-attributes'

console.log(htmlElementAttributes['*'])
console.log(htmlElementAttributes.ol)

Yields:

[
  'accesskey',
  'autocapitalize',
  'autofocus',
  'class',
  // …
  'style',
  'tabindex',
  'title',
  'translate'
]
['compact', 'reversed', 'start', 'type']

API

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

htmlElementAttributes

Map of lowercase HTML elements to allowed attributes (Record<string, Array<string>>).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

• wooorm/web-namespaces — list of web namespaces
• wooorm/html-tag-names — list of HTML tag names
• wooorm/mathml-tag-names — list of MathML tag names
• wooorm/svg-tag-names — list of SVG tag names
• wooorm/html-void-elements — list of void HTML tag names
• wooorm/svg-element-attributes — map of SVG elements to attributes
• wooorm/aria-attributes — list of ARIA attributes

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

html-element-attributes's Issues

missing aria/role

missing valid aria/role attributes

<span> is missing.

This might be because it doesn't have any attributes — is that how this works?

Missing html element 'span'

Authoring question

As a language-server author, I'm considering using this library,
however, the types of

 * @type {Record<string, Array<string>>}

are not specific enough.

if the index.js were ts (and generated a js + d.ts) we could as const the attribute lists to get TS-fine-grained attribute suggestions in language servers (wrapping TS, such as what Vue, Svelte, and Ember do).

However, I understand if a repo doesn't want to adopt TS, and we can have a manually maintained .d.ts file, but it would basically be a duplicate of the index.js.

commonjs build

legacy node projects

Upstream data errors

I found what look like data errors, possibly in upstream data:

• ShadowRoot.delegatesFocus ended up in template. This is essentially a shadowroot instance method, not sure how it ended up here.
• isindex and prompt are neither elements nor attributes.

Deprecated attributes?

Is it possible to somehow know which attributes are deprecated? Maybe if not in this list, is there another list with HTML5-only things so I can do cross-referencing?