TextField

Om komponenten

TextField (også kalt Input og Input field) er et skjemaelement som gir brukeren mulighet til å skrive inn korte tekster.

Egnet til:

  • Når bruker skal fylle inn for eksempel navn, bruksenhetsnummer, adresse og annen informasjon som får plass på én linje

Uegnet til:

  • Når brukeren bare kan skrive inn ett alternativ fra en forhåndsdefinert liste. Se Select, RadioButton eller Checkbox-group i stedet.
  • Når bruker blir bedt om å for eksempel beskrive noe. Bruk da heller TextArea
Divider

Varianter

Vi har fire varianter av TextField.

8px spacer

Standard

Standard input-felt

<TextField
  label="Navn"
  description="Fornavn, mellomnavn og etternavn"
/>
8px spacer

Prefiks

Brukes til telefonnummer

<TextField
  label="Telefonnummer"
  leftAddon="+47"
  textAlign="left"
  withAddonDivider
/>
8px spacer

Suffiks

Brukes til input som er relatert til suffix, som for eksempel kroner, kilo, liter osv.

<TextField
  label="Egenkapital"
  rightAddon="kr"
  textAlign="right"
  withAddonDivider
/>
8px spacer

Ikon - høyre

Input-felt med støtte for ikoner, som hjelper bruker med å forstå formålet. For eksempel til passord eller dato.

<TextField
  label="Velg passende visningsdato"
  placeholder="dd/mm/åååå"
  rightAddon={<Calendar className="pointer-events-none" />}
/>

Divider

Retningslinjer

Påkrevd vs valgfritt

I Obos bruker vi ikke påkrevd eller asterisk (*). Vi merkerer label med “Valgfritt”. Det er viktig å tenke på datatilsynets dataminimeringspunkt - “Er dette feltet helt nødvendig for å iverksette prosesser?”

Input - Optional - Retningslinje

8px spacer

Label

Label er påkrevd. Skriv den kort og konsis.

Input - Label - Retningslinje

8px spacer

Placeholder

Ikke bruk placeholder som hjelpetekst.

Input - Placeholder - Retningslinje

8px spacer

Feltets lengde

For gitte inputs som for eksempel telefonnummer hvor vi vet at det er 8-siffer, så skal feltet ha antall tegns lengde. Inputfelt kan kun ha en maks lengde på 500px

Input - Lengde - Retningslinje

8px spacer

Ikke bruk kolon

Input - Kolon - Retningslinje

Divider

Formatering

Text-input har en fast høyde og brukes til å legge inn enklet innput i fritt format med en hvilken som helst kombinasjon av bokstaver, tall eller symboler.

Anatomi

  1. Label Tekst som informerer brukeren om innholdet de må skrive inn i feltet. Det er påkrevd med mindre det foreligger et unntakstilfelle.
  2. Beskrivelse Hjelpetekst som kan gi ekstra hjelp eller kontekst til brukeren. Brukes ofte for å forklare riktig dataformat.
  3. Verdi Innholdet brukeren har skrevet inn i feltet.
  4. Field Kontaineren der en bruker legger inn data. Må oppfylle 3:1 ikke-tekstkontrastkrav. (non-text contrast)
8px spacer

Format

Det er mulig å sette max- og min-lengde, samt å justere bredden på feltene:

<TextField
  description="Bruksenhetsnummeret, som tidligere ble kalt bolignummer, består av en bokstav og fire tall. F.eks. H0101"
  label="Bruksenhetsnummer"
  maxLength={5}
  minLength={5}
  size={5}
/>
8px spacer

Validering

Det er innebygget støtte for påkrevde felter:

<form
  onSubmit={(e) => e.preventDefault()}
  className="grid gap-6"
>
  <TextField
    isRequired
    label="Navn"
  />
  <Button type="submit" className="w-fit">
    Send inn
  </Button>
</form>
8px spacer

Det er også mulig å vise en vilkårlig feilmelding:

<TextField
  label="Navn"
  errorMessage="Her er det noe feil!"
/>
8px spacer

Controlled

function(){
  const [value, setValue] = React.useState("");

return <TextField
  label="Beløp"
  value={value}
  onChange={setValue}
/>
}
Divider

Universell utforming

Husk på

  • Skjemaelementer burde ha en en-kolonnes layout, og hvert element skal ha sin egen label for å beskrive bruk. Om label av en eller annen grunn ikke skal vises skal den fortsatt finnes, men bruke klassen pkt-sr-only slik at skjemaet fortsatt er brukervennlig.
  • Alle tekstfelt bør ha et tilknyttet label (ledetekst) eller instruksjon som viser hvordan skjemaet skal fylles ut, inkludert informasjon om obligatoriske felt.
  • Label (ledeteksten) bør være koblet til tekstfeltet i koden slik at skjermlesere kan lese opp riktig informasjon. Komplekse skjema kan kreve mer hjelp enn bare enn labels.
  • Bruker du symboler i tekstfeltet bør symbolene enten være logiske og kjente, eller så må de forklares før de brukes for å unngå forvirring.
  • Feilmeldinger bør være kodet som tekst og identifisere det spesifikke skjemaelementet hvor feilen oppstod. Feilmeldingen må beskrive feilen og være synlig uten at brukeren gjør noen ekstra handlinger.
  • Prefiks og suffiks er et ekstra visuelt hjelpemiddel, som blir ignorert av skjermlesere. Vi må alltid ha en beskrivende ledetekst. Prefiks og suffiks er plassert utenfor inndatafeltene de tilhører. Da unngår vi at de ikke skaper trøbbel i noen nettlesere, som kan sette inn et ikon i inndatafeltet

Sjekkliste

✓ Alle skjemaelementene har tilknyttet label eller instruksjon

✓ Det er tydelig merket hvilke felter som er valgfrie

✓ Feilmeldinger er kodet som tekst og er i nærheten av det spesifikke tekstfeltet der feilen oppstod

✓ Feilmeldinger er tilgjengelig for skjermleser og keyboard-navigering

Les mer

WCAG 2.4.6 Heading and Labels (AA)

WCAG 1.3.1 Info and Relationships (A)

WCAG 3.2.2 On Input (A)

WCAG 3.2.1 On Focus (A)

Divider

Interaksjon

Tastatur

KeyInteraksjon
TabFører fokus til inputfield
Enter eller spaceÅpner tilleggsfunksjoner som datepicker ved å aktivere kalender-ikonet
EscLukker tilleggsfunksjoner
ctrl eller opt + venstre/høyre piltastBeveger brukeren ord for ord i inputfeltet
ctrl eller opt + opp/ned piltastFlytter brukeren til starten eller slutten av det som er skrevet inn i inputfeltet

Props

TextField

PropDescriptionDefault
className?Additional CSS className for the element.-
description?Help text for the form control.-
errorMessage?Error message for the form control. Automatically sets `isInvalid` to true-
leftAddon?Element to be rendered in the left side of the input.-
label?Label for the form control.-
rightAddon?Element to be rendered in the right side of the input.-
placeholder?Placeholder text. Only visible when the input value is empty.-
textAlign?Text alignment of the inputleft
style?Additional style properties for the element.-
withAddonDivider?Add a divider between the left/right addons and the input, a value of 0 will be ignored-
size?Defines the number of characters and determines the width of the input element-
autoFocus?Whether the element should receive focus on render.-
onFocus?Handler that is called when the element receives focus.-
onBlur?Handler that is called when the element loses focus.-
onFocusChange?Handler that is called when the element's focus status changes.-
onKeyDown?Handler that is called when a key is pressed.-
onKeyUp?Handler that is called when a key is released.-
aria-haspopup?Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.-
aria-controls?Identifies the element (or elements) whose contents or presence are controlled by the current element.-
type?The type of input to render. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdeftype).-
excludeFromTabOrder?Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.-
id?The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).-
aria-label?Defines a string value that labels the current element.-
aria-labelledby?Identifies the element (or elements) that labels the current element.-
aria-describedby?Identifies the element (or elements) that describes the object.-
aria-details?Identifies the element (or elements) that provide a detailed, extended description for the object.-
name?The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).-
value?The current value (controlled).-
slot?A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.-
validationBehavior?Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.'native'
onChange?Handler that is called when the value changes.-
isRequired?Whether user input is required on the input before form submission.-
isInvalid?Whether the value is invalid.-
validate?A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.-
aria-errormessage?Identifies the element that provides an error message for the object.-
defaultValue?The default value (uncontrolled).-
autoComplete?Describes the type of autocomplete functionality the input should provide if any. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).-
aria-activedescendant?Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.-
aria-autocomplete?Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.-
enterKeyHint?An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See [https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint].-
maxLength?The maximum number of characters supported by the input. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefmaxlength).-
minLength?The minimum number of characters required by the input. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefminlength).-
pattern?Regex pattern that the value of the input must match to be valid. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefpattern).-
inputMode?Hints at the type of data that might be entered by the user while editing the element or its contents. See [MDN](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute).-
autoCorrect?An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#autocomplete).-
spellCheck?An enumerated attribute that defines whether the element may be checked for spelling errors. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck).-
onCopy?Handler that is called when the user copies text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncopy).-
onCut?Handler that is called when the user cuts text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncut).-
onPaste?Handler that is called when the user pastes text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/onpaste).-
onCompositionStart?Handler that is called when a text composition system starts a new text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event).-
onCompositionEnd?Handler that is called when a text composition system completes or cancels the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionend_event).-
onCompositionUpdate?Handler that is called when a new character is received in the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionupdate_event).-
onSelect?Handler that is called when text in the input is selected. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/select_event).-
onBeforeInput?Handler that is called when the input value is about to be modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/beforeinput_event).-
onInput?Handler that is called when the input value is modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).-
ref?Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}-
key?-