Siirry sisältöön

MainBar

Komponentit palvelukohtaisen työkalupalkin toteutukseen.

Julkaistu versiossa 0.17.0

React API

MainBarContainer

  • as

    Renderöitävä HTML-elementti

    Tyyppi: ElementType

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • sticky

    Määrittää tarttuuko MainBarContainer-elementti ruudun yläreunaan. Jos käytössä MainBar, aseta sille sama sticky-arvo.

    Tyyppi: boolean

    Oletusarvo: false

  • testId

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

    Tyyppi: string

MainBar

  • as

    Renderöitävä HTML-elementti

    Tyyppi: ElementType

    Oletusarvo: "header" as E

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • shadow

    Määrittää näytetäänkö MainBar-elementillä varjo (aseta arvoon false, jos käytät MainBarContaineria).

    Tyyppi: boolean

    Oletusarvo: true

  • stackOnMobile

    Näyttää valikon tekstit pienillä näytöillä kuvakkeiden alla

    Tyyppi: boolean

    Oletusarvo: false

  • sticky

    Määrittää tarttuuko MainBar-elementti ruudun yläreunaan. Jos käytössä MainBarContainer, aseta sille sama sticky-arvo.

    Tyyppi: boolean

    Oletusarvo: false

  • testId

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

    Tyyppi: string

MainBarActionGroup

  • align

    Tasaa linkit vasemmalle, oikealle tai keskelle (left, right, center)

    Tyyppi: "center" | "left" | "right"

    Oletusarvo: right

  • testId

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

    Tyyppi: string

  • useGroupItems

    Määrittää käytetäänkö groupin sisällä MainBarActionGroupItem-komponentteja vai luodaanko li-lista automaattisesti.

    Tyyppi: boolean

    Oletusarvo: false

MainBarActionGroupItem

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • testId

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

    Tyyppi: string

MainBarAction

Ref-prop välitetään komponentin renderöimän painikkeen HTML-elementille.

  • active

    Korostaa aktiivisen linkin tai painikkeen

    Tyyppi: boolean

  • as

    Renderöitävä HTML-elementti

    Tyyppi: ElementType<any, keyof IntrinsicElements>

    Oletusarvo: "button" as E

  • caret

    Nuolikuvake

    Tyyppi: boolean

  • caretUp

    Nuolikuvake ylös

    Tyyppi: boolean

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • icon

    Painikkeen kuvake

    Tyyppi: Element

  • labelClassName

    CSS-apuluokka linkin tai painikkeen tekstille

    Tyyppi: string

  • ref

    Komponentin ref, tyypittyy renderöitävän HTML-elementin mukaan

    Tyyppi: any

  • testId

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

    Tyyppi: string

  • vAlign

    Painikkeen tasaus pystysuunnassa.

    Tyyppi: "middle"

MainBarSearchV2

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • search
    Pakollinen

    Reactin render prop -funktio itse hakutoiminnon toteutukseen (hakukenttä ja painike)

    Tyyppi: ({ searchClassName, inputClassName, btnClassName, iconClassName, }: MainBarSearchV2RenderProps) => Element

  • testId

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

    Tyyppi: string

MainBarMenuButton

Ref-prop välitetään button-elementille.

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • isOpen

    Määrittää onko valikkopainike auki vai kiinni.

    Tyyppi: boolean

  • testId

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

    Tyyppi: string

  • vAlign

    Painikkeen tasaus pystysuunnassa.

    Tyyppi: "middle"