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

    Interface UseClipPersistenceOptions

    Options for useClipPersistence hook.

    interface UseClipPersistenceOptions {
        autoSaveInterval?: number;
        client: ClipFileClient | null;
        clips: ClipItem[];
        collaborationMode: CollaborationMode;
        enabled?: boolean;
        fileId?: string;
        fileLocation?: string;
        gridLayout?: GridLayoutItem[];
        lockMode: CompositionLockMode;
        onError?: (error: Error) => void;
        onSaved?: (fileId: string) => void;
        title: string;
        userId: string;
        userName?: string;
    }
    Index

    Properties

    autoSaveInterval? client clips collaborationMode enabled? fileId? fileLocation? gridLayout? lockMode onError? onSaved? title userId userName?

    Properties

    autoSaveInterval?: number

    Auto-save interval in milliseconds

    client: ClipFileClient | null

    File client from provider

    clips: ClipItem[]

    Current clips array

    collaborationMode: CollaborationMode

    Collaboration mode

    enabled?: boolean

    Whether persistence is enabled

    fileId?: string

    Existing file ID

    fileLocation?: string

    File storage location

    gridLayout?: GridLayoutItem[]

    Grid layout

    lockMode: CompositionLockMode

    Lock mode

    onError?: (error: Error) => void

    Called on save error

    onSaved?: (fileId: string) => void

    Called after successful save

    title: string

    Composition title

    userId: string

    Author user ID

    userName?: string

    Author display name

    Settings

    Member Visibility

    On This Page

    Properties