Siirry sisältöön

14.5.0

MainBar

Komponentit palvelukohtaisen työkalupalkin toteutukseen.

Julkaistu versiossa 0.17.0

API

MainBarContainer

  • as

    Tyyppi: ElementType

    Renderöitävä HTML-elementti

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • sticky

    Tyyppi: boolean

    Oletusarvo: true

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

  • testId

    Tyyppi: string

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

MainBar

  • as

    Tyyppi: ElementType

    Oletusarvo: "header" as E

    Renderöitävä HTML-elementti

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • shadow

    Tyyppi: boolean

    Oletusarvo: true

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

  • stackOnMobile

    Tyyppi: boolean

    Oletusarvo: false

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

  • sticky

    Tyyppi: boolean

    Oletusarvo: true

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

  • 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.

MainBarActionGroup

  • align

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

    Oletusarvo: right

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

  • testId

    Tyyppi: string

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

  • useGroupItems

    Tyyppi: boolean

    Oletusarvo: false

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

  • util

    Poistuva

    Tyyppi: string

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

MainBarActionGroupItem

  • 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

MainBarAction

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

  • active

    Tyyppi: boolean

    Korostaa aktiivisen linkin tai painikkeen

  • as

    Tyyppi: ElementType<any, keyof IntrinsicElements>

    Oletusarvo: "button" as E

    Renderöitävä HTML-elementti

  • caret

    Tyyppi: boolean

    Nuolikuvake

  • caretUp

    Tyyppi: boolean

    Nuolikuvake ylös

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • icon

    Tyyppi: Element

    Painikkeen kuvake

  • labelUtil

    Tyyppi: string

    Utility-luokkien välitys linkin/painikkeen tekstille

  • ref

    Tyyppi: any

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

  • 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.

  • vAlign

    Tyyppi: "middle"

    Painikkeen tasaus pystysuunnassa.

MainBarSearch

  • breakpoint

    Tyyppi: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl"

    Määrittää breakpointin, josta eteenpäin hakukenttä näytetään automaattisesti avoimena.

  • closeLabel

    Pakollinen

    Tyyppi: string

    Hakukentän sulkupainikkeen saavutettava teksti

  • labelUtil

    Tyyppi: string

    Utility-luokkien välitys linkin/painikkeen tekstille

  • search

    Pakollinen

    Tyyppi: (inputRef: RefObject<HTMLInputElement>, inputClassNames: string, btnUtilClasses: string) => Element

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

  • 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.

MainBarSearchV2

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • search

    Pakollinen

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

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

  • testId

    Tyyppi: string

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

MainBarMenuButton

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

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • isOpen

    Tyyppi: boolean

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

  • testId

    Tyyppi: string

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

  • vAlign

    Tyyppi: "middle"

    Painikkeen tasaus pystysuunnassa.