Registry / web-framework / prosemirror-trailing-node

prosemirror-trailing-node

library3.0.0jsnpmunverified

prosemirror-trailing-node is a plugin for the ProseMirror rich text editor that ensures there's always an editable node at the end of the document. This is particularly useful for preventing users from getting stuck within non-editable or complex nodes, allowing for continuous input. It automatically appends a configurable default node, such as a paragraph, when the last node in the document is not empty. The current stable version is 3.0.0, aligning with the major version 3 of the Remirror ecosystem, of which it is a part. Remirror, and by extension its associated plugins like this one, maintains an active release cadence with frequent patch updates to address issues and align with ProseMirror core updates, as seen in recent changelogs. Its key differentiator is its simple, focused solution for a common ProseMirror UX problem, integrated within a broader, actively developed framework.

web-framework

npm install prosemirror-trailing-node

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PROSEMIRROR-TRAILI

prosemirror-trailing-node

web-frameworkjavascriptv3.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

trailingNode

✓ import { trailingNode } from 'prosemirror-trailing-node';

✗ const { trailingNode } = require('prosemirror-trailing-node');

The package primarily uses named exports. CommonJS require is not supported in v3 due to ESM migration.

TrailingNodeOptions

✓ import type { TrailingNodeOptions } from 'prosemirror-trailing-node';

Importing types requires the `type` keyword and is crucial for TypeScript projects.

EditorState

✓ import { EditorState } from 'prosemirror-state';

✗ import EditorState from 'prosemirror-state';

EditorState is a named export from prosemirror-state, not a default export.

This quickstart demonstrates how to initialize a basic ProseMirror editor with the `prosemirror-trailing-node` plugin, configuring it to append a paragraph node and ignore specific node types. It sets up the editor state and view, making it runnable in a browser environment.

import { schema } from 'prosemirror-schema-basic'; import { EditorState } from 'prosemirror-state'; import { EditorView } from 'prosemirror-view'; import { trailingNode } from 'prosemirror-trailing-node'; const editorSchema = schema; // Initialize the editor state with the trailingNode plugin. const state = EditorState.create({ schema: editorSchema, plugins: [ trailingNode({ ignoredNodes: ['code_block'], // Example: don't add trailing node after code blocks nodeName: 'paragraph' // The node type to append }) ] }); // Create the editor view and mount it to the DOM. const view = new EditorView(document.body, { state, dispatchTransaction(transaction) { const newState = view.state.apply(transaction); view.updateState(newState); } }); console.log('ProseMirror editor with trailing node plugin initialized.');

Debug

Known issues

breakingVersion 3.0.0 introduces breaking changes, primarily aligning with Remirror v3's move towards ESM-only imports and updated ProseMirror peer dependencies. Ensure your project is configured for ESM and that you update your core ProseMirror packages to compatible versions.

fix

Migrate your project to use ESM `import` syntax. Update `prosemirror-model`, `prosemirror-state`, and `prosemirror-view` to the `^1.x.x` ranges specified in the peer dependencies for optimal compatibility.

affects: >=3.0.0

gotchaThis package requires specific peer dependencies of `prosemirror-model`, `prosemirror-state`, and `prosemirror-view`. Failure to install these or using incompatible versions can lead to runtime errors or unexpected behavior within your ProseMirror editor.

fix

Always install the peer dependencies alongside `prosemirror-trailing-node` using your package manager (e.g., `npm install prosemirror-trailing-node prosemirror-view prosemirror-state prosemirror-keymap`) and ensure their versions fall within the specified ranges.

affects: >=1.0.0

gotchaThe `nodeName` option in `trailingNode` must correspond to a valid node name defined in your ProseMirror schema. If the specified `nodeName` does not exist in the schema, the plugin may not function correctly or could throw errors.

fix

Verify that the `nodeName` configured in `trailingNode({ nodeName: 'your_node' })` matches an existing node type within your `prosemirror-schema-basic` or custom schema.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: trailingNode is not a function

Attempting to use CommonJS `require()` syntax with an ESM-only package or incorrect named import.

fix

Ensure you are using `import { trailingNode } from 'prosemirror-trailing-node';` in an ESM context. If using TypeScript, ensure your `tsconfig.json` targets `es2015` or higher and `moduleResolution` is set appropriately (e.g., `bundler`).

Error: Cannot find module 'prosemirror-trailing-node'

The package or its peer dependencies are not installed correctly or not accessible in the current environment.

fix

Run `npm install prosemirror-trailing-node prosemirror-model prosemirror-state prosemirror-view` (or `yarn add`/`pnpm add`) to ensure all necessary packages are present.

Error: (plugin prosemirror-trailing-node): 'nodeName' (or 'createNode') is required

The `nodeName` or `createNode` option was not provided to the `trailingNode` plugin configuration.

fix

When initializing the plugin, provide either `nodeName` (a string matching a schema node) or a `createNode` function: `trailingNode({ nodeName: 'paragraph' })`.

Upgrade

Version history

3.0.0latest on npm

Audit

Dependencies

prosemirror-modelrequiredRequired peer dependency for ProseMirror's document model.

prosemirror-staterequiredRequired peer dependency for managing editor state, including plugins.

prosemirror-viewrequiredRequired peer dependency for rendering the editor and handling interactions.

Agent activity

7 hits · last 30 days

node

Bingbot

Resources

githubhttps://github.com/remirror/remirror ↗

packagehttps://www.npmjs.com/package/prosemirror-trailing-node ↗

homepagehttps://remirror.io ↗