kotlin-mui-material/mui.material/PaginationProps

PaginationProps

external interface PaginationProps : UsePaginationProps, StandardProps, HTMLAttributes<HTMLElement> , PropsWithSx(source)

Properties

about

abstract var about: String?

accessKey

abstract var accessKey: String?

ariaActiveDescendant

abstract var ariaActiveDescendant: String?

ariaAtomic

abstract var ariaAtomic: Boolean?

ariaAutoComplete

abstract var ariaAutoComplete: AriaAutoComplete?

ariaBrailleLabel

abstract var ariaBrailleLabel: String?

ariaBrailleRoleDescription

abstract var ariaBrailleRoleDescription: String?

ariaBusy

abstract var ariaBusy: Boolean?

ariaChecked

abstract var ariaChecked: AriaChecked?

ariaColCount

abstract var ariaColCount: Int?

ariaColIndex

abstract var ariaColIndex: Int?

ariaColIndexText

abstract var ariaColIndexText: String?

ariaColSpan

abstract var ariaColSpan: Int?

ariaControls

abstract var ariaControls: String?

ariaCurrent

abstract var ariaCurrent: AriaCurrent?

ariaDescribedBy

abstract var ariaDescribedBy: String?

ariaDescription

abstract var ariaDescription: String?

ariaDetails

abstract var ariaDetails: String?

ariaDisabled

abstract var ariaDisabled: Boolean?

ariaDropEffect

abstract var ariaDropEffect: AriaDropEffect?

ariaErrorMessage

abstract var ariaErrorMessage: String?

ariaExpanded

abstract var ariaExpanded: Boolean?

ariaFlowTo

abstract var ariaFlowTo: String?

ariaGrabbed

abstract var ariaGrabbed: Boolean?

ariaHasPopup

abstract var ariaHasPopup: AriaHasPopup?

ariaHidden

abstract var ariaHidden: Boolean?

ariaInvalid

abstract var ariaInvalid: AriaInvalid?

ariaKeyShortcuts

abstract var ariaKeyShortcuts: String?

ariaLabel

abstract var ariaLabel: String?

ariaLabelledBy

abstract var ariaLabelledBy: String?

ariaLevel

abstract var ariaLevel: Int?

ariaLive

abstract var ariaLive: AriaLive?

ariaModal

abstract var ariaModal: Boolean?

ariaMultiline

abstract var ariaMultiline: Boolean?

ariaMultiSelectable

abstract var ariaMultiSelectable: Boolean?

ariaOrientation

abstract var ariaOrientation: AriaOrientation?

ariaOwns

abstract var ariaOwns: String?

ariaPlaceholder

abstract var ariaPlaceholder: String?

ariaPosInSet

abstract var ariaPosInSet: Int?

ariaPressed

abstract var ariaPressed: AriaPressed?

ariaReadOnly

abstract var ariaReadOnly: Boolean?

ariaRelevant

abstract var ariaRelevant: AriaRelevant?

ariaRequired

abstract var ariaRequired: Boolean?

ariaRoleDescription

abstract var ariaRoleDescription: String?

ariaRowCount

abstract var ariaRowCount: Int?

ariaRowIndex

abstract var ariaRowIndex: Int?

ariaRowIndexText

abstract var ariaRowIndexText: String?

ariaRowSpan

abstract var ariaRowSpan: Int?

ariaSelected

abstract var ariaSelected: Boolean?

ariaSetSize

abstract var ariaSetSize: Int?

ariaSort

abstract var ariaSort: AriaSort?

ariaValueMax

abstract var ariaValueMax: Double?

ariaValueMin

abstract var ariaValueMin: Double?

ariaValueNow

abstract var ariaValueNow: Double?

ariaValueText

abstract var ariaValueText: String?

autoCapitalize

abstract var autoCapitalize: AutoCapitalize?

autoCorrect

abstract var autoCorrect: String?

autoFocus

abstract var autoFocus: Boolean?

autoSave

abstract var autoSave: String?

boundaryCount

abstract var boundaryCount: Number?

Number of always visible pages at the beginning and end.

children

abstract var children: ReactNode?

classes

abstract var classes: PaginationClasses?

Override or extend the styles applied to the component.

className

abstract var className: ClassName?

color

abstract var color: PaginationColor?

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

componentName

abstract var componentName: String?

The name of the component where this hook is used.

content

abstract var content: String?

contentEditable

abstract var contentEditable: Any?

contextMenu

abstract var contextMenu: String?

count

abstract var count: Number?

The total number of pages.

dangerouslySetInnerHTML

abstract var dangerouslySetInnerHTML: DangerouslySetInnerHTML?

