Plate
PlateEditorsTemplates
GitHub16kGitHub
DiscordDiscord
    • Overview
    • Why This Fork
    • Examples
    • Installing Plite
    • Adding Event Handlers
    • Defining Custom Elements
    • Applying Custom Formatting
    • Executing Commands
    • Saving to a Database
    • Canonical Change Substrate
    • Improving Performance
    • Interfaces
    • Nodes
    • Locations
    • Transforms
    • Document Changes
    • Commands
    • Editor
    • Plugins
    • Rendering
    • Serializing
    • Normalizing
    • Using TypeScript
    • Roots
    • Document State
    • Editing Behavior
    • Selection And DOM
    • Clipboard And Paste
    • Decorations, annotations, and widgets
    • Schema
    • Anchor API
    • Location API
    • Path API
    • PointEntry API
    • Point API
    • Range API
    • Selection API
    • Location Types APIs
    • Span API
    • Editor
    • Element API
    • NodeEntry API
    • Node API
    • Node Types APIs
    • Text API
    • Debug Value Scrubbing
    • Transforms API
    • Plite DOM
    • History Editor API
    • History Plugin Setup
    • History
    • Plite History
    • Plite Hyperscript
    • Plite PaginationExperimental
    • Annotations
    • DOM Coverage Boundaries
    • Editable Component
    • External Text Views
    • Plite React Event Handling
    • Virtualized Rendering
    • Plite React Hooks
    • React Editor Setup
    • React Editor
    • Plite React
    • Plite Component
    • Plite Yjs
    • Plite
    • Migration
    • Contributing
    • FAQ
    • Resources

Location API

PreviousNext

Location union helpers for validating paths, points, and ranges.

The Location interface is a union of the ways to refer to a specific location in a Plite document: paths, points, or ranges. Methods often accept Location instead of requiring only Path, Point, or Range.

Type

type Location = Path | Point | Range;
type Location = Path | Point | Range;

Public read and update methods with an at option accept NodeTarget, which adds live text and element nodes without changing the Location type.

type NodeTarget<N extends Descendant = Descendant> = Location | N;
type NodeTarget<N extends Descendant = Descendant> = Location | N;

Use editor.read.nodes.path(node) when you need to resolve a node target to its current path. Pure location utilities continue to accept structural locations.

On this page

  • Static methods
    • Check methods

Static methods

Check methods

LocationApi.isLocation(value: unknown) => value is Location

Check if a value implements the Location interface.

Anchor APIPath API

On This Page

TypeOn this pageStatic methodsCheck methodsLocationApi.isLocation(value: unknown) => value is Location
Build your editor
Production-ready AI template and reusable components.
Get all-access