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

    Interface ICollectionViewHeaderSettings

    Interface for header settings in a collection view row.

    interface ICollectionViewHeaderSettings {
        backgroundColor?: string;
        backgroundOpacity?: number;
        backgroundVisible?: boolean;
        fontKey?: string;
        headerAppearance?: "none" | "onTop" | "underneath";
        headerClass?: string;
        headerComponent?: string;
        height?: number;
        isFocusable?: boolean;
        labelOffset?: [number, number];
        positionOffset?: [number, number];
        presentationUpdateMode?: CollectionViewSupplementaryPresentationUpdateMode;
        textColor?: string;
    }
    Index

    Properties

    backgroundColor? backgroundOpacity? backgroundVisible? fontKey? headerAppearance? headerClass? headerComponent? height? isFocusable? labelOffset? positionOffset? presentationUpdateMode? textColor?

    Properties

    backgroundColor?: string

    Header background color.

    backgroundOpacity?: number

    Header background opacity.

    backgroundVisible?: boolean

    Visibility of the header background.

    fontKey?: string

    Font key for header label.

    headerAppearance?: "none" | "onTop" | "underneath"

    Appearance of the header ('none', 'onTop', 'underneath').

    headerClass?: string

    Header class name.

    headerComponent?: string

    Component key for component-based headers (references headerComponents in style config).

    height?: number

    Height of the header.

    isFocusable?: boolean

    Opts a custom header supplementary into CollectionView-owned focus and selection.

    labelOffset?: [number, number]

    Offset for label position within header.

    positionOffset?: [number, number]

    Offset position of the header.

    presentationUpdateMode?: CollectionViewSupplementaryPresentationUpdateMode

    Controls whether the header controller receives scroll-position changes.

    textColor?: string

    Text color for header label.

    Settings

    Member Visibility

    On This Page

    Properties