UNPKG

@navikt/ds-react

Version:

React components from the Norwegian Labour and Welfare Administration.

77 lines (76 loc) 2.7 kB
import React, { HTMLAttributes } from "react"; import FormSummaryAnswer from "./FormSummaryAnswer"; import FormSummaryAnswers from "./FormSummaryAnswers"; import FormSummaryEditLink from "./FormSummaryEditLink"; import FormSummaryFooter from "./FormSummaryFooter"; import FormSummaryHeader from "./FormSummaryHeader"; import FormSummaryHeading from "./FormSummaryHeading"; import FormSummaryLabel from "./FormSummaryLabel"; import FormSummaryValue from "./FormSummaryValue"; interface FormSummaryComponent extends React.ForwardRefExoticComponent<FormSummaryProps & React.RefAttributes<HTMLDivElement>> { /** * Must include `<FormSummary.Heading>`. */ Header: typeof FormSummaryHeader; /** * Typographic Heading to use in the `FormSummary.Header` component. */ Heading: typeof FormSummaryHeading; /** * Link to edit the answers to use in the `FormSummary.Footer` component. Should link to the relevant part of the form. */ EditLink: typeof FormSummaryEditLink; /** * Wrapper component for the answers. */ Answers: typeof FormSummaryAnswers; /** * Wrapper component for each answer. To be used in the `FormSummary.Answers` component. */ Answer: typeof FormSummaryAnswer; /** * Corresponds to the question in the form. To be used in the `FormSummary.Answer` component. */ Label: typeof FormSummaryLabel; /** * Corresponds to the answer in the form. To be used in the `FormSummary.Answer` component. */ Value: typeof FormSummaryValue; /** * Footer component for the form summary, if applicable this is a good place for `<FormSummary.EditLink>`. */ Footer: typeof FormSummaryFooter; } export interface FormSummaryProps extends HTMLAttributes<HTMLDivElement> { /** * Must include: * * - `<FormSummary.Header>` * - `<FormSummary.Answers>` * - `<FormSummary.Footer>` (optional) */ children: React.ReactNode; } /** * A summary of a previously answered form. * * @see [📝 Documentation](https://aksel.nav.no/komponenter/core/formsummary) * * @example * <FormSummary> * <FormSummary.Header> * <FormSummary.Heading level="2">HeadingTekst</FormSummary.Heading> * </FormSummary.Header> * <FormSummary.Answers> * <FormSummary.Answer> * <FormSummary.Label>Navn</FormSummary.Label> * <FormSummary.Value>Ola Nordmann</FormSummary.Value> * </FormSummary.Answer> * </FormSummary.Answers> * <FormSummary.Footer> * <FormSummary.EditLink href="#" /> * </FormSummary.Footer> * </FormSummary> */ export declare const FormSummary: FormSummaryComponent; export default FormSummary;