rehype plugin to Mminify event handler attributes
npm install rehype-minify-event-handler[![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]
[rehype][] plugin to minify event handlers.
* What is this?
* When should I use this?
* Install
* Use
* API
* unified().use(rehypeMinifyEventHandler)
* Example
* Syntax
* Syntax tree
* Types
* Compatibility
* Security
* Contribute
* License
This package is a plugin that can minify the JavaScript used as the values of
event handler attributes.
You can use this plugin when you want to improve the size of HTML documents.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install rehype-minify-event-handler
In Deno with [esm.sh][esm-sh]:
`js`
import rehypeMinifyEventHandler from 'https://esm.sh/rehype-minify-event-handler@4'
In browsers with [esm.sh][esm-sh]:
`html`
On the API:
`js
import rehypeMinifyEventHandler from 'rehype-minify-event-handler'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeMinifyEventHandler)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))
`
On the CLI:
`sh`
rehype input.html --use rehype-minify-event-handler --output output.html
On the CLI in a config file (here a package.json):
`diff`
…
"rehype": {
"plugins": [
…
+ "rehype-minify-event-handler",
…
]
}
…
This package exports no identifiers.
The default export is rehypeMinifyEventHandler.
Minify whitespace in attributes.
###### Returns
Transform (Transformer).
###### In
`html`Hello
###### Out
`html`Hello
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,
rehype-minify-event-handler@^4,
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/rehype-minify-event-handler
[downloads-badge]: https://img.shields.io/npm/dm/rehype-minify-event-handler.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]: https://github.com/rehypejs/rehype
[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize
[size]: https://bundlejs.com/?q=rehype-minify-event-handler
[size-badge]: https://img.shields.io/bundlejs/size/rehype-minify-event-handler
[support]: https://github.com/rehypejs/.github/blob/main/support.md
[typescript]: https://www.typescriptlang.org
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting