Skip to content

Commit

Permalink
docs: updated switch.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
Ildest committed Apr 26, 2024
1 parent 99d6b34 commit fa9207a
Showing 1 changed file with 34 additions and 17 deletions.
51 changes: 34 additions & 17 deletions packages/react/src/components/form/Switch/Switch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import * as SwitchStories from './Switch.stories';
<Primary />
<Controls />

## Bruk
## Slik bruker du `Switch`

```tsx
import { Switch, Fieldset } from '@digdir/designsystemet-react';
Expand All @@ -27,38 +27,55 @@ Bruker [Fieldset](/docs/komponenter-fieldset--docs) til gruppering.

### Høyrejustert

Bruk `position="right"` til å plassere `Switch` på høyre side av label dersom
du har behov for det.
Bruk `position="right"` til å plassere `Switch` på høyre side av ledeteksten hvis
du trenger det.

<Canvas of={SwitchStories.FullWidthRight} />

## Retningslinjer
## Retningslinjer for `Switch`

Vi bruker switch når brukeren skal kunne slå noe av eller på. Switch er den digitale varianten av av/på-brytere, for eksempel en lysbryter. Et eksempel fra telefon er Flymodus av/på.
`Switch` skal være et valg mellom to alternativer som utelukker hverandre, og komponenten skal alltid ha et standardvalg (enten av eller på). Bruk switch til innstilinger, ikke i skjema.

Switch skal være et valg mellom to alternativer som utelukker hverandre, og komponenten skal alltid ha et standardvalg.
<br />
Passer til å

Du skal bare bruke switch når resultatet av valget umiddelbart blir synlig for brukeren. Det betyr at brukeren ikke må bekrefte eller lagre for å se resultatet av å ha trykket på bryteren.
- aktivere eller deaktivere funksjoner/tilstander med en gang
- slå varsler av
og på
- endre visning av innhold mellom to kategorier, for eksempel se
statistikk per måned eller år

Ikke bruk Switch
<br />
Passer ikke til

- til filtrering av innhold. Bruk heller Chips
- hvis det er flere alternativer enn to
- hvis brukeren velge «lagre» for å kunne se endringen. Bruk heller en Checkbox eller to Radio button.
- å gi flere alternativer enn to
- å bruke i stedet for avmerkingsboks (checkbox) eller alternativknapper (radio buttons) i et skjema
- situasjoner der brukerne må lagre informasjon før en endring får effekt

### Tekst i komponenten
<br />
Bruk heller

Teksten til en switch må være kort og presis. Det skal gi mening når du sier ledeteksten høyt og legger til av/på etterpå. Bruk nøkkelord i teksten, og unngå å formulere label som et spørsmål.
- avmerkingsbokser (checkboxes) hvis du skal tilby brukerne flere valg, der de skal velge ett eller flere alternativer
- alternativknapper (radio buttons) hvis brukerne skal få flere valg, men bare skal velge ett
- chip til å filtrere innhold

### Eksempel:
<br />
## Tekst i komponenten

Teksten til en switch må være kort og presis, ofte betyr det bare ett eller to ord. Det skal gi mening når du sier ledeteksten høyt og legger til av/på etterpå. Unngå tekst med flere ord og mellomrom.

### Eksempel

- ⚠️ Ikke: Skru på flymodus (Av/på)
- 👍 Riktig: Flymodus (Av/på)
<br />

### Plassering av tekst

Som regel er det høyre som er den beste plasseringen for tekst, unntaket er når switch er fast plassert på høyre side i grensesnittet er det best at teksten er på venstre side. Slik at alle knappene blir justert etter samme vertikale linje.
Som regel er det høyre som er den beste plasseringen for tekst, unntaket er når `Switch` er fast plassert på høyre side i grensesnittet er det best at teksten er på venstre side. Slik at alle knappene blir justert etter samme vertikale linje.

Semantisk struktur
<br />
## Tilgjengelighet

Universell utforming spesielt for denne komponenten
Sørg for at komponenten oppfører seg konsekvent gjennom en hel tjeneste.
Hvis du har en gruppe med flere vippebrytere, må du passe på at du er konsekvent med hvordan du formulerer tekstene til hver av dem også, ikke formulerer dem forskjellig.

0 comments on commit fa9207a

Please sign in to comment.