Circle V2 API Docs
    Preparing search index...

    Type Alias UseEditorOptions

    UseEditorOptions: Partial<EditorOptions> & {
        immediatelyRender?: boolean;
        shouldRerenderOnTransaction?: boolean;
    }

    The options for the useEditor hook.

    Type Declaration

    • OptionalimmediatelyRender?: boolean

      Whether to render the editor on the first render. If client-side rendering, set this to true. If server-side rendering, set this to false.

      true
      
    • OptionalshouldRerenderOnTransaction?: boolean

      Whether to re-render the editor on each transaction. This is legacy behavior that will be removed in future versions.

      false