Hosanna UI API v1.40.0-next
    Preparing search index...

    Interface CollectionViewState

    State interface for CollectionViewView.

    interface CollectionViewState {
        audioGuideHint?: string;
        audioGuideItem?: string | IAudioGuideItem;
        canReceiveFocus?: boolean;
        clippingRect?: [number, number, number, number];
        customData?: unknown;
        dataSource?: CollectionViewDataSource.CollectionViewDataSource;
        floatingFocusAreaHeight?: number;
        focusId?: string;
        focusIndicatorAppearance?: ICollectionViewFocusIndicatorAppearance;
        focusIndicatorTransitionType?: CollectionViewFocusIndicatorTransitionType;
        height?: number;
        id?: string;
        includeInLayout?: boolean;
        isInitialFocus?: boolean;
        isSkeleton?: boolean;
        layoutSettledDelayMs?: number;
        layoutSettledVisibilityThreshold?: number;
        maskSettingsKey?: string;
        nativeGlass?: SGNativeGlassEffect;
        nextFocusMap?: ViewFocusMap;
        onItemBlurring?: ViewEventHandler<CollectionViewEvent>;
        onItemFocus?: ViewEventHandler<CollectionViewEvent>;
        onItemFocusing?: ViewEventHandler<CollectionViewEvent>;
        onItemLongPressSelected?: ViewEventHandler<CollectionViewEvent>;
        onItemSelected?: ViewEventHandler<CollectionViewEvent>;
        onLayoutSettled?: ViewEventHandler<CollectionViewLayoutSettledEvent>;
        onOptionsKeyPressed?: ViewEventHandler<CollectionViewEvent>;
        onRowFocus?: ViewEventHandler<CollectionViewEvent>;
        onSupplementarySelected?: ViewEventHandler<
            CollectionViewSupplementarySelectionEvent,
        >;
        opacity?: number;
        pointerScrollSnapToFocus?: boolean;
        readingDirection?: ReadingDirection;
        rotation?: number;
        rowSpacing?: number;
        safeAreaBehavior?: CollectionViewSafeAreaBehavior;
        scale?: [number, number];
        scaleRotateCenter?: [number, number];
        scrollablePositionX?: number;
        scrollablePositionY?: number;
        scrollInsets?: CollectionViewScrollInsets;
        scrollMode?: CollectionViewScrollMode;
        skeletonShimmer?: boolean;
        skeletonViews?: ViewStruct<ViewState>[];
        staticType?: ViewStaticType;
        style?: IStatefulStyle;
        styleKey?: string;
        translation?: number[];
        verticalFocusAnimationType?: VerticalFocusAnimationType;
        viewportHeight?: number;
        viewportWidth?: number;
        viewStatus?: ViewStatus;
        visible?: boolean;
        width?: number;
    }

    Hierarchy

    • ViewState
      • CollectionViewState
    Index

    Properties

    audioGuideHint? audioGuideItem? canReceiveFocus? clippingRect? customData? dataSource? floatingFocusAreaHeight? focusId? focusIndicatorAppearance? focusIndicatorTransitionType? height? id? includeInLayout? isInitialFocus? isSkeleton? layoutSettledDelayMs? layoutSettledVisibilityThreshold? maskSettingsKey? nativeGlass? nextFocusMap? onItemBlurring? onItemFocus? onItemFocusing? onItemLongPressSelected? onItemSelected? onLayoutSettled? onOptionsKeyPressed? onRowFocus? onSupplementarySelected? opacity? pointerScrollSnapToFocus? readingDirection? rotation? rowSpacing? safeAreaBehavior? scale? scaleRotateCenter? scrollablePositionX? scrollablePositionY? scrollInsets? scrollMode? skeletonShimmer? skeletonViews? staticType? style? styleKey? translation? verticalFocusAnimationType? viewportHeight? viewportWidth? viewStatus? visible? width?

    Properties

    audioGuideHint?: string
    audioGuideItem?: string | IAudioGuideItem
    canReceiveFocus?: boolean
    clippingRect?: [number, number, number, number]
    customData?: unknown
    dataSource?: CollectionViewDataSource.CollectionViewDataSource

    The data source for the collection view.

    floatingFocusAreaHeight?: number

    The height of the floating focus area.

    focusId?: string
    focusIndicatorAppearance?: ICollectionViewFocusIndicatorAppearance

    The appearance of the focus indicator.

    focusIndicatorTransitionType?: CollectionViewFocusIndicatorTransitionType

    Default transition used by the shared focus indicator.

    height?: number
    id?: string
    includeInLayout?: boolean
    isInitialFocus?: boolean
    isSkeleton?: boolean
    layoutSettledDelayMs?: number

    Delay in milliseconds before the layout-settled callback fires.

    layoutSettledVisibilityThreshold?: number

    Minimum visible area ratio required for settled layout entries.

    maskSettingsKey?: string
    nativeGlass?: SGNativeGlassEffect
    nextFocusMap?: ViewFocusMap
    onItemBlurring?: ViewEventHandler<CollectionViewEvent>

    Opt-in, per-frame handler for an item losing focus during horizontal motion.

    onItemFocus?: ViewEventHandler<CollectionViewEvent>

    Handler for item focus events.

    onItemFocusing?: ViewEventHandler<CollectionViewEvent>

    Opt-in, per-frame handler for an item gaining focus during horizontal motion.

    onItemLongPressSelected?: ViewEventHandler<CollectionViewEvent>

    Handler for item long press selected events.

    onItemSelected?: ViewEventHandler<CollectionViewEvent>

    Handler for item selected events.

    onLayoutSettled?: ViewEventHandler<CollectionViewLayoutSettledEvent>

    Handler for settled layout events.

    onOptionsKeyPressed?: ViewEventHandler<CollectionViewEvent>

    Handler for item options key pressed events.

    onRowFocus?: ViewEventHandler<CollectionViewEvent>

    Handler for row focus events.

    onSupplementarySelected?: ViewEventHandler<
        CollectionViewSupplementarySelectionEvent,
    >

    Handler for selected row supplementaries.

    opacity?: number
    pointerScrollSnapToFocus?: boolean

    When true, a pointer or native-scroll focus commit restores the focused item to its authored focus-rest position. Defaults to false so ordinary touch scrolling retains its free-scroll pixel offset.

    readingDirection?: ReadingDirection

    Default horizontal reading order inherited by rows.

    rotation?: number
    rowSpacing?: number

    Spacing between rows in the collection view.

    safeAreaBehavior?: CollectionViewSafeAreaBehavior

    Opt-in edge-to-edge drawing with interaction-safe focus/rest positions.

    scale?: [number, number]
    scaleRotateCenter?: [number, number]
    scrollablePositionX?: number
    scrollablePositionY?: number
    scrollInsets?: CollectionViewScrollInsets

    Additional vertical scroll extent around collection content.

    scrollMode?: CollectionViewScrollMode

    Vertical scroll engine ('auto' | 'js' | 'native'). See CollectionViewScrollMode.

    skeletonShimmer?: boolean
    skeletonViews?: ViewStruct<ViewState>[]
    staticType?: ViewStaticType
    style?: IStatefulStyle
    styleKey?: string
    translation?: number[]
    verticalFocusAnimationType?: VerticalFocusAnimationType

    The type of vertical focus animation.

    viewportHeight?: number

    The vertical viewport height used by virtualization and pointer/wheel scroll bounds.

    viewportWidth?: number

    Horizontal viewport width used by edge-to-edge focus boundaries.

    viewStatus?: ViewStatus
    visible?: boolean
    width?: number

    Settings

    Member Visibility

    On This Page

    Properties