Sidebar

Sivupalkki-komponentti navigaatiovalikon toteuttamiseen eri kokoisille näytöille.

Julkaistu versiossa 0.15.3

React API

animate

Kääntää komponentin animaatiot päälle tai pois päältä.

Tyyppi: boolean

Oletusarvo: true
children

Komponentin sisältö

Tyyppi: ReactNode
className

CSS-apuluokat ulkoasun muokkaamiseen.

Tyyppi: string
closeLabel
Pakollinen

Saavutettava teksti sulje-painikkeelle.

Tyyppi: string
description

Palvelun tai aktiivisen sivun kuvaus.

Tyyppi: string

Oletusarvo: ""
focusTrap

Määrittää lukitaanko kohdistus sivupalkin sisään.

Tyyppi: boolean

Oletusarvo: true
isOpen
Pakollinen

Määrittää onko sivupalkki avattu vai suljettu.

Tyyppi: boolean
isOverlay
Pakollinen

Sisällön päällä kelluva sivupalkki pienille näytöille.

Tyyppi: boolean
logo

Logo

Tyyppi: ReactNode
onClose

Funktio, jota kutsutaan sivupalkin sulkeutuessa (sulje-painike, esc, valikon ulkopuolinen klikkaus).

Tyyppi: (e: KeyboardEvent | MouseEvent | TouchEvent, { reason }: { reason: SidebarCloseReason; }) => void
ref

Komponentin renderöimälle elementille välitettävä Ref.

Tyyppi: Ref<HTMLElement>
returnFocus

Määrittää palautetaanko kohdistus elementtiin, joka avasi sivupalkin. Mahdollistaa kohdistuksen palautuksen räätälöinnin.

Tyyppi: boolean

Oletusarvo: true
testId

Komponentin juurielementille data-testid-attribuuttiin välitettävä arvo testausta varten.

Tyyppi: string
toggle
Poistuva

Funktio, jota kutsutaan sivupalkin sulkeutuessa (sulje-painike, esc, valikon ulkopuolinen klikkaus). @deprecated Poistuu versiossa 17.0.0. Siirry käyttämään onClose-proppia.

Tyyppi: () => void
triggerRef

Sivupalkin avauspainikkeen Ref-objekti, johon kohdistus palautetaan sivupalkin sulkeutuessa.

Tyyppi: RefObject<HTMLElement>