?HAMA

Edit File Size: 1.56 KB

/home/byroehnu/.trash/node_modules11/prosemirror-transform/src/README.md

Text Base64

This module defines a way of modifying documents that allows changes
to be recorded, replayed, and reordered. You can read more about
transformations in [the guide](/docs/guide/#transform).

### Steps

Transforming happens in `Step`s, which are atomic, well-defined
modifications to a document. [Applying](#transform.Step.apply) a step
produces a new document.

Each step provides a [change map](#transform.StepMap) that maps
positions in the old document to position in the transformed document.
Steps can be [inverted](#transform.Step.invert) to create a step that
undoes their effect, and chained together in a convenience object
called a [`Transform`](#transform.Transform).

@Step
@StepResult
@ReplaceStep
@ReplaceAroundStep
@AddMarkStep
@RemoveMarkStep
@AddNodeMarkStep
@RemoveNodeMarkStep
@AttrStep
@DocAttrStep

### Position Mapping

Mapping positions from one document to another by running through the
[step maps](#transform.StepMap) produced by steps is an important
operation in ProseMirror. It is used, for example, for updating the
selection when the document changes.

@Mappable
@MapResult
@StepMap
@Mapping

### Document transforms

Because you often need to collect a number of steps together to effect
a composite change, ProseMirror provides an abstraction to make this
easy. [State transactions](#state.Transaction) are a subclass of
transforms.

@Transform

The following helper functions can be useful when creating
transformations or determining whether they are even possible.

@replaceStep
@liftTarget
@findWrapping
@canSplit
@canJoin
@joinPoint
@insertPoint
@dropPoint

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
attr_step.ts	2.61 KB	lrw-r--r--	2026-02-28 00:28:14	Edit Download recursive recursive
index.ts	561 B	lrw-r--r--	2026-02-28 00:28:24	Edit Download recursive recursive
map.ts	10.71 KB	lrw-r--r--	2026-02-28 00:28:26	Edit Download recursive recursive
mark.ts	3.86 KB	lrw-r--r--	2026-02-28 00:28:28	Edit Download recursive recursive
mark_step.ts	7.18 KB	lrw-r--r--	2026-02-28 00:28:28	Edit Download recursive recursive
README.md	1.56 KB	lrw-r--r--	2026-02-28 00:28:08	Edit Download recursive recursive
replace.ts	19.77 KB	lrw-r--r--	2026-02-28 00:28:32	Edit Download recursive recursive
replace_step.ts	7.04 KB	lrw-r--r--	2026-02-28 00:28:30	Edit Download recursive recursive
step.ts	3.92 KB	lrw-r--r--	2026-02-28 00:28:34	Edit Download recursive recursive
structure.ts	15.09 KB	lrw-r--r--	2026-02-28 00:28:36	Edit Download recursive recursive
transform.ts	10.18 KB	lrw-r--r--	2026-02-28 00:28:38	Edit Download recursive recursive

Directory Contents