API Reference & Compatibility

The complete public API symbol inventory is generated automatically from package source exports:

Functions

`createEditor`

createEditor(options: CreateEditorOptions) => ReturnType<typeof lexicalEditor>

Exported from: @nexload-sdk/payload-editor

Public function exported by @nexload-sdk/payload-editor.

`defineEditorPreset`

Source

defineEditorPreset(options: DefineEditorPresetOptions) => EditorPreset

Exported from: @nexload-sdk/payload-editor

Public function exported by @nexload-sdk/payload-editor.

Classes

`PayloadEditorConfigError`

Source

class PayloadEditorConfigError

Exported from: @nexload-sdk/payload-editor

Public classe exported by @nexload-sdk/payload-editor.

Interfaces

`DefineEditorPresetOptions`

Source

interface DefineEditorPresetOptions { readonly features: Readonly<EditorFeatureConfig> }

Exported from: @nexload-sdk/payload-editor

Public interface exported by @nexload-sdk/payload-editor.

`EditorFeatureConfig`

Source

interface EditorFeatureConfig {
  paragraph?: FeatureOption
  heading?: FeatureOption<HeadingOptions>
  bold?: FeatureOption
  italic?: FeatureOption
  underline?: FeatureOption
  strikethrough?: FeatureOption
  inlineCode?: FeatureOption
  link?: FeatureOption<LinkOptions>
  unorderedList?: FeatureOption
  orderedList?: FeatureOption
  blockquote?: FeatureOption
  horizontalRule?: FeatureOption
  upload?: FeatureOption<UploadOptions>
  relationship?: FeatureOption<RelationshipOptions>
  inlineToolbar?: FeatureOption
  fixedToolbar?: FeatureOption
}

Exported from: @nexload-sdk/payload-editor

Public interface exported by @nexload-sdk/payload-editor.

`EditorPreset`

Source

interface EditorPreset {
  readonly [editorPresetBrand]: true
  readonly features: Readonly<EditorFeatureConfig>
}

Exported from: @nexload-sdk/payload-editor

Public interface exported by @nexload-sdk/payload-editor.

`HeadingOptions`

Source

interface HeadingOptions { sizes?: readonly HeadingSize[] }

Exported from: @nexload-sdk/payload-editor

Public interface exported by @nexload-sdk/payload-editor.

`LinkOptions`

Source

interface LinkOptions extends RelationalOptions<CollectionSlug> { autoLink?: boolean }

Exported from: @nexload-sdk/payload-editor

Public interface exported by @nexload-sdk/payload-editor.

Types

`CreateEditorOptions`

Source

type CreateEditorOptions = CommonEditorOptions & (
  | {
    readonly preset: EditorPresetName | EditorPreset
    readonly features?: Readonly<EditorFeatureConfig>
  }
  | {
    readonly preset?: never
    readonly features: Readonly<EditorFeatureConfig>
  }
);

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`EditorPresetName`

Source

type EditorPresetName
  = | "compact"
    | "standard"
    | "structured-content"
    | "article"
    | "product-description";

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`FeatureOption`

Source

type FeatureOption<TOptions = never> = [TOptions] extends [never]
  ? boolean
  : boolean | Readonly<TOptions>;

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`HeadingSize`

Source

type HeadingSize = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`NativeEditorFeature`

Source

type NativeEditorFeature = FeatureProviderServer<any, any, any>;

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`PayloadEditorConfigErrorCode`

Source

type PayloadEditorConfigErrorCode
  = | "PAYLOAD_EDITOR_DEFINITION_REQUIRED"
    | "PAYLOAD_EDITOR_UNKNOWN_PRESET"
    | "PAYLOAD_EDITOR_UNKNOWN_FEATURE"
    | "PAYLOAD_EDITOR_INVALID_FEATURE_OPTIONS"
    | "PAYLOAD_EDITOR_INVALID_HEADING_SIZES"
    | "PAYLOAD_EDITOR_INVALID_COLLECTIONS"
    | "PAYLOAD_EDITOR_INVALID_MAX_DEPTH"
    | "PAYLOAD_EDITOR_INVALID_EXTENSION"
    | "PAYLOAD_EDITOR_DUPLICATE_FEATURE";

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`RelationshipOptions`

Source

type RelationshipOptions = RelationalOptions<CollectionSlug>;

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

`UploadOptions`

Source

type UploadOptions = RelationalOptions<UploadCollectionSlug>;

Exported from: @nexload-sdk/payload-editor

Public type exported by @nexload-sdk/payload-editor.

Functions Reference

Function	Return Type	Description
`createEditor(options)`	`RichTextAdapterProvider`	Compiles an explicit feature definition into Payload’s official Lexical editor provider.
`defineEditorPreset(options)`	`EditorPreset`	Defines an immutable, reusable editor preset for team-wide policy sharing.

Runtime Compatibility Matrix

Runtime / Engine	Version Requirement	Verification Status
Node.js	`>=20.9.0`	Verified on Node 20 & 22
Payload CMS	`>=3.85.0 <4.0.0`	Verified on Payload 3.86.0
`@payloadcms/richtext-lexical`	`>=3.85.0 <4.0.0`	Verified on Lexical 3.86.0
Module Format	ESM only	Server and configuration safe
Side Effects	`false`	Fully tree-shakeable