mui/material_5
API
Generated with
mui/material_5/io.github.nafg.scalajs.facades.mui/Pagination/Props

Props

io.github.nafg.scalajs.facades.mui.Pagination.Props
class Props extends PropTypes

Attributes

Graph
Supertypes
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object color extends Prop[String]

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

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

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
color.type
object shape extends Prop[String]

The shape of the pagination items.

The shape of the pagination items.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
shape.type
object size extends Prop[String]

The size of the component.

The size of the component.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
size.type
object variant extends Prop[String]

The variant to use.

The variant to use.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
variant.type

Inherited classlikes

object dyn extends Dynamic

Attributes

Inherited from:
PropTypes
Supertypes
trait Dynamic
class Object
trait Matchable
class Any

Value members

Concrete methods

def boundaryCount: Prop[Any]

Number of always visible pages at the beginning and end.

Number of always visible pages at the beginning and end.

Attributes

def classes: Prop[Object]

Override or extend the styles applied to the component.

Override or extend the styles applied to the component.

Attributes

def count: Prop[Any]

The total number of pages.

The total number of pages.

Attributes

def defaultPage: Prop[Any]

The page selected by default when the component is uncontrolled.

The page selected by default when the component is uncontrolled.

Attributes

def disabled: Prop[Boolean]

If true, the component is disabled.

If true, the component is disabled.

Attributes

def getItemAriaLabel: Prop[Any => Any]

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.

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.

Value parameters

{bool}

selected If true, the current page is selected.

{number}

page The page number to format.

{string}

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

Attributes

def hideNextButton: Prop[Boolean]

If true, hide the next-page button.

If true, hide the next-page button.

Attributes

def hidePrevButton: Prop[Boolean]

If true, hide the previous-page button.

If true, hide the previous-page button.

Attributes

def onChange: Prop[Any => Any]

Callback fired when the page is changed.

Callback fired when the page is changed.

Value parameters

{React.ChangeEvent<unknown>}

event The event source of the callback.

{number}

page The page selected.

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def page: Prop[Any]

The current page.

The current page.

Attributes

def renderItem: Prop[Any => Any]

Render the item.

Render the item.

Value parameters

{PaginationRenderItemParams}

params The props to spread on a PaginationItem.

Attributes

def showFirstButton: Prop[Boolean]

If true, show the first-page button.

If true, show the first-page button.

Attributes

def showLastButton: Prop[Boolean]

If true, show the last-page button.

If true, show the last-page button.

Attributes

def siblingCount: Prop[Any]

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

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

Attributes

def style: Prop[Object]
def sx: Prop[Seq[Any => Any | Object | Boolean] | Any => Any | Object]

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

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

Attributes

Inherited methods

def of[A : Writer](implicit evidence$1: Writer[A], name: Name): Prop[A]

Attributes

Inherited from:
PropTypes

Inherited fields

val key: Prop[Key]

Attributes

Inherited from:
PropTypes
Generated with