Overview

Installation

npm install @rhds/elements

Slots

Default Slot

Place element content here

Attributes

overflow

Override overflow values set from HTML or JS. overflow should ideally be private, but because we can't do ::slotted(nav ol li), we need to reflect it to a host attribute, so that lightdom CSS can target the list items.

DOM Property
overflow
Type
'start' | 'end' | 'both' | null
Default
null
label

Accessible label for the 'nav' element

DOM Property
label
Type
string
Default
'Page navigation'
label-first

Accessible label for the 'first page' button

DOM Property
labelFirst
Type
string
Default
'first page'
label-previous

Accessible label for the 'previous page' button

DOM Property
labelPrevious
Type
string
Default
'previous page'
label-next

Accessible label for the 'next page' button

DOM Property
labelNext
Type
string
Default
'next page'
label-last

Accessible label for the 'last page' button

DOM Property
labelLast
Type
string
Default
'last page'

Methods

first()

Navigate to the first page

prev()

Navigate to the previous page

next()

Navigate to the next page

last()

Navigate to the last page

go(page: 'first' | 'prev' | 'next' | 'last' | number)

Navigate to a specific page

Events

None

© 2021-2023 Red Hat, Inc. Deploys by Netlify