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

    Module @hiyve/utilities

    @hiyve/utilities - Utility components and hooks for Hiyve

    This package provides utility components and hooks that are commonly needed in video conferencing applications. These utilities have zero or minimal external dependencies and can be used independently.

    Key Components:

    • LiveClock: Self-contained live time display that updates every second
    • TooltipIconButton: IconButton wrapper that fixes tooltip behavior on disabled buttons

    Key Hooks:

    • useContainerBreakpoint: Responsive container detection using ResizeObserver

    Basic LiveClock usage:

    import { LiveClock } from '@hiyve/utilities';

    function Header() {
    return (
    <header>
    <LiveClock variant="h6" />
    </header>
    );
    }

    TooltipIconButton with disabled state:

    import { TooltipIconButton } from '@hiyve/utilities';
    import SaveIcon from '@mui/icons-material/Save';

    function SaveButton({ hasChanges, onSave }) {
    return (
    <TooltipIconButton
    tooltip={hasChanges ? "Save changes" : "No changes to save"}
    disabled={!hasChanges}
    onClick={onSave}
    >
    <SaveIcon />
    </TooltipIconButton>
    );
    }

    Responsive container with useContainerBreakpoint:

    import { useContainerBreakpoint } from '@hiyve/utilities';

    function ResponsivePanel() {
    const { isBelowBreakpoint, containerRef } = useContainerBreakpoint(600);

    return (
    <div ref={containerRef}>
    {isBelowBreakpoint ? <CompactView /> : <FullView />}
    </div>
    );
    }

    Custom time format for LiveClock:

    import { LiveClock, defaultLiveClockLabels } from '@hiyve/utilities';

    function CustomClock() {
    return (
    <LiveClock
    labels={{
    ...defaultLiveClockLabels,
    formatTime: (date) => date.format('HH:mm:ss'),
    }}
    />
    );
    }

    Debug

    createDebugLogger

    Hooks

    useContainerBreakpoint

    Other

    ErrorBoundary
    DebugConfig
    DebugLogger
    EditableTitleProps
    ErrorBoundaryProps
    MoodData
    MuteStatus
    RetryOptions
    TilePosition
    UseThrottleOptions
    UseValidationResult
    BuiltInLayoutMode
    DebugLevel
    EditableTitleSaveStatus
    LayoutMode
    MoodType
    OverlayPosition
    Validator
    DEFAULT_AVATAR_PALETTE
    DEFAULT_HIYVE_ERROR_MESSAGES
    DEFAULT_RETRY_OPTIONS
    defaultLiveClockColors
    defaultLiveClockLabels
    defaultLiveClockStyles
    defaultTooltipIconButtonStyles
    hiyveDebug
    noopLogger
    validators
    calculateBackoffDelay
    calculateSidebarLayout
    calculateSpeakerLayout
    configureDebug
    EditableTitle
    formatDuration
    formatHiyveError
    formatRelativeTime
    generateAutoFilename
    generateDefaultDisplayName
    generateFilename
    getGridClass
    getGridColumns
    getInitials
    getPositionStyles
    getUserColor
    isDebugEnabled
    mergeLiveClockColors
    mergeLiveClockLabels
    mergeLiveClockStyles
    mergeTooltipIconButtonStyles
    resizeImage
    sanitizeFilename
    sleep
    throttle
    useDebounce
    usePersistedState
    useValidation

    Types

    LiveClockColors
    LiveClockLabels
    LiveClockProps
    LiveClockStyles
    TooltipIconButtonProps
    TooltipIconButtonStyles
    UseContainerBreakpointOptions
    UseContainerBreakpointResult

    Utilities

    isNetworkErrorRetryable
    LiveClock
    TooltipIconButton
    withRetry