tuil
ReferencePackages@mwillbanks/tuil-editorAPI

EditorProviderOptions

interface exported by @mwillbanks/tuil-editor.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-editor.

export interface EditorProviderOptions {
  readonly id?: string;
  readonly documentType?: string;
  readonly value?: string;
  readonly readOnly?: boolean;
  readonly masked?: boolean;
  readonly mode?: EditorMode;
  readonly viewportAnchor?: EditorPosition;
  readonly clipboard?: EditorClipboardAdapter;
  /**
   * Receives the unredacted document after a mutation.
   *
   * Masked sessions redact snapshots, serialization, and clipboard operations.
   * An owning control can use this explicit sink to synchronize its private
   * value without turning a general export API into a secret-recovery path.
   */
  readonly onDocumentChange?: (value: string) => void;
}

Members

MemberTypeRequiredDescriptionRelated types
idstring | undefinedNoThe id member uses the string | undefined contract.
documentTypestring | undefinedNoThe documentType member uses the string | undefined contract.
valuestring | undefinedNoThe value member uses the string | undefined contract.
readOnlyboolean | undefinedNoThe readOnly member uses the boolean | undefined contract.
maskedboolean | undefinedNoThe masked member uses the boolean | undefined contract.
modeEditorMode | undefinedNoThe mode member uses the EditorMode | undefined contract.EditorMode
viewportAnchorEditorPosition | undefinedNoThe viewportAnchor member uses the EditorPosition | undefined contract.EditorPosition
clipboardEditorClipboardAdapter | undefinedNoThe clipboard member uses the EditorClipboardAdapter | undefined contract.
onDocumentChange((value: string) => void) | undefinedNoReceives the unredacted document after a mutation. Masked sessions redact snapshots, serialization, and clipboard operations. An owning control can use this explicit sink to synchronize its private value without turning a general export API into a secret-recovery path.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-editor

On this page