@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
48 lines (47 loc) • 1.69 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes, PropsWithChildren } from 'react';
import type { HintProps } from '../Hint';
export type FieldSetProps = {
/**
* Whether the fieldset is nested inside another fieldset.
* This will show the legend in a lighter style.
*/
inFieldSet?: boolean;
/** Whether the field set has an input with a validation error. */
invalid?: boolean;
/** The text for the caption. */
legend: string;
/**
* Render a level 1 heading in the legend.
* Set this if the Field Set is the only content of the page.
*/
legendIsPageHeading?: boolean;
} & HintProps & PropsWithChildren<HTMLAttributes<HTMLFieldSetElement>>;
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-forms-field-set--docs Field Set docs at Amsterdam Design System}
*/
export declare const FieldSet: import("react").ForwardRefExoticComponent<{
/**
* Whether the fieldset is nested inside another fieldset.
* This will show the legend in a lighter style.
*/
inFieldSet?: boolean;
/** Whether the field set has an input with a validation error. */
invalid?: boolean;
/** The text for the caption. */
legend: string;
/**
* Render a level 1 heading in the legend.
* Set this if the Field Set is the only content of the page.
*/
legendIsPageHeading?: boolean;
} & {
hint?: string;
inFieldSet?: boolean;
optional?: boolean;
} & HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & HTMLAttributes<HTMLFieldSetElement> & import("react").RefAttributes<HTMLFieldSetElement>>;