Hex Core JS
    Preparing search index...

    Type Alias PageButtonsSetProps

    PageButtonsSetProps: {
        activeButtonProps?: PageButtonProps;
        allowWrap?: boolean;
        buttonProps?: PageButtonProps;
        disabled?: boolean;
        iconsClassName?: string;
        onNavigate?: () => void;
        pageGroupingOptions?: PageGroupingOptions;
        pageGroupingSeparatorIconClassName?: string;
        pageNumber: number;
        relativeButtonIconsClassName?: string;
        relativeButtonProps?: PageButtonProps;
        setPageNumber: (n: number) => void;
        totalPages: number;
    } & Partial<ClassNameProps>

    Type Declaration

    • OptionalactiveButtonProps?: PageButtonProps

      Custom props passed to the active page button.

    • OptionalallowWrap?: boolean

      Indicates whether the next/previous buttons should wrap around when on the last/first page.

    • OptionalbuttonProps?: PageButtonProps

      Custom props passed to all buttons.

    • Optionaldisabled?: boolean

      Indicates whether all buttons should be disabled.

    • OptionaliconsClassName?: string

      CSS class to apply to all icons.

    • OptionalonNavigate?: () => void

      A callback function that is called when a button is clicked (and the page number is updated).

    • OptionalpageGroupingOptions?: PageGroupingOptions

      Options for selecting the page button groupings.

    • OptionalpageGroupingSeparatorIconClassName?: string

      CSS class to apply to the separator icons (horizontal dots) between page groups.

    • pageNumber: number

      The current page number (zero-indexed).

    • OptionalrelativeButtonIconsClassName?: string

      CSS class to apply to icons on relative (back/forward) page buttons.

    • OptionalrelativeButtonProps?: PageButtonProps

      Custom props passed to the next and previous buttons.

    • setPageNumber: (n: number) => void

      A callback to update the page number.

    • totalPages: number

      The total number of pages available.

    Settings

    Member Visibility