datatype

abstract var datatype: String?

defaultChecked

abstract var defaultChecked: Boolean?

defaultPage

abstract var defaultPage: Number?

The page selected by default when the component is uncontrolled.

defaultValue

abstract var defaultValue: Any?

dir

abstract var dir: String?

disabled

abstract var disabled: Boolean?

If true, the component is disabled.

draggable

abstract var draggable: Boolean?

enterKeyHint

abstract var enterKeyHint: EnterKeyHint?

getItemAriaLabel

abstract var getItemAriaLabel: (Union, page: Number, 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.

hidden

abstract var hidden: Boolean?

hideNextButton

abstract var hideNextButton: Boolean?

If true, hide the next-page button.

hidePrevButton

abstract var hidePrevButton: Boolean?

If true, hide the previous-page button.

abstract var id: String?

inlist

abstract var inlist: Any?

inputMode

abstract var inputMode: InputMode?

abstract var is: String?

itemID

abstract var itemID: String?

itemProp

abstract var itemProp: String?

itemRef

abstract var itemRef: String?

itemScope

abstract var itemScope: Boolean?

itemType

abstract var itemType: String?

key

abstract var key: Key?

lang

abstract var lang: String?

nonce

abstract var nonce: String?

onAbort

abstract var onAbort: ReactEventHandler<HTMLElement>?

onAbortCapture

abstract var onAbortCapture: ReactEventHandler<HTMLElement>?

onAnimationEnd

abstract var onAnimationEnd: AnimationEventHandler<HTMLElement>?

onAnimationEndCapture

abstract var onAnimationEndCapture: AnimationEventHandler<HTMLElement>?

onAnimationIteration

abstract var onAnimationIteration: AnimationEventHandler<HTMLElement>?

onAnimationIterationCapture

abstract var onAnimationIterationCapture: AnimationEventHandler<HTMLElement>?

onAnimationStart

abstract var onAnimationStart: AnimationEventHandler<HTMLElement>?

onAnimationStartCapture

abstract var onAnimationStartCapture: AnimationEventHandler<HTMLElement>?

onAuxClick

abstract var onAuxClick: MouseEventHandler<HTMLElement>?

onAuxClickCapture

abstract var onAuxClickCapture: MouseEventHandler<HTMLElement>?

onBeforeInput

abstract var onBeforeInput: FormEventHandler<HTMLElement>?

onBeforeInputCapture

abstract var onBeforeInputCapture: FormEventHandler<HTMLElement>?

onBlur

abstract var onBlur: FocusEventHandler<HTMLElement>?

onBlurCapture

abstract var onBlurCapture: FocusEventHandler<HTMLElement>?

onCanPlay

abstract var onCanPlay: ReactEventHandler<HTMLElement>?

onCanPlayCapture

abstract var onCanPlayCapture: ReactEventHandler<HTMLElement>?

onCanPlayThrough

abstract var onCanPlayThrough: ReactEventHandler<HTMLElement>?

onCanPlayThroughCapture

abstract var onCanPlayThroughCapture: ReactEventHandler<HTMLElement>?

onChange

abstract var onChange: (event: ChangeEvent<*>, page: Number) -> Unit?

Callback fired when the page is changed.

onChangeCapture

abstract var onChangeCapture: FormEventHandler<HTMLElement>?

onClick

abstract var onClick: MouseEventHandler<HTMLElement>?

onClickCapture

abstract var onClickCapture: MouseEventHandler<HTMLElement>?

onCompositionEnd

abstract var onCompositionEnd: CompositionEventHandler<HTMLElement>?

onCompositionEndCapture

abstract var onCompositionEndCapture: CompositionEventHandler<HTMLElement>?

onCompositionStart

abstract var onCompositionStart: CompositionEventHandler<HTMLElement>?

onCompositionStartCapture

abstract var onCompositionStartCapture: CompositionEventHandler<HTMLElement>?

onCompositionUpdate

abstract var onCompositionUpdate: CompositionEventHandler<HTMLElement>?

onCompositionUpdateCapture

abstract var onCompositionUpdateCapture: CompositionEventHandler<HTMLElement>?

onContextMenu

abstract var onContextMenu: MouseEventHandler<HTMLElement>?

onContextMenuCapture

abstract var onContextMenuCapture: MouseEventHandler<HTMLElement>?

onCopy

abstract var onCopy: ClipboardEventHandler<HTMLElement>?

onCopyCapture

abstract var onCopyCapture: ClipboardEventHandler<HTMLElement>?

onCut

abstract var onCut: ClipboardEventHandler<HTMLElement>?

onCutCapture

abstract var onCutCapture: ClipboardEventHandler<HTMLElement>?

onDoubleClick

abstract var onDoubleClick: MouseEventHandler<HTMLElement>?

onDoubleClickCapture

abstract var onDoubleClickCapture: MouseEventHandler<HTMLElement>?

onDrag

abstract var onDrag: DragEventHandler<HTMLElement>?

onDragCapture

abstract var onDragCapture: DragEventHandler<HTMLElement>?

onDragEnd

abstract var onDragEnd: DragEventHandler<HTMLElement>?

onDragEndCapture

abstract var onDragEndCapture: DragEventHandler<HTMLElement>?

onDragEnter

abstract var onDragEnter: DragEventHandler<HTMLElement>?

onDragEnterCapture

abstract var onDragEnterCapture: DragEventHandler<HTMLElement>?

onDragExit

abstract var onDragExit: DragEventHandler<HTMLElement>?

onDragExitCapture

abstract var onDragExitCapture: DragEventHandler<HTMLElement>?

onDragLeave

abstract var onDragLeave: DragEventHandler<HTMLElement>?

onDragLeaveCapture

abstract var onDragLeaveCapture: DragEventHandler<HTMLElement>?

onDragOver

abstract var onDragOver: DragEventHandler<HTMLElement>?

onDragOverCapture

abstract var onDragOverCapture: DragEventHandler<HTMLElement>?

onDragStart

abstract var onDragStart: DragEventHandler<HTMLElement>?

onDragStartCapture

abstract var onDragStartCapture: DragEventHandler<HTMLElement>?

onDrop

abstract var onDrop: DragEventHandler<HTMLElement>?

onDropCapture

abstract var onDropCapture: DragEventHandler<HTMLElement>?

onDurationChange

abstract var onDurationChange: ReactEventHandler<HTMLElement>?

onDurationChangeCapture

abstract var onDurationChangeCapture: ReactEventHandler<HTMLElement>?

onEmptied

abstract var onEmptied: ReactEventHandler<HTMLElement>?

onEmptiedCapture

abstract var onEmptiedCapture: ReactEventHandler<HTMLElement>?

onEncrypted

abstract var onEncrypted: ReactEventHandler<HTMLElement>?

onEncryptedCapture

abstract var onEncryptedCapture: ReactEventHandler<HTMLElement>?

onEnded

abstract var onEnded: ReactEventHandler<HTMLElement>?

onEndedCapture

abstract var onEndedCapture: ReactEventHandler<HTMLElement>?

onError

abstract var onError: ReactEventHandler<HTMLElement>?

onErrorCapture

abstract var onErrorCapture: ReactEventHandler<HTMLElement>?

onFocus

abstract var onFocus: FocusEventHandler<HTMLElement>?

onFocusCapture

abstract var onFocusCapture: FocusEventHandler<HTMLElement>?

onGotPointerCapture

abstract var onGotPointerCapture: PointerEventHandler<HTMLElement>?

onGotPointerCaptureCapture

abstract var onGotPointerCaptureCapture: PointerEventHandler<HTMLElement>?

onInput

abstract var onInput: FormEventHandler<HTMLElement>?

onInputCapture

abstract var onInputCapture: FormEventHandler<HTMLElement>?

onInvalid

abstract var onInvalid: FormEventHandler<HTMLElement>?

onInvalidCapture

abstract var onInvalidCapture: FormEventHandler<HTMLElement>?

onKeyDown

abstract var onKeyDown: KeyboardEventHandler<HTMLElement>?

onKeyDownCapture

abstract var onKeyDownCapture: KeyboardEventHandler<HTMLElement>?

onKeyUp

abstract var onKeyUp: KeyboardEventHandler<HTMLElement>?

onKeyUpCapture

abstract var onKeyUpCapture: KeyboardEventHandler<HTMLElement>?

onLoad

abstract var onLoad: ReactEventHandler<HTMLElement>?

onLoadCapture

abstract var onLoadCapture: ReactEventHandler<HTMLElement>?

onLoadedData

abstract var onLoadedData: ReactEventHandler<HTMLElement>?

onLoadedDataCapture

abstract var onLoadedDataCapture: ReactEventHandler<HTMLElement>?

onLoadedMetadata

abstract var onLoadedMetadata: ReactEventHandler<HTMLElement>?

onLoadedMetadataCapture

abstract var onLoadedMetadataCapture: ReactEventHandler<HTMLElement>?

onLoadStart

abstract var onLoadStart: ReactEventHandler<HTMLElement>?

onLoadStartCapture

abstract var onLoadStartCapture: ReactEventHandler<HTMLElement>?

onLostPointerCapture

abstract var onLostPointerCapture: PointerEventHandler<HTMLElement>?

onLostPointerCaptureCapture

abstract var onLostPointerCaptureCapture: PointerEventHandler<HTMLElement>?

onMouseDown

abstract var onMouseDown: MouseEventHandler<HTMLElement>?

onMouseDownCapture

abstract var onMouseDownCapture: MouseEventHandler<HTMLElement>?

onMouseEnter

abstract var onMouseEnter: MouseEventHandler<HTMLElement>?

onMouseLeave

abstract var onMouseLeave: MouseEventHandler<HTMLElement>?

onMouseMove

abstract var onMouseMove: MouseEventHandler<HTMLElement>?

onMouseMoveCapture

abstract var onMouseMoveCapture: MouseEventHandler<HTMLElement>?

onMouseOut

abstract var onMouseOut: MouseEventHandler<HTMLElement>?

onMouseOutCapture

abstract var onMouseOutCapture: MouseEventHandler<HTMLElement>?

onMouseOver

abstract var onMouseOver: MouseEventHandler<HTMLElement>?

onMouseOverCapture

abstract var onMouseOverCapture: MouseEventHandler<HTMLElement>?

onMouseUp

abstract var onMouseUp: MouseEventHandler<HTMLElement>?

onMouseUpCapture

abstract var onMouseUpCapture: MouseEventHandler<HTMLElement>?

onPaste

abstract var onPaste: ClipboardEventHandler<HTMLElement>?

onPasteCapture

abstract var onPasteCapture: ClipboardEventHandler<HTMLElement>?

onPause

abstract var onPause: ReactEventHandler<HTMLElement>?

onPauseCapture

abstract var onPauseCapture: ReactEventHandler<HTMLElement>?

onPlay

abstract var onPlay: ReactEventHandler<HTMLElement>?

onPlayCapture

abstract var onPlayCapture: ReactEventHandler<HTMLElement>?

onPlaying

abstract var onPlaying: ReactEventHandler<HTMLElement>?

onPlayingCapture

abstract var onPlayingCapture: ReactEventHandler<HTMLElement>?

onPointerCancel

abstract var onPointerCancel: PointerEventHandler<HTMLElement>?

onPointerCancelCapture

abstract var onPointerCancelCapture: PointerEventHandler<HTMLElement>?

onPointerDown

abstract var onPointerDown: PointerEventHandler<HTMLElement>?

onPointerDownCapture

abstract var onPointerDownCapture: PointerEventHandler<HTMLElement>?

onPointerEnter

abstract var onPointerEnter: PointerEventHandler<HTMLElement>?

onPointerLeave

abstract var onPointerLeave: PointerEventHandler<HTMLElement>?

onPointerMove

abstract var onPointerMove: PointerEventHandler<HTMLElement>?

onPointerMoveCapture

abstract var onPointerMoveCapture: PointerEventHandler<HTMLElement>?

onPointerOut

abstract var onPointerOut: PointerEventHandler<HTMLElement>?

onPointerOutCapture

abstract var onPointerOutCapture: PointerEventHandler<HTMLElement>?

onPointerOver

abstract var onPointerOver: PointerEventHandler<HTMLElement>?

onPointerOverCapture

abstract var onPointerOverCapture: PointerEventHandler<HTMLElement>?

onPointerUp

abstract var onPointerUp: PointerEventHandler<HTMLElement>?

onPointerUpCapture

abstract var onPointerUpCapture: PointerEventHandler<HTMLElement>?

onProgress

abstract var onProgress: ReactEventHandler<HTMLElement>?

onProgressCapture

abstract var onProgressCapture: ReactEventHandler<HTMLElement>?

onRateChange

abstract var onRateChange: ReactEventHandler<HTMLElement>?

onRateChangeCapture

abstract var onRateChangeCapture: ReactEventHandler<HTMLElement>?

onReset

abstract var onReset: FormEventHandler<HTMLElement>?

onResetCapture

abstract var onResetCapture: FormEventHandler<HTMLElement>?

onResize

abstract var onResize: ReactEventHandler<HTMLElement>?

onResizeCapture

abstract var onResizeCapture: ReactEventHandler<HTMLElement>?

onScroll

abstract var onScroll: UIEventHandler<HTMLElement>?

onScrollCapture

abstract var onScrollCapture: UIEventHandler<HTMLElement>?

onSeeked

abstract var onSeeked: ReactEventHandler<HTMLElement>?

onSeekedCapture

abstract var onSeekedCapture: ReactEventHandler<HTMLElement>?

onSeeking

abstract var onSeeking: ReactEventHandler<HTMLElement>?

onSeekingCapture

abstract var onSeekingCapture: ReactEventHandler<HTMLElement>?

onSelect

abstract var onSelect: ReactEventHandler<HTMLElement>?

onSelectCapture

abstract var onSelectCapture: ReactEventHandler<HTMLElement>?

onStalled

abstract var onStalled: ReactEventHandler<HTMLElement>?

onStalledCapture

abstract var onStalledCapture: ReactEventHandler<HTMLElement>?

onSubmit

abstract var onSubmit: FormEventHandler<HTMLElement>?

onSubmitCapture

abstract var onSubmitCapture: FormEventHandler<HTMLElement>?

onSuspend

abstract var onSuspend: ReactEventHandler<HTMLElement>?

onSuspendCapture

abstract var onSuspendCapture: ReactEventHandler<HTMLElement>?

onTimeUpdate

abstract var onTimeUpdate: ReactEventHandler<HTMLElement>?

onTimeUpdateCapture

abstract var onTimeUpdateCapture: ReactEventHandler<HTMLElement>?

onTouchCancel

abstract var onTouchCancel: TouchEventHandler<HTMLElement>?

onTouchCancelCapture

abstract var onTouchCancelCapture: TouchEventHandler<HTMLElement>?

onTouchEnd

abstract var onTouchEnd: TouchEventHandler<HTMLElement>?

onTouchEndCapture

abstract var onTouchEndCapture: TouchEventHandler<HTMLElement>?

onTouchMove

abstract var onTouchMove: TouchEventHandler<HTMLElement>?

onTouchMoveCapture

abstract var onTouchMoveCapture: TouchEventHandler<HTMLElement>?

onTouchStart

abstract var onTouchStart: TouchEventHandler<HTMLElement>?

onTouchStartCapture

abstract var onTouchStartCapture: TouchEventHandler<HTMLElement>?

onTransitionEnd

abstract var onTransitionEnd: TransitionEventHandler<HTMLElement>?

onTransitionEndCapture

abstract var onTransitionEndCapture: TransitionEventHandler<HTMLElement>?

onVolumeChange

abstract var onVolumeChange: ReactEventHandler<HTMLElement>?

onVolumeChangeCapture

abstract var onVolumeChangeCapture: ReactEventHandler<HTMLElement>?

onWaiting

abstract var onWaiting: ReactEventHandler<HTMLElement>?

onWaitingCapture

abstract var onWaitingCapture: ReactEventHandler<HTMLElement>?

onWheel

abstract var onWheel: WheelEventHandler<HTMLElement>?

onWheelCapture

abstract var onWheelCapture: WheelEventHandler<HTMLElement>?

page

abstract var page: Number?

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

prefix

abstract var prefix: String?

property

abstract var property: String?

radioGroup

abstract var radioGroup: String?

ref

abstract var ref: Ref<HTMLElement>?

rel

abstract var rel: String?

renderItem

abstract var renderItem: (params: PaginationRenderItemParams) -> ReactNode?

Render the item.

resource

abstract var resource: String?

results

abstract var results: String?

rev

abstract var rev: String?

role

abstract var role: AriaRole?

security

abstract var security: String?

shape

abstract var shape: PaginationShape?

The shape of the pagination items.

showFirstButton

abstract var showFirstButton: Boolean?

If true, show the first-page button.

showLastButton

abstract var showLastButton: Boolean?

If true, show the last-page button.

siblingCount

abstract var siblingCount: Number?

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

size

abstract var size: Size?

The size of the component.

slot

abstract var slot: String?

spellCheck

abstract var spellCheck: Boolean?

style

abstract var style: CSSProperties?

suppressContentEditableWarning

abstract var suppressContentEditableWarning: Boolean?

suppressHydrationWarning

abstract var suppressHydrationWarning: Boolean?

abstract override var sx: SxProps<Theme>?

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

tabIndex

abstract var tabIndex: Int?

title

abstract var title: String?

translate

abstract var translate: Translate?

typeof

abstract var typeof: String?

unselectable

abstract var unselectable: Unselectable?

variant

abstract var variant: PaginationVariant?

The variant to use.

vocab

abstract var vocab: String?

Functions

child

open inline fun child(type: ElementType, props: P)

invoke

open inline operator fun ElementType.invoke()

open inline operator fun ElementType.invoke(noinline block: P.() -> Unit)

open inline operator fun <T> Provider<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)

unaryPlus

open inline operator fun Char.unaryPlus()

open inline operator fun String?.unaryPlus()

open inline operator fun ReactNode?.unaryPlus()

open inline operator fun Props?.unaryPlus()