Map of URL attributes in HTML
npm install html-url-attributes[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][funding-sponsors-badge]][funding]
[![Backers][funding-backers-badge]][funding]
[![Chat][chat-badge]][chat]
Utility with info on URL attributes.
* What is this?
* When should I use this?
* Install
* Use
* API
* urlAttributes
* Syntax
* Syntax tree
* Types
* Compatibility
* Security
* Contribute
* License
This package contains info on attributes that have URLs as values.
You can use this package any time you’re rewriting URLs.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install html-url-attributes
In Deno with [esm.sh][esm-sh]:
`js`
import {urlAttributes} from 'https://esm.sh/html-url-attributes@3'
In browsers with [esm.sh][esm-sh]:
`html`
`js
import {urlAttributes} from 'html-url-attributes'
console.log(urlAttributes.formAction)
//=> ['button', 'input']
console.log(urlAttributes.href)
//=> ['a', 'area', 'base', 'link']
`
This package exports the identifier
urlAttributes.
There is no default export.
HTML URL properties (Record).
Each key is a property name and each value is a list of tag names it applies
to or null if it applies to all elements.
HTML is parsed according to WHATWG HTML (the living standard), which is also
followed by all browsers.
The syntax tree used is [hast][].
This package is fully typed with [TypeScript][].
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-url-attributes@^3,
compatible with Node.js 16.
As rehype works on HTML and improper use of HTML can open you up to a
[cross-site scripting (XSS)][xss] attack, use of rehype can also be unsafe.
Use [rehype-sanitize][rehype-sanitize] to make the tree safe.
See [contributing.md][contributing] in [rehypejs/.github][health] for wayssupport.md`][support] for ways to get help.
to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[author]: https://wooorm.com
[build]: https://github.com/rehypejs/rehype-minify/actions
[build-badge]: https://github.com/rehypejs/rehype-minify/workflows/main/badge.svg
[chat]: https://github.com/rehypejs/rehype/discussions
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
[coverage]: https://codecov.io/github/rehypejs/rehype-minify
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
[downloads]: https://www.npmjs.com/package/html-url-attributes
[downloads-badge]: https://img.shields.io/npm/dm/html-url-attributes.svg
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esm-sh]: https://esm.sh
[funding]: https://opencollective.com/unified
[funding-backers-badge]: https://opencollective.com/unified/backers/badge.svg
[funding-sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[hast]: https://github.com/syntax-tree/hast
[health]: https://github.com/rehypejs/.github
[license]: https://github.com/rehypejs/rehype-minify/blob/main/license
[npm]: https://docs.npmjs.com/cli/install
[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize
[size]: https://bundlejs.com/?q=html-url-attributes
[size-badge]: https://img.shields.io/bundlejs/size/html-url-attributes
[support]: https://github.com/rehypejs/.github/blob/main/support.md
[typescript]: https://www.typescriptlang.org
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting