Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syntax-tree/hast-util-from-text

utility to set the plain-text value of a node according to the `innerText` algorithm
https://github.com/syntax-tree/hast-util-from-text

hast hast-util html inner-text syntax-tree unist util

Last synced: about 2 months ago
JSON representation

utility to set the plain-text value of a node according to the `innerText` algorithm

Awesome Lists containing this project

README 

        
# hast-util-from-text



[![Build][build-badge]][build]

[![Coverage][coverage-badge]][coverage]

[![Downloads][downloads-badge]][downloads]

[![Size][size-badge]][size]

[![Sponsors][sponsors-badge]][collective]

[![Backers][backers-badge]][collective]

[![Chat][chat-badge]][chat]



[hast][] utility to set the plain-text value of a node.



## Contents



*   [What is this?](#what-is-this)

*   [When should I use this?](#when-should-i-use-this)

*   [Install](#install)

*   [Use](#use)

*   [API](#api)

    *   [`fromText(node[, value])`](#fromtextnode-value)

*   [Types](#types)

*   [Compatibility](#compatibility)

*   [Security](#security)

*   [Related](#related)

*   [Contribute](#contribute)

*   [License](#license)



## What is this?



This package is a utility that takes a [hast][] node and a string and sets that

value as its text.

It is like the DOMs `Node#innerText` setter, which can be a bit nicer than

`Node#textContent`, because this turns line endings into `
` elements.



## When should I use this?



This is a small utility that is useful when you want to set a string that is

close to how it’s “visible” to users.



This utility is similar to [`hast-util-from-string`][hast-util-from-string],

which is simpler, and like the `Node#textContent` algorithm discussed above.



There is also a package [`hast-util-to-text`][hast-util-to-text], which sort

of does the inverse: it takes a node and gets its text.



## Install



This package is [ESM only][esm].

In Node.js (version 16+), install with [npm][]:



```sh

npm install hast-util-from-text

```



In Deno with [`esm.sh`][esmsh]:



```js

import {fromText} from 'https://esm.sh/hast-util-from-text@3'

```



In browsers with [`esm.sh`][esmsh]:



```html



  import {fromText} from 'https://esm.sh/hast-util-from-text@3?bundle'



```



## Use



```js

import {h} from 'hastscript'

import {fromText} from 'hast-util-from-text'



const p1 = h('p')

const p2 = h('p', [h('b', 'Bravo'), '.'])

const p3 = h('p')



fromText(p1, 'Alpha')

fromText(p2, 'Charlie')

fromText(p3, 'Delta\nEcho')



console.log(p1)

console.log(p2)

console.log(p3)

```



Yields:



```js

{

  type: 'element',

  tagName: 'p',

  properties: {},

  children: [ { type: 'text', value: 'Alpha' } ]

}

{

  type: 'element',

  tagName: 'p',

  properties: {},

  children: [ { type: 'text', value: 'Charlie' } ]

}

{

  type: 'element',

  tagName: 'p',

  properties: {},

  children: [

    { type: 'text', value: 'Delta' },

    { type: 'element', tagName: 'br', properties: {}, children: [] },

    { type: 'text', value: 'Echo' }

  ]

}

```



## API



This package exports the identifier [`fromText`][api-from-text].

There is no default export.



### `fromText(node[, value])`



Set the plain-text value of a node.



###### Parameters



*   `tree` ([`Node`][node])

    — node to change

*   `value` (`string`, default: `''`)

    — value to set



###### Returns



Nothing (`undefined`).



###### Algorithm



*   if `tree` is a `comment` or `text`, sets its `value`

*   if `tree` is a `element` or `root`, replaces its children with a `br`

    element for every line ending and a `text` for everything else



###### Notes



`innerText` only exists on elements.

In this utility, we accept all parent nodes and handle them as elements, and

for all literals we set the `value` of the given node the given value.



## Types



This package is fully typed with [TypeScript][].

It exports no additional types.



## 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-from-text@^3`,

compatible with Node.js 16.



## Security



Improper use can open you up to a [cross-site scripting (XSS)][xss] attack as

`value` is injected into the syntax tree.

If operating on a `` element, `value` will run in a browser.



Do not use user input in `value` when operating on `script` elements or use

[`hast-util-santize`][hast-util-sanitize].



## Related



*   [`hast-util-to-text`][hast-util-to-text]

    — get the plain-text value (`innerText`)

*   [`hast-util-to-string`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-to-string)

    — get the plain-text value (`textContent`)

*   [`hast-util-from-string`][hast-util-from-string]

    — set the plain-text value (`textContent`)



## Contribute



See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for

ways to get started.

See [`support.md`][support] for ways to get help.



This project has a [code of conduct][coc].

By interacting with this repository, organization, or community you agree to

abide by its terms.



## License



[MIT][license] © [Titus Wormer][author]



<!-- Definitions -->



[build-badge]: https://github.com/syntax-tree/hast-util-from-text/workflows/main/badge.svg



[build]: https://github.com/syntax-tree/hast-util-from-text/actions



[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-from-text.svg



[coverage]: https://codecov.io/github/syntax-tree/hast-util-from-text



[downloads-badge]: https://img.shields.io/npm/dm/hast-util-from-text.svg



[downloads]: https://www.npmjs.com/package/hast-util-from-text



[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-from-text



[size]: https://bundlejs.com/?q=hast-util-from-text



[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg



[backers-badge]: https://opencollective.com/unified/backers/badge.svg



[collective]: https://opencollective.com/unified



[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg



[chat]: https://github.com/syntax-tree/unist/discussions



[npm]: https://docs.npmjs.com/cli/install



[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c



[esmsh]: https://esm.sh



[typescript]: https://www.typescriptlang.org



[license]: license



[author]: https://wooorm.com



[health]: https://github.com/syntax-tree/.github



[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md



[support]: https://github.com/syntax-tree/.github/blob/main/support.md



[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md



[hast]: https://github.com/syntax-tree/hast



[node]: https://github.com/syntax-tree/hast#nodes



[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting



[hast-util-from-string]: https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-from-string



[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize



[hast-util-to-text]: https://github.com/syntax-tree/hast-util-to-text



[api-from-text]: #fromtextnode-value