Edtr.io

The API reference is a Work in Progress and will be continuously improved and extended. We'd love to hear your feedback in our documentation repository.

Home > @edtr-io/core > Document_2

Document_2() function

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Renders an editor for an Edtr.io document

Signature:

export declare function Document<K extends string = string>(
  props: Omit<EditorProps<K>, 'initialState'> & {
    scope: string
  } & (
      | {
          mirror: true
          initialState?: unknown
        }
      | {
          mirror?: false
          initialState: EditorProps<K>['initialState']
        }
    )
): JSX.Element | null

Parameters

Parameter	Type	Description
props	Omit<EditorProps<K>, 'initialState'> & { scope: string; } & ({ mirror: true; initialState?: unknown; } \| { mirror?: false; initialState: EditorProps<K>['initialState']; })	The props for the document

Returns:

JSX.Element | null