Hiyve Components - v1.0.0
    Preparing search index...

    Interface EditableTitleProps

    interface EditableTitleProps {
        closeIcon?: ReactNode;
        closeTooltip?: string;
        disabled?: boolean;
        onBlur?: () => void;
        onChange: (value: string) => void;
        onClose?: () => void;
        onOpenExisting?: () => void;
        onRename?: (title: string) => void | Promise<void>;
        onSave?: () => void;
        onSaveBeforeClose?: () => Promise<void>;
        openExistingIcon?: ReactNode;
        openExistingTooltip?: string;
        placeholder?: string;
        readOnly?: boolean;
        saveIcon?: ReactNode;
        saveLabels?: Partial<Record<EditableTitleSaveStatus, string>>;
        saveStatus?: EditableTitleSaveStatus;
        saveTooltip?: string;
        value: string;
    }
    Index

    Properties

    closeIcon? closeTooltip? disabled? onBlur? onChange onClose? onOpenExisting? onRename? onSave? onSaveBeforeClose? openExistingIcon? openExistingTooltip? placeholder? readOnly? saveIcon? saveLabels? saveStatus? saveTooltip? value

    Properties

    closeIcon?: ReactNode

    Custom close icon

    closeTooltip?: string

    Tooltip text for the close button

    'Close'
    disabled?: boolean

    Disable editing

    onBlur?: () => void

    Called when the input loses focus (good time to persist)

    onChange: (value: string) => void

    Called on every keystroke

    onClose?: () => void

    Close callback — renders a close button at the end of the title bar

    onOpenExisting?: () => void

    Optional callback for an "Open existing" affordance rendered to the LEFT of the title. When set, an IconButton is placed at the start of the title bar — useful when the editor was opened on a fresh blank file and the user needs a way back to a file picker. Omit to hide the button entirely.

    onRename?: (title: string) => void | Promise<void>

    Called on blur and before close to sync the filename with the current title. May be async.

    onSave?: () => void

    Manual save callback — renders a save button when unsaved changes exist

    onSaveBeforeClose?: () => Promise<void>

    Called before onClose to save unsaved content. EditableTitle awaits this before closing.

    openExistingIcon?: ReactNode

    Custom icon for the open-existing button (defaults to FolderOpen).

    openExistingTooltip?: string

    Tooltip text for the open-existing button.

    'Open existing'
    placeholder?: string

    Placeholder text when the field is empty

    readOnly?: boolean

    Read-only mode — renders static text instead of an input

    saveIcon?: ReactNode

    Custom save icon (defaults to MUI SaveIcon)

    saveLabels?: Partial<Record<EditableTitleSaveStatus, string>>

    Custom labels for each save status (defaults provided)

    saveStatus?: EditableTitleSaveStatus

    Current save status — drives the indicator text and spinner

    saveTooltip?: string

    Tooltip text for the save button

    value: string

    Current title value

    Settings

    Member Visibility

    On This Page

    Properties