hast utility to set the plain-text value of a node according to the `innerText` algorithm
npm install 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.
* What is this?
* When should I use this?
* Install
* Use
* API
* [fromText(node[, value])](#fromtextnode-value)
* Types
* Compatibility
* Security
* Related
* Contribute
* License
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 thanNode#textContent, because this turns line endings into elements.
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.
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`
`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' }
]
}
This package exports the identifier [fromText][api-from-text].
There is no default export.
Set the plain-text value of a node.
###### Parameters
* tree ([Node][node])value
— node to change
* (string, default: '')
— value to set
###### Returns
Nothing (undefined).
###### Algorithm
* if tree is a comment or text, sets its valuetree
* if is a element or root, replaces its children with a brtext
element for every line ending and a for everything else
###### Notes
innerText only exists on elements.value
In this utility, we accept all parent nodes and handle them as elements, and
for all literals we set the of the given node the given value.
This package is fully typed with [TypeScript][].
It exports no additional types.
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.
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