@porsche-design-system/components-react
Version:
Porsche Design System is a component library designed to help developers create the best experience for software or services distributed by Dr. Ing. h.c. F. Porsche AG.
67 lines (66 loc) • 2.57 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { SelectedAriaRole, FieldsetLabelSize, FieldsetState } from '../types';
export type PFieldsetProps = BaseProps & {
/**
* Overrides the ARIA role on the fieldset — use `radiogroup` when grouping radio buttons.
*/
aria?: SelectedAriaRole<"radiogroup">;
/**
* Sets the visible legend text displayed above the grouped form controls.
* @default ''
*/
label?: string;
/**
* Sets the font size of the fieldset label (`small`, `medium`, or `large`).
* @default 'medium'
*/
labelSize?: FieldsetLabelSize;
/**
* Sets the validation feedback message displayed below the fieldset when `state` is `success` or `error`.
* @default ''
*/
message?: string;
/**
* Marks all controls within the fieldset as required and adds a required indicator to the label.
* @default false
*/
required?: boolean;
/**
* Sets the validation state of the fieldset, controlling the color and style of the feedback message.
* @default 'none'
*/
state?: FieldsetState;
};
export declare const PFieldset: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Overrides the ARIA role on the fieldset — use `radiogroup` when grouping radio buttons.
*/
aria?: SelectedAriaRole<"radiogroup">;
/**
* Sets the visible legend text displayed above the grouped form controls.
* @default ''
*/
label?: string;
/**
* Sets the font size of the fieldset label (`small`, `medium`, or `large`).
* @default 'medium'
*/
labelSize?: FieldsetLabelSize;
/**
* Sets the validation feedback message displayed below the fieldset when `state` is `success` or `error`.
* @default ''
*/
message?: string;
/**
* Marks all controls within the fieldset as required and adds a required indicator to the label.
* @default false
*/
required?: boolean;
/**
* Sets the validation state of the fieldset, controlling the color and style of the feedback message.
* @default 'none'
*/
state?: FieldsetState;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;