geoview-core
    Preparing search index...

    Interface MRT_TablePaginationProps<TData>

    interface MRT_TablePaginationProps<TData extends MRT_RowData> {
        about?: string;
        accessKey?: string;
        "aria-activedescendant"?: string;
        "aria-atomic"?: Booleanish;
        "aria-autocomplete"?: "none" | "list" | "inline" | "both";
        "aria-braillelabel"?: string;
        "aria-brailleroledescription"?: string;
        "aria-busy"?: Booleanish;
        "aria-checked"?: boolean | "mixed" | "false" | "true";
        "aria-colcount"?: number;
        "aria-colindex"?: number;
        "aria-colindextext"?: string;
        "aria-colspan"?: number;
        "aria-controls"?: string;
        "aria-current"?:
            | boolean
            | "date"
            | "time"
            | "step"
            | "page"
            | "false"
            | "true"
            | "location";
        "aria-describedby"?: string;
        "aria-description"?: string;
        "aria-details"?: string;
        "aria-disabled"?: Booleanish;
        "aria-dropeffect"?: "none"
        | "link"
        | "copy"
        | "move"
        | "execute"
        | "popup";
        "aria-errormessage"?: string;
        "aria-expanded"?: Booleanish;
        "aria-flowto"?: string;
        "aria-grabbed"?: Booleanish;
        "aria-haspopup"?:
            | boolean
            | "dialog"
            | "menu"
            | "grid"
            | "listbox"
            | "false"
            | "true"
            | "tree";
        "aria-hidden"?: Booleanish;
        "aria-invalid"?: boolean
        | "false"
        | "true"
        | "grammar"
        | "spelling";
        "aria-keyshortcuts"?: string;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        "aria-level"?: number;
        "aria-live"?: "off" | "assertive" | "polite";
        "aria-modal"?: Booleanish;
        "aria-multiline"?: Booleanish;
        "aria-multiselectable"?: Booleanish;
        "aria-orientation"?: "horizontal" | "vertical";
        "aria-owns"?: string;
        "aria-placeholder"?: string;
        "aria-posinset"?: number;
        "aria-pressed"?: boolean | "mixed" | "false" | "true";
        "aria-readonly"?: Booleanish;
        "aria-relevant"?:
            | "text"
            | "all"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        "aria-required"?: Booleanish;
        "aria-roledescription"?: string;
        "aria-rowcount"?: number;
        "aria-rowindex"?: number;
        "aria-rowindextext"?: string;
        "aria-rowspan"?: number;
        "aria-selected"?: Booleanish;
        "aria-setsize"?: number;
        "aria-sort"?: "none"
        | "ascending"
        | "descending"
        | "other";
        "aria-valuemax"?: number;
        "aria-valuemin"?: number;
        "aria-valuenow"?: number;
        "aria-valuetext"?: string;
        autoCapitalize?:
            | "none"
            | string & {}
            | "off"
            | "on"
            | "sentences"
            | "words"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        boundaryCount?: number;
        classes?: Partial<PaginationClasses>;
        className?: string;
        color?: OverridableStringUnion<
            "primary"
            | "secondary"
            | "standard",
            PaginationPropsColorOverrides,
        >;
        componentName?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        count?: number;
        dangerouslySetInnerHTML?: { __html: string | TrustedHTML };
        datatype?: string;
        defaultChecked?: boolean;
        defaultPage?: number;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "enter"
            | "done"
            | "go"
            | "previous"
            | "send";
        exportparts?: string;
        getItemAriaLabel?: (
            type:
                | "page"
                | "first"
                | "last"
                | "next"
                | "previous"
                | "start-ellipsis"
                | "end-ellipsis",
            page: number | null,
            selected: boolean,
        ) => string;
        hidden?: boolean;
        hideNextButton?: boolean;
        hidePrevButton?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "none"
            | "search"
            | "text"
            | "tel"
            | "url"
            | "email"
            | "numeric"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLElement>;
        onAbortCapture?: ReactEventHandler<HTMLElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
        onAnimationStart?: AnimationEventHandler<HTMLElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
        onAuxClick?: MouseEventHandler<HTMLElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLElement>;
        onBeforeInput?: InputEventHandler<HTMLElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLElement>;
        onBlur?: FocusEventHandler<HTMLElement>;
        onBlurCapture?: FocusEventHandler<HTMLElement>;
        onCanPlay?: ReactEventHandler<HTMLElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
        onChange?: (event: ChangeEvent<unknown>, page: number) => void;
        onChangeCapture?: FormEventHandler<HTMLElement>;
        onClick?: MouseEventHandler<HTMLElement>;
        onClickCapture?: MouseEventHandler<HTMLElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
        onCompositionStart?: CompositionEventHandler<HTMLElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
        onContextMenu?: MouseEventHandler<HTMLElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLElement>;
        onCopy?: ClipboardEventHandler<HTMLElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLElement>;
        onCut?: ClipboardEventHandler<HTMLElement>;
        onCutCapture?: ClipboardEventHandler<HTMLElement>;
        onDoubleClick?: MouseEventHandler<HTMLElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
        onDrag?: DragEventHandler<HTMLElement>;
        onDragCapture?: DragEventHandler<HTMLElement>;
        onDragEnd?: DragEventHandler<HTMLElement>;
        onDragEndCapture?: DragEventHandler<HTMLElement>;
        onDragEnter?: DragEventHandler<HTMLElement>;
        onDragEnterCapture?: DragEventHandler<HTMLElement>;
        onDragExit?: DragEventHandler<HTMLElement>;
        onDragExitCapture?: DragEventHandler<HTMLElement>;
        onDragLeave?: DragEventHandler<HTMLElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLElement>;
        onDragOver?: DragEventHandler<HTMLElement>;
        onDragOverCapture?: DragEventHandler<HTMLElement>;
        onDragStart?: DragEventHandler<HTMLElement>;
        onDragStartCapture?: DragEventHandler<HTMLElement>;
        onDrop?: DragEventHandler<HTMLElement>;
        onDropCapture?: DragEventHandler<HTMLElement>;
        onDurationChange?: ReactEventHandler<HTMLElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
        onEmptied?: ReactEventHandler<HTMLElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLElement>;
        onEncrypted?: ReactEventHandler<HTMLElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLElement>;
        onEnded?: ReactEventHandler<HTMLElement>;
        onEndedCapture?: ReactEventHandler<HTMLElement>;
        onError?: ReactEventHandler<HTMLElement>;
        onErrorCapture?: ReactEventHandler<HTMLElement>;
        onFocus?: FocusEventHandler<HTMLElement>;
        onFocusCapture?: FocusEventHandler<HTMLElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
        onInput?: FormEventHandler<HTMLElement>;
        onInputCapture?: FormEventHandler<HTMLElement>;
        onInvalid?: FormEventHandler<HTMLElement>;
        onInvalidCapture?: FormEventHandler<HTMLElement>;
        onKeyDown?: KeyboardEventHandler<HTMLElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
        onKeyPress?: KeyboardEventHandler<HTMLElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
        onKeyUp?: KeyboardEventHandler<HTMLElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
        onLoad?: ReactEventHandler<HTMLElement>;
        onLoadCapture?: ReactEventHandler<HTMLElement>;
        onLoadedData?: ReactEventHandler<HTMLElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
        onLoadStart?: ReactEventHandler<HTMLElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
        onMouseDown?: MouseEventHandler<HTMLElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLElement>;
        onMouseEnter?: MouseEventHandler<HTMLElement>;
        onMouseLeave?: MouseEventHandler<HTMLElement>;
        onMouseMove?: MouseEventHandler<HTMLElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
        onMouseOut?: MouseEventHandler<HTMLElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLElement>;
        onMouseOver?: MouseEventHandler<HTMLElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLElement>;
        onMouseUp?: MouseEventHandler<HTMLElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLElement>;
        onPaste?: ClipboardEventHandler<HTMLElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLElement>;
        onPause?: ReactEventHandler<HTMLElement>;
        onPauseCapture?: ReactEventHandler<HTMLElement>;
        onPlay?: ReactEventHandler<HTMLElement>;
        onPlayCapture?: ReactEventHandler<HTMLElement>;
        onPlaying?: ReactEventHandler<HTMLElement>;
        onPlayingCapture?: ReactEventHandler<HTMLElement>;
        onPointerCancel?: PointerEventHandler<HTMLElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
        onPointerDown?: PointerEventHandler<HTMLElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLElement>;
        onPointerEnter?: PointerEventHandler<HTMLElement>;
        onPointerLeave?: PointerEventHandler<HTMLElement>;
        onPointerMove?: PointerEventHandler<HTMLElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
        onPointerOut?: PointerEventHandler<HTMLElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLElement>;
        onPointerOver?: PointerEventHandler<HTMLElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLElement>;
        onPointerUp?: PointerEventHandler<HTMLElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLElement>;
        onProgress?: ReactEventHandler<HTMLElement>;
        onProgressCapture?: ReactEventHandler<HTMLElement>;
        onRateChange?: ReactEventHandler<HTMLElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLElement>;
        onReset?: FormEventHandler<HTMLElement>;
        onResetCapture?: FormEventHandler<HTMLElement>;
        onScroll?: UIEventHandler<HTMLElement>;
        onScrollCapture?: UIEventHandler<HTMLElement>;
        onSeeked?: ReactEventHandler<HTMLElement>;
        onSeekedCapture?: ReactEventHandler<HTMLElement>;
        onSeeking?: ReactEventHandler<HTMLElement>;
        onSeekingCapture?: ReactEventHandler<HTMLElement>;
        onSelect?: ReactEventHandler<HTMLElement>;
        onSelectCapture?: ReactEventHandler<HTMLElement>;
        onStalled?: ReactEventHandler<HTMLElement>;
        onStalledCapture?: ReactEventHandler<HTMLElement>;
        onSubmit?: FormEventHandler<HTMLElement>;
        onSubmitCapture?: FormEventHandler<HTMLElement>;
        onSuspend?: ReactEventHandler<HTMLElement>;
        onSuspendCapture?: ReactEventHandler<HTMLElement>;
        onTimeUpdate?: ReactEventHandler<HTMLElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
        onTouchCancel?: TouchEventHandler<HTMLElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
        onTouchEnd?: TouchEventHandler<HTMLElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLElement>;
        onTouchMove?: TouchEventHandler<HTMLElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
        onTouchStart?: TouchEventHandler<HTMLElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
        onVolumeChange?: ReactEventHandler<HTMLElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
        onWaiting?: ReactEventHandler<HTMLElement>;
        onWaitingCapture?: ReactEventHandler<HTMLElement>;
        onWheel?: WheelEventHandler<HTMLElement>;
        onWheelCapture?: WheelEventHandler<HTMLElement>;
        page?: number;
        part?: string;
        position?: "bottom" | "top";
        prefix?: string;
        property?: string;
        radioGroup?: string;
        ref?: Ref<unknown>;
        rel?: string;
        renderItem?: (params: PaginationRenderItemParams) => ReactNode;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        rowsPerPageOptions?: number[] | { label: string; value: number }[];
        security?: string;
        SelectProps?: Partial<SelectProps>;
        shape?: "circular" | "rounded";
        showFirstButton?: boolean;
        showLastButton?: boolean;
        showRowsPerPage?: boolean;
        siblingCount?: number;
        size?: OverridableStringUnion<
            "small"
            | "large"
            | "medium",
            PaginationPropsSizeOverrides,
        >;
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        sx?: SxProps<Theme>;
        tabIndex?: number;
        table: MRT_TableInstance<TData>;
        title?: string;
        translate?: "yes" | "no";
        typeof?: string;
        unselectable?: "off" | "on";
        variant?: OverridableStringUnion<
            "text"
            | "outlined",
            PaginationPropsVariantOverrides,
        >;
        vocab?: string;
    }

    Type Parameters

    Hierarchy

    • Partial<
          PaginationProps & {
              disabled?: boolean;
              rowsPerPageOptions?: { label: string; value: number }[]
              | number[];
              SelectProps?: Partial<SelectProps>;
              showRowsPerPage?: boolean;
          },
      >
      • MRT_TablePaginationProps
    Index

    Properties

    about? accessKey? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoCorrect? autoFocus? autoSave? boundaryCount? classes? className? color? componentName? content? contentEditable? contextMenu? count? dangerouslySetInnerHTML? datatype? defaultChecked? defaultPage? defaultValue? dir? disabled? draggable? enterKeyHint? exportparts? getItemAriaLabel? hidden? hideNextButton? hidePrevButton? id? inlist? inputMode? is? itemID? itemProp? itemRef? itemScope? itemType? lang? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? page? part? position? prefix? property? radioGroup? ref? rel? renderItem? resource? results? rev? role? rowsPerPageOptions? security? SelectProps? shape? showFirstButton? showLastButton? showRowsPerPage? siblingCount? size? slot? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? sx? tabIndex? table title? translate? typeof? unselectable? variant? vocab?

    Properties

    about?: string
    accessKey?: string
    "aria-activedescendant"?: string

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    "aria-atomic"?: Booleanish

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    "aria-autocomplete"?: "none" | "list" | "inline" | "both"

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

    "aria-braillelabel"?: string

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    aria-label.

    "aria-brailleroledescription"?: string

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    aria-roledescription.

    "aria-busy"?: Booleanish
    "aria-checked"?: boolean | "mixed" | "false" | "true"

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    • aria-pressed
    • aria-selected.
    "aria-colcount"?: number

    Defines the total number of columns in a table, grid, or treegrid.

    aria-colindex.

    "aria-colindex"?: number

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    • aria-colcount
    • aria-colspan.
    "aria-colindextext"?: string

    Defines a human readable text alternative of aria-colindex.

    aria-rowindextext.

    "aria-colspan"?: number

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    • aria-colindex
    • aria-rowspan.
    "aria-controls"?: string

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    aria-owns.

    "aria-current"?:
        | boolean
        | "date"
        | "time"
        | "step"
        | "page"
        | "false"
        | "true"
        | "location"

    Indicates the element that represents the current item within a container or set of related elements.

    "aria-describedby"?: string

    Identifies the element (or elements) that describes the object.

    aria-labelledby

    "aria-description"?: string

    Defines a string value that describes or annotates the current element.

    related aria-describedby.

    "aria-details"?: string

    Identifies the element that provides a detailed, extended description for the object.

    aria-describedby.

    "aria-disabled"?: Booleanish

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    • aria-hidden
    • aria-readonly.
    "aria-dropeffect"?: "none" | "link" | "copy" | "move" | "execute" | "popup"

    Indicates what functions can be performed when a dragged object is released on the drop target.

    in ARIA 1.1

    "aria-errormessage"?: string

    Identifies the element that provides an error message for the object.

    • aria-invalid
    • aria-describedby.
    "aria-expanded"?: Booleanish

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    "aria-flowto"?: string

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

    "aria-grabbed"?: Booleanish

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    in ARIA 1.1

    "aria-haspopup"?:
        | boolean
        | "dialog"
        | "menu"
        | "grid"
        | "listbox"
        | "false"
        | "true"
        | "tree"

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    "aria-hidden"?: Booleanish

    Indicates whether the element is exposed to an accessibility API.

    aria-disabled.

    "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling"

    Indicates the entered value does not conform to the format expected by the application.

    aria-errormessage.

    "aria-keyshortcuts"?: string

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    "aria-label"?: string

    Defines a string value that labels the current element.

    aria-labelledby.

    "aria-labelledby"?: string

    Identifies the element (or elements) that labels the current element.

    aria-describedby.

    "aria-level"?: number

    Defines the hierarchical level of an element within a structure.

    "aria-live"?: "off" | "assertive" | "polite"

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    "aria-modal"?: Booleanish

    Indicates whether an element is modal when displayed.

    "aria-multiline"?: Booleanish

    Indicates whether a text box accepts multiple lines of input or only a single line.

    "aria-multiselectable"?: Booleanish

    Indicates that the user may select more than one item from the current selectable descendants.

    "aria-orientation"?: "horizontal" | "vertical"

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    "aria-owns"?: string

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    aria-controls.

    "aria-placeholder"?: string

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

    "aria-posinset"?: number

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    aria-setsize.

    "aria-pressed"?: boolean | "mixed" | "false" | "true"

    Indicates the current "pressed" state of toggle buttons.

    • aria-checked
    • aria-selected.
    "aria-readonly"?: Booleanish

    Indicates that the element is not editable, but is otherwise operable.

    aria-disabled.

    "aria-relevant"?:
        | "text"
        | "all"
        | "additions"
        | "additions removals"
        | "additions text"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals"

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    aria-atomic.

    "aria-required"?: Booleanish

    Indicates that user input is required on the element before a form may be submitted.

    "aria-roledescription"?: string

    Defines a human-readable, author-localized description for the role of an element.

    "aria-rowcount"?: number

    Defines the total number of rows in a table, grid, or treegrid.

    aria-rowindex.

    "aria-rowindex"?: number

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    • aria-rowcount
    • aria-rowspan.
    "aria-rowindextext"?: string

    Defines a human readable text alternative of aria-rowindex.

    aria-colindextext.

    "aria-rowspan"?: number

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    • aria-rowindex
    • aria-colspan.
    "aria-selected"?: Booleanish

    Indicates the current "selected" state of various widgets.

    • aria-checked
    • aria-pressed.
    "aria-setsize"?: number

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    aria-posinset.

    "aria-sort"?: "none" | "ascending" | "descending" | "other"

    Indicates if items in a table or grid are sorted in ascending or descending order.

    "aria-valuemax"?: number

    Defines the maximum allowed value for a range widget.

    "aria-valuemin"?: number

    Defines the minimum allowed value for a range widget.

    "aria-valuenow"?: number

    Defines the current value for a range widget.

    aria-valuetext.

    "aria-valuetext"?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    autoCapitalize?:
        | "none"
        | string & {}
        | "off"
        | "on"
        | "sentences"
        | "words"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    boundaryCount?: number

    Number of always visible pages at the beginning and end.

    1
    
    classes?: Partial<PaginationClasses>

    Override or extend the styles applied to the component.

    className?: string
    color?: OverridableStringUnion<
        "primary"
        | "secondary"
        | "standard",
        PaginationPropsColorOverrides,
    >

    The active color. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

    'standard'
    
    componentName?: string

    The name of the component where this hook is used.

    content?: string
    contentEditable?: "inherit" | Booleanish | "plaintext-only"
    contextMenu?: string
    count?: number

    The total number of pages.

    1
    
    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }
    datatype?: string
    defaultChecked?: boolean
    defaultPage?: number

    The page selected by default when the component is uncontrolled.

    1
    
    defaultValue?: string | number | readonly string[]
    dir?: string
    disabled?: boolean

    If true, the component is disabled.

    false
    
    draggable?: Booleanish
    enterKeyHint?: "search" | "next" | "enter" | "done" | "go" | "previous" | "send"
    exportparts?: string
    getItemAriaLabel?: (
        type:
            | "page"
            | "first"
            | "last"
            | "next"
            | "previous"
            | "start-ellipsis"
            | "end-ellipsis",
        page: number | null,
        selected: boolean,
    ) => string

    Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.

    For localization purposes, you can use the provided translations.

    Type Declaration

      • (
            type:
                | "page"
                | "first"
                | "last"
                | "next"
                | "previous"
                | "start-ellipsis"
                | "end-ellipsis",
            page: number | null,
            selected: boolean,
        ): string
      • Parameters

        • type:
              | "page"
              | "first"
              | "last"
              | "next"
              | "previous"
              | "start-ellipsis"
              | "end-ellipsis"

          The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'.

        • page: number | null

          The page number to format.

        • selected: boolean

          If true, the current page is selected.

        Returns string

    hidden?: boolean
    hideNextButton?: boolean

    If true, hide the next-page button.

    false
    
    hidePrevButton?: boolean

    If true, hide the previous-page button.

    false
    
    id?: string
    inlist?: any
    inputMode?:
        | "none"
        | "search"
        | "text"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    itemID?: string
    itemProp?: string
    itemRef?: string
    itemScope?: boolean
    itemType?: string
    lang?: string
    nonce?: string
    onAbort?: ReactEventHandler<HTMLElement>
    onAbortCapture?: ReactEventHandler<HTMLElement>
    onAnimationEnd?: AnimationEventHandler<HTMLElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
    onAnimationIteration?: AnimationEventHandler<HTMLElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
    onAnimationStart?: AnimationEventHandler<HTMLElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
    onAuxClick?: MouseEventHandler<HTMLElement>
    onAuxClickCapture?: MouseEventHandler<HTMLElement>
    onBeforeInput?: InputEventHandler<HTMLElement>
    onBeforeInputCapture?: FormEventHandler<HTMLElement>
    onBlur?: FocusEventHandler<HTMLElement>
    onBlurCapture?: FocusEventHandler<HTMLElement>
    onCanPlay?: ReactEventHandler<HTMLElement>
    onCanPlayCapture?: ReactEventHandler<HTMLElement>
    onCanPlayThrough?: ReactEventHandler<HTMLElement>
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
    onChange?: (event: ChangeEvent<unknown>, page: number) => void

    Callback fired when the page is changed.

    Type Declaration

      • (event: ChangeEvent<unknown>, page: number): void
      • Parameters

        • event: ChangeEvent<unknown>

          The event source of the callback.

        • page: number

          The page selected.

        Returns void

    onChangeCapture?: FormEventHandler<HTMLElement>
    onClick?: MouseEventHandler<HTMLElement>
    onClickCapture?: MouseEventHandler<HTMLElement>
    onCompositionEnd?: CompositionEventHandler<HTMLElement>
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
    onCompositionStart?: CompositionEventHandler<HTMLElement>
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
    onContextMenu?: MouseEventHandler<HTMLElement>
    onContextMenuCapture?: MouseEventHandler<HTMLElement>
    onCopy?: ClipboardEventHandler<HTMLElement>
    onCopyCapture?: ClipboardEventHandler<HTMLElement>
    onCut?: ClipboardEventHandler<HTMLElement>
    onCutCapture?: ClipboardEventHandler<HTMLElement>
    onDoubleClick?: MouseEventHandler<HTMLElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>
    onDrag?: DragEventHandler<HTMLElement>
    onDragCapture?: DragEventHandler<HTMLElement>
    onDragEnd?: DragEventHandler<HTMLElement>
    onDragEndCapture?: DragEventHandler<HTMLElement>
    onDragEnter?: DragEventHandler<HTMLElement>
    onDragEnterCapture?: DragEventHandler<HTMLElement>
    onDragExit?: DragEventHandler<HTMLElement>
    onDragExitCapture?: DragEventHandler<HTMLElement>
    onDragLeave?: DragEventHandler<HTMLElement>
    onDragLeaveCapture?: DragEventHandler<HTMLElement>
    onDragOver?: DragEventHandler<HTMLElement>
    onDragOverCapture?: DragEventHandler<HTMLElement>
    onDragStart?: DragEventHandler<HTMLElement>
    onDragStartCapture?: DragEventHandler<HTMLElement>
    onDrop?: DragEventHandler<HTMLElement>
    onDropCapture?: DragEventHandler<HTMLElement>
    onDurationChange?: ReactEventHandler<HTMLElement>
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>
    onEmptied?: ReactEventHandler<HTMLElement>
    onEmptiedCapture?: ReactEventHandler<HTMLElement>
    onEncrypted?: ReactEventHandler<HTMLElement>
    onEncryptedCapture?: ReactEventHandler<HTMLElement>
    onEnded?: ReactEventHandler<HTMLElement>
    onEndedCapture?: ReactEventHandler<HTMLElement>
    onError?: ReactEventHandler<HTMLElement>
    onErrorCapture?: ReactEventHandler<HTMLElement>
    onFocus?: FocusEventHandler<HTMLElement>
    onFocusCapture?: FocusEventHandler<HTMLElement>
    onGotPointerCapture?: PointerEventHandler<HTMLElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
    onInput?: FormEventHandler<HTMLElement>
    onInputCapture?: FormEventHandler<HTMLElement>
    onInvalid?: FormEventHandler<HTMLElement>
    onInvalidCapture?: FormEventHandler<HTMLElement>
    onKeyDown?: KeyboardEventHandler<HTMLElement>
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
    onKeyPress?: KeyboardEventHandler<HTMLElement>

    Use onKeyUp or onKeyDown instead

    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

    Use onKeyUpCapture or onKeyDownCapture instead

    onKeyUp?: KeyboardEventHandler<HTMLElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
    onLoad?: ReactEventHandler<HTMLElement>
    onLoadCapture?: ReactEventHandler<HTMLElement>
    onLoadedData?: ReactEventHandler<HTMLElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>
    onLoadedMetadata?: ReactEventHandler<HTMLElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>
    onLoadStart?: ReactEventHandler<HTMLElement>
    onLoadStartCapture?: ReactEventHandler<HTMLElement>
    onLostPointerCapture?: PointerEventHandler<HTMLElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
    onMouseDown?: MouseEventHandler<HTMLElement>
    onMouseDownCapture?: MouseEventHandler<HTMLElement>
    onMouseEnter?: MouseEventHandler<HTMLElement>
    onMouseLeave?: MouseEventHandler<HTMLElement>
    onMouseMove?: MouseEventHandler<HTMLElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>
    onMouseOut?: MouseEventHandler<HTMLElement>
    onMouseOutCapture?: MouseEventHandler<HTMLElement>
    onMouseOver?: MouseEventHandler<HTMLElement>
    onMouseOverCapture?: MouseEventHandler<HTMLElement>
    onMouseUp?: MouseEventHandler<HTMLElement>
    onMouseUpCapture?: MouseEventHandler<HTMLElement>
    onPaste?: ClipboardEventHandler<HTMLElement>
    onPasteCapture?: ClipboardEventHandler<HTMLElement>
    onPause?: ReactEventHandler<HTMLElement>
    onPauseCapture?: ReactEventHandler<HTMLElement>
    onPlay?: ReactEventHandler<HTMLElement>
    onPlayCapture?: ReactEventHandler<HTMLElement>
    onPlaying?: ReactEventHandler<HTMLElement>
    onPlayingCapture?: ReactEventHandler<HTMLElement>
    onPointerCancel?: PointerEventHandler<HTMLElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>
    onPointerDown?: PointerEventHandler<HTMLElement>
    onPointerDownCapture?: PointerEventHandler<HTMLElement>
    onPointerEnter?: PointerEventHandler<HTMLElement>
    onPointerLeave?: PointerEventHandler<HTMLElement>
    onPointerMove?: PointerEventHandler<HTMLElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>
    onPointerOut?: PointerEventHandler<HTMLElement>
    onPointerOutCapture?: PointerEventHandler<HTMLElement>
    onPointerOver?: PointerEventHandler<HTMLElement>
    onPointerOverCapture?: PointerEventHandler<HTMLElement>
    onPointerUp?: PointerEventHandler<HTMLElement>
    onPointerUpCapture?: PointerEventHandler<HTMLElement>
    onProgress?: ReactEventHandler<HTMLElement>
    onProgressCapture?: ReactEventHandler<HTMLElement>
    onRateChange?: ReactEventHandler<HTMLElement>
    onRateChangeCapture?: ReactEventHandler<HTMLElement>
    onReset?: FormEventHandler<HTMLElement>
    onResetCapture?: FormEventHandler<HTMLElement>
    onScroll?: UIEventHandler<HTMLElement>
    onScrollCapture?: UIEventHandler<HTMLElement>
    onSeeked?: ReactEventHandler<HTMLElement>
    onSeekedCapture?: ReactEventHandler<HTMLElement>
    onSeeking?: ReactEventHandler<HTMLElement>
    onSeekingCapture?: ReactEventHandler<HTMLElement>
    onSelect?: ReactEventHandler<HTMLElement>
    onSelectCapture?: ReactEventHandler<HTMLElement>
    onStalled?: ReactEventHandler<HTMLElement>
    onStalledCapture?: ReactEventHandler<HTMLElement>
    onSubmit?: FormEventHandler<HTMLElement>
    onSubmitCapture?: FormEventHandler<HTMLElement>
    onSuspend?: ReactEventHandler<HTMLElement>
    onSuspendCapture?: ReactEventHandler<HTMLElement>
    onTimeUpdate?: ReactEventHandler<HTMLElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>
    onTouchCancel?: TouchEventHandler<HTMLElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>
    onTouchEnd?: TouchEventHandler<HTMLElement>
    onTouchEndCapture?: TouchEventHandler<HTMLElement>
    onTouchMove?: TouchEventHandler<HTMLElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>
    onTouchStart?: TouchEventHandler<HTMLElement>
    onTouchStartCapture?: TouchEventHandler<HTMLElement>
    onTransitionEnd?: TransitionEventHandler<HTMLElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
    onVolumeChange?: ReactEventHandler<HTMLElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
    onWaiting?: ReactEventHandler<HTMLElement>
    onWaitingCapture?: ReactEventHandler<HTMLElement>
    onWheel?: WheelEventHandler<HTMLElement>
    onWheelCapture?: WheelEventHandler<HTMLElement>
    page?: number

    The current page. Unlike TablePagination, which starts numbering from 0, this pagination starts from 1.

    part?: string
    position?: "bottom" | "top"
    prefix?: string
    property?: string
    radioGroup?: string
    ref?: Ref<unknown>
    rel?: string
    renderItem?: (params: PaginationRenderItemParams) => ReactNode

    Render the item.

    Type Declaration

      • (params: PaginationRenderItemParams): ReactNode
      • Parameters

        • params: PaginationRenderItemParams

          The props to spread on a PaginationItem.

        Returns ReactNode

    (item) => <PaginationItem {...item} />
    
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    rowsPerPageOptions?: number[] | { label: string; value: number }[]
    security?: string
    SelectProps?: Partial<SelectProps>
    shape?: "circular" | "rounded"

    The shape of the pagination items.

    'circular'
    
    showFirstButton?: boolean

    If true, show the first-page button.

    false
    
    showLastButton?: boolean

    If true, show the last-page button.

    false
    
    showRowsPerPage?: boolean
    siblingCount?: number

    Number of always visible pages before and after the current page.

    1
    
    size?: OverridableStringUnion<
        "small"
        | "large"
        | "medium",
        PaginationPropsSizeOverrides,
    >

    The size of the component.

    'medium'
    
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    sx?: SxProps<Theme>

    The system prop that allows defining system overrides as well as additional CSS styles.

    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    typeof?: string
    unselectable?: "off" | "on"
    variant?: OverridableStringUnion<
        "text"
        | "outlined",
        PaginationPropsVariantOverrides,
    >

    The variant to use.

    'text'
    
    vocab?: string