hast-util-from-text

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

What is this?
When should I use this?
Install
Use
API
- fromText(node[, value])
Types
Compatibility
Security
Related
Contribute
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 <br> 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, which is simpler, and like the Node#textContent algorithm discussed above.

There is also a package hast-util-to-text, which sort of does the inverse: it takes a node and gets its text.

Install

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

npm install hast-util-from-text

In Deno with esm.sh:

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

In browsers with esm.sh:

<script type="module">
  import {fromText} from 'https://esm.sh/hast-util-from-text@3?bundle'
</script>

Use

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:

{
  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. There is no default export.

`fromText(node[, value])`

Set the plain-text value of a node.

Parameters

tree (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) attack as value is injected into the syntax tree. If operating on a <script> 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-to-text — get the plain-text value (innerText)
hast-util-to-string — get the plain-text value (textContent)
hast-util-from-string — set the plain-text value (textContent)

Contribute

See contributing.md in syntax-tree/.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.

syntax-tree/hast-util-from-text