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

    Interface UpdateBannerProps

    Props for UpdateBanner.

    interface UpdateBannerProps {
        checkInterval?: number;
        currentVersion?: string;
        electronBridge?: ElectronUpdateBridge | null;
        labels?: Partial<UpdateBannerLabels>;
        onError?: (error: Error) => void;
        recheckOnFocus?: boolean;
        sx?: SxProps<Theme>;
        versionUrl?: string;
    }
    Index

    Properties

    checkInterval? currentVersion? electronBridge? labels? onError? recheckOnFocus? sx? versionUrl?

    Properties

    checkInterval?: number

    Polling interval in ms for web version checks.

    300000 (5 min)
    currentVersion?: string

    The build hash baked into the running bundle (e.g. via Vite's define injecting import.meta.env.VITE_BUILD_HASH). When provided, the banner detects a stale bundle on the very first poll instead of locking onto whatever versionUrl returned at mount. Strongly recommended for production.

    electronBridge?: ElectronUpdateBridge | null

    Electron update bridge. When omitted, auto-detects window.electronAPI.

    labels?: Partial<UpdateBannerLabels>

    Override default labels for i18n.

    onError?: (error: Error) => void

    Called on errors (version fetch failures).

    recheckOnFocus?: boolean

    Whether to re-check on tab focus / visibility change.

    true
    sx?: SxProps<Theme>

    MUI sx override for the banner container.

    versionUrl?: string

    URL to poll for web version updates.

    "/version.json"

    Settings

    Member Visibility

    On This Page

    Properties