README
@fremtind/jkl-datepicker-react
Beskrivelse
Se portalen for bruk og prinsipper.
Kom i gang
Lær hvordan du kan ta i bruk Jøkul
Bruk av React-pakken
Installasjon
Installér pakken med
yarn add @fremtind/jkl-datepicker-react
ellernpm i @fremtind/jkl-datepicker-react
. Stil-pakken blir automatisk installert som en avhengighet.Importer både React-pakken (velg komponenten(e) du trenger) og stil-pakken i prosjektet ditt:
import { DatePicker } from "@fremtind/jkl-datepicker-react";
import "@fremtind/jkl-datepicker/datepicker.min.css";
import "@fremtind/jkl-icon-button/icon-button.min.css";
Bruk
Helt grunnleggende bruk av datovelgeren ser slik ut:
<DatePicker />
Datovelgeren kan ta inn prop-en label
(standardverdi "Velg dato") for å sette tittel.
Om du ønsker andre navn på ukedager og/eller måneder, f.eks for andre språk enn norsk, kan dette sendes inn som string
-arrayer til prop-ene days
og months
.
const englishMonths = [
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December",
];
const englishDays = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"];
<DatePicker months={englishMonths} days={englishDays} />;
Er det behov for å velge en dato langt frem eller tilbake i tid benyttes prop-en extended
slik at år og måned kan settes via en nedtrekksliste. Etikettene på disse nedtrekkslistene settes med prop-ene monthLabel
og yearLabel
("Måned" og "År" er standardverdier).
Du kan sette en forhåndsvalgt dato med initialDate
. Dersom ingen dato er valgt vises teksten fra prop-en placeholder
(standardverdi er "dd.mm.åååå").
<DatePicker initialDate={new Date(new Date().setFullYear(new Date().getFullYear() + 1))} />
Event Handling
DatePicker-komponenten mottar tre event-funksjoner (onFocus, onChange og onBlur). Disse eventene returnerer et native event-objekt og et Date-objekt. Begge parametrene er optional.
onChange
returnerer i tillegg et meta
-objekt med verdiene error: "WRONG_FORMAT" | "OUTSIDE_LOWER_BOUND" | "OUTSIDE_UPPER_BOUND"
og value: string
. Du kan bruke error
til å velge hvilken feilmeldingstekst du viser til brukeren og value
om du ønsker å bruke inputfeltets verdi i feilmeldingen.
<DatePicker
onChange={(date, e, meta) => {
handleChange(date);
if (meta.error) {
handleError(meta.error);
}
}}
onFocus={(date, e) => {
handleFocus(date);
}}
onBlur={(date, e) => {
updateValue(date);
}}
/>