Esikatselu
<Status title="Status primary" icon={<IconPaper />} variant="primary">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
Käyttötarkoitus
Käytä statusta helpottamaan sisältöjen silmäilyä korostamalla asiakkaan kannalta tärkeimpiä tilatietoja. Status-komponenttiin voit liittää myös tilaan liittyvää lisätietoa.
Status-komponentti mahdollistaa pidemmät tekstit kuin tiiviimpi badge-komponentti. Kokonsa vuoksi Status ei kuitenkaan sovi esim. taulukoiden tai valikoiden sisään tai muuhun pieneen tilaan.
- Valitse tilaa parhaiten kuvaava väri ja käyttöliittymäkuvake.
- Kuvaa tila lyhyesti ja selkeästi.
- Käytä lisätietotekstiä vain, jos siitä on asiakkaalle oikeasti hyötyä.
- Älä käytä status-komponenttia ilmoittamaan virheestä tai muusta asiasta, joka vaatii asiakkaalta toimenpiteitä. Käytä tällöin Alert-komponenttia.
- Älä käytä statusta tilanteessa, jossa on käytössä niukasti tilaa. Käytä tällöin pienempää badge-komponenttia.
Saavutettavuus
Status-komponentti ei sisällä mitään erityistä teknistä toteutusta saavutettavuuden huomioimiseksi.
Komponentin ikonille voidaan tarvittaessa välittää sitä kuvaava teksti iconAriaLabel
-propilla.
Esimerkit
Tila- ja lisätieto
Nimeä tila mahdollisimman lyhyesti ja selkeästi, jotta asia käy ilmi yhdellä vilkaisulla. Tarkemman tilaa kuvaavan selitteen voi laittaa lisätietotekstiksi. Käytä lisätietoa kuitenkin vain, jos asiakas oikeasti tarvitsee sitä.
<>
<Status
title="Sinulla on kaksi uutta asiakirjaa"
icon={<IconPaper />}
variant="primary"
className="kds-mb-4 sm:kds-mb-6"
/>
<Status title="Tietoja ei luovuteta" icon={<IconClose />} variant="danger">
Olet kieltänyt kaikkien tietojesi luovuttamisen.
</Status>
</>
Värivaihtoehdot
Komponentilla on tilavärejä mukailevat värivaihtoehdot. Sekä värin että kuvakkeen tulisi ilmentää viestittävää tilaa.
Käytä statuksessa ensisijaisesti käyttöliittymäkuvakkeita.
<>
<Status title="Status primary" icon={<IconPaper />} variant="primary" className="kds-mb-4 sm:kds-mb-6">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
<Status title="Status warning" icon={<IconNoticeCircle />} variant="warning" className="kds-mb-4 sm:kds-mb-6">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
<Status title="Status danger" icon={<IconClose />} variant="danger" className="kds-mb-4 sm:kds-mb-6">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
<Status title="Status success" icon={<IconArrowCycle />} variant="success" className="kds-mb-4 sm:kds-mb-6">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
<Status title="Status neutral" icon={<IconMinus />} variant="neutral">
Quisque ligula eros ullamcorper quis, lacinia quis facilisis.
</Status>
</>
Komponentin räätälöinti
Otsikon voi antaa title
-propin kautta tekstinä tai StatusTitle
-komponentilla. Tarvittaessa otsikolle ja ikonille voi välittää omia attribuutteja.
<Status
icon={<IconPaper id="status-new-documents-icon" aria-label="Uusia asiakirjoja" aria-hidden="false" />}
variant="primary"
>
<StatusTitle id="status-new-documents-title" testId="status-new-documents">
Sinulla on kaksi uutta asiakirjaa
</StatusTitle>
<span>Quisque ligula eros ullamcorper quis, lacinia quis facilisis.</span>
</Status>