Sidebar

API

Sidebar

• animate

  Tyyppi: boolean

  Oletusarvo: true

  Kääntää komponentin animaatiot päälle/pois

• children

  Tyyppi: ReactNode

  Komponentin sisältö

• className

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen

• closeLabel

  Pakollinen

  Tyyppi: string

  Saavutettava teksti sulkupainikkeelle

• description

  Tyyppi: string

  Oletusarvo: ""

  Palvelun tai aktiivisen sivun kuvaus

• isOpen

  Pakollinen

  Tyyppi: boolean

  Auki / kiinni -tila

• isOverlay

  Pakollinen

  Tyyppi: boolean

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

• logo

  Tyyppi: ReactNode

  Navigaation logo

• navLinks

  Poistuva

  Tyyppi: ReactNode

  Navigaation linkit/painikkeet @deprecated Poistuu versiossa 15.0.0

• testId

  Tyyppi: string

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

• title

  Tyyppi: string

  Oletusarvo: ""

  Palvelun tai aktiivisen sivun otsikko

• toggle

  Pakollinen

  Tyyppi: () => void

  Funktio, joka muuttaa isOpen booleanin tilaa

• util

  Poistuva

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen @deprecated Poistuu käytöstä versiossa 15.0.0. Käytä className-proppia.

SidebarNavHeading

• as

  Tyyppi: ElementType

  Oletusarvo: "h2" as E

  Renderöitävä HTML-elementti

• children

  Tyyppi: ReactNode

  Komponentin sisältö

• className

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen

• testId

  Tyyppi: string

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

• util

  Poistuva

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen @deprecated Poistuu käytöstä versiossa 15.0.0. Käytä className-proppia.

SidebarNavItem

• active

  Tyyppi: boolean

  Oletusarvo: false

  Aktiivisen linkin visuaalinen korostus

• as

  Tyyppi: ElementType

  Oletusarvo: "a" as E

  Renderöitävä HTML-elementti

• children

  Tyyppi: ReactNode

  Komponentin sisältö

• className

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen

• disabled

  Tyyppi: boolean

  Oletusarvo: false

  Estetty (disabloitu) linkki / painike

• iconAfter

  Tyyppi: Element

  Kuvake tekstin jälkeen

• iconBefore

  Tyyppi: Element

  Kuvake ennen tekstiä

• linkColor

  Tyyppi: boolean

  Oletusarvo: false

  Antaa elementin tekstille linkkivärin

• preventAutoToggle

  Tyyppi: boolean

  Oletusarvo: false

  Estää navigaation automaattisen sulkeutumisen pienellä näytöllä, kun komponenttia klikataan. Huom! Toimii vain navLinks-propin kanssa.

• testId

  Tyyppi: string

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

• util

  Poistuva

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen @deprecated Poistuu käytöstä versiossa 15.0.0. Käytä className-proppia.