Skip to content

PlimInputBoxProps

type PlimInputBoxProps = {
asyncEventListeners?: AsyncListenerRegistration[];
autoFocus?: boolean;
className?: string;
clearOnSubmit?: boolean;
handle?: EditorHandle;
initialContent?: DocumentNode;
onSubmit?: (state) => void;
onTransaction?: (tx, state) => void;
placeholder?: string;
plim: PlimDriver;
readonly?: boolean;
style?: React.CSSProperties;
submitOnEnter?: boolean;
whenReady?: () => void;
};

Defined in: react/src/index.tsx:177

PropertyTypeDescriptionDefined in
asyncEventListeners?AsyncListenerRegistration[]-react/src/index.tsx:193
autoFocus?boolean-react/src/index.tsx:182
className?string-react/src/index.tsx:194
clearOnSubmit?booleanClear the input and re-focus after a successful submit. Default true.react/src/index.tsx:188
handle?EditorHandle-react/src/index.tsx:179
initialContent?DocumentNode-react/src/index.tsx:180
onSubmit?(state) => voidCalled with the current state when the user submits (never for empty input).react/src/index.tsx:190
onTransaction?(tx, state) => void-react/src/index.tsx:191
placeholder?stringPlaceholder shown while the input is empty. Applied at mount.react/src/index.tsx:184
plimPlimDriver-react/src/index.tsx:178
readonly?boolean-react/src/index.tsx:181
style?React.CSSProperties-react/src/index.tsx:195
submitOnEnter?booleanEnter submits (Shift+Enter → newline). Default true.react/src/index.tsx:186
whenReady?() => void-react/src/index.tsx:192