@karmaniverous/hook-form-semantic
    Preparing search index...

    Interface HookFormWysiwygEditorProps<T>

    interface HookFormWysiwygEditorProps<T extends FieldValues> {
        hookControl?: Control<T, any, T>;
        hookDefaultValue?: PathValueImpl<T, Path<T>>;
        hookDisabled?: boolean;
        hookName: Path<T>;
        hookRules?: Omit<
            RegisterOptions<T, Path<T>>,
            "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
        >;
        hookShouldUnregister?: boolean;
        wysiwygAriaActiveDescendantID?: string;
        wysiwygAriaAutoComplete?: string;
        wysiwygAriaDescribedBy?: string;
        wysiwygAriaExpanded?: string;
        wysiwygAriaHasPopup?: string;
        wysiwygAriaLabel?: string;
        wysiwygAriaOwneeID?: string;
        wysiwygContentState?: RawDraftContentState;
        wysiwygCustomBlockRenderFunc?: (block: ContentBlock) => any;
        wysiwygCustomDecorators?: object[];
        wysiwygCustomStyleMap?: object;
        wysiwygDefaultContentState?: RawDraftContentState;
        wysiwygDefaultEditorState?: EditorState;
        wysiwygEditorClassName?: string;
        wysiwygEditorRef?: (ref: object) => void;
        wysiwygEditorStyle?: CSSProperties;
        wysiwygHandleKeyCommand?: (
            command: DraftEditorCommand,
            editorState: EditorState,
            eventTimeStamp: number,
        ) => DraftHandleValue;
        wysiwygHandlePastedText?: (
            text: string,
            html: string,
            editorState: EditorState,
            onChange: (editorState: EditorState) => void,
        ) => boolean;
        wysiwygHandleReturn?: (
            e: SyntheticKeyboardEvent,
            editorState: EditorState,
        ) => boolean;
        wysiwygHashtag?: object;
        wysiwygInitialContentState?: RawDraftContentState;
        wysiwygLocale?: string;
        wysiwygLocalization?: object;
        wysiwygMention?: object;
        wysiwygOnBlur?: (event: SyntheticEvent) => void;
        wysiwygOnChange?: (value: string) => void;
        wysiwygOnContentStateChange?: (contentState: RawDraftContentState) => void;
        wysiwygOnFocus?: (event: SyntheticEvent) => void;
        wysiwygOnTab?: (event: SyntheticKeyboardEvent) => void;
        wysiwygPlaceholder?: string;
        wysiwygReadOnly?: boolean;
        wysiwygSpellCheck?: boolean;
        wysiwygStripPastedStyles?: boolean;
        wysiwygTabIndex?: number;
        wysiwygTextAlignment?: string;
        wysiwygToolbar?: object;
        wysiwygToolbarClassName?: string;
        wysiwygToolbarCustomButtons?: ReactElement<
            HTMLElement,
            string
            | JSXElementConstructor<any>,
        >[];
        wysiwygToolbarHidden?: boolean;
        wysiwygToolbarOnFocus?: boolean;
        wysiwygToolbarStyle?: object;
        wysiwygUploadCallback?: (file: object) => Promise<object>;
        wysiwygValue?: null | string;
        wysiwygWebDriverTestID?: string;
        wysiwygWrapperClassName?: string;
        wysiwygWrapperId?: number;
        wysiwygWrapperStyle?: CSSProperties;
        [key: string]: any;
        [key: number]: any;
    }

    Type Parameters

    • T extends FieldValues

    Hierarchy

    • Omit<
          FormFieldProps,
          "children"
          | "disabled"
          | "error"
          | "name"
          | "onBlur"
          | "ref"
          | "value",
      >
    • PrefixedPartial<Omit<ControllerProps<T>, "render">, "hook">
    • PrefixedPartial<Partial<WysiwygEditorProps>, "wysiwyg">
      • HookFormWysiwygEditorProps

    Indexable

    • [key: string]: any
    • [key: number]: any
    Index

    Properties

    hookControl?: Control<T, any, T>
    hookDefaultValue?: PathValueImpl<T, Path<T>>
    hookDisabled?: boolean
    hookName: Path<T>
    hookRules?: Omit<
        RegisterOptions<T, Path<T>>,
        "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
    >
    hookShouldUnregister?: boolean
    wysiwygAriaActiveDescendantID?: string
    wysiwygAriaAutoComplete?: string
    wysiwygAriaDescribedBy?: string
    wysiwygAriaExpanded?: string
    wysiwygAriaHasPopup?: string
    wysiwygAriaLabel?: string
    wysiwygAriaOwneeID?: string
    wysiwygContentState?: RawDraftContentState
    wysiwygCustomBlockRenderFunc?: (block: ContentBlock) => any
    wysiwygCustomDecorators?: object[]
    wysiwygCustomStyleMap?: object
    wysiwygDefaultContentState?: RawDraftContentState
    wysiwygDefaultEditorState?: EditorState
    wysiwygEditorClassName?: string
    wysiwygEditorRef?: (ref: object) => void
    wysiwygEditorStyle?: CSSProperties
    wysiwygHandleKeyCommand?: (
        command: DraftEditorCommand,
        editorState: EditorState,
        eventTimeStamp: number,
    ) => DraftHandleValue
    wysiwygHandlePastedText?: (
        text: string,
        html: string,
        editorState: EditorState,
        onChange: (editorState: EditorState) => void,
    ) => boolean
    wysiwygHandleReturn?: (
        e: SyntheticKeyboardEvent,
        editorState: EditorState,
    ) => boolean
    wysiwygHashtag?: object
    wysiwygInitialContentState?: RawDraftContentState
    wysiwygLocale?: string
    wysiwygLocalization?: object
    wysiwygMention?: object
    wysiwygOnBlur?: (event: SyntheticEvent) => void
    wysiwygOnChange?: (value: string) => void
    wysiwygOnContentStateChange?: (contentState: RawDraftContentState) => void
    wysiwygOnFocus?: (event: SyntheticEvent) => void
    wysiwygOnTab?: (event: SyntheticKeyboardEvent) => void
    wysiwygPlaceholder?: string
    wysiwygReadOnly?: boolean
    wysiwygSpellCheck?: boolean
    wysiwygStripPastedStyles?: boolean
    wysiwygTabIndex?: number
    wysiwygTextAlignment?: string
    wysiwygToolbar?: object
    wysiwygToolbarClassName?: string
    wysiwygToolbarCustomButtons?: ReactElement<
        HTMLElement,
        string
        | JSXElementConstructor<any>,
    >[]
    wysiwygToolbarHidden?: boolean
    wysiwygToolbarOnFocus?: boolean
    wysiwygToolbarStyle?: object
    wysiwygUploadCallback?: (file: object) => Promise<object>
    wysiwygValue?: null | string
    wysiwygWebDriverTestID?: string
    wysiwygWrapperClassName?: string
    wysiwygWrapperId?: number
    wysiwygWrapperStyle?: CSSProperties