@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.
147 lines (146 loc) • 4.53 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { BreakpointCustomizable, CheckboxBlurEventDetail, CheckboxChangeEventDetail, CheckboxUpdateEventDetail, CheckboxState, Theme } from '../types';
export type PCheckboxProps = BaseProps & {
/**
* Reflects the checkbox current checked state and allows setting the initial checked state.
*/
checked?: boolean;
/**
* Displays as a compact version.
*/
compact?: boolean;
/**
* Marks the checkbox as disabled.
*/
disabled?: boolean;
/**
* The id of a form element the checkbox should be associated with.
*/
form?: string;
/**
* Show or hide label. For better accessibility, it's recommended to show the label.
*/
hideLabel?: BreakpointCustomizable<boolean>;
/**
* Marks the checkbox as indeterminate.
*/
indeterminate?: boolean;
/**
* The label text.
*/
label?: string;
/**
* @experimental Disables the checkbox and shows a loading indicator.
*/
loading?: boolean;
/**
* The message styled depending on validation state.
*/
message?: string;
/**
* The name of the checkbox.
*/
name?: string;
/**
* Emitted when the checkbox has lost focus.
*/
onBlur?: (event: CustomEvent<CheckboxBlurEventDetail>) => void;
/**
* Emitted when checkbox checked property is changed.
*/
onChange?: (event: CustomEvent<CheckboxChangeEventDetail>) => void;
/**
* Emitted when checkbox checked property is changed.
* @deprecated since v3.30.0, will be removed with next major release, use `change` event instead.
*/
onUpdate?: (event: CustomEvent<CheckboxUpdateEventDetail>) => void;
/**
* Marks the checkbox as required.
*/
required?: boolean;
/**
* The validation state.
*/
state?: CheckboxState;
/**
* Adapts the color depending on the theme.
*/
theme?: Theme;
/**
* The checkbox value. When a form is submitted, only a checkbox which is currently checked is included in the submission.
*/
value?: string;
};
export declare const PCheckbox: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Reflects the checkbox current checked state and allows setting the initial checked state.
*/
checked?: boolean;
/**
* Displays as a compact version.
*/
compact?: boolean;
/**
* Marks the checkbox as disabled.
*/
disabled?: boolean;
/**
* The id of a form element the checkbox should be associated with.
*/
form?: string;
/**
* Show or hide label. For better accessibility, it's recommended to show the label.
*/
hideLabel?: BreakpointCustomizable<boolean>;
/**
* Marks the checkbox as indeterminate.
*/
indeterminate?: boolean;
/**
* The label text.
*/
label?: string;
/**
* @experimental Disables the checkbox and shows a loading indicator.
*/
loading?: boolean;
/**
* The message styled depending on validation state.
*/
message?: string;
/**
* The name of the checkbox.
*/
name?: string;
/**
* Emitted when the checkbox has lost focus.
*/
onBlur?: (event: CustomEvent<CheckboxBlurEventDetail>) => void;
/**
* Emitted when checkbox checked property is changed.
*/
onChange?: (event: CustomEvent<CheckboxChangeEventDetail>) => void;
/**
* Emitted when checkbox checked property is changed.
* @deprecated since v3.30.0, will be removed with next major release, use `change` event instead.
*/
onUpdate?: (event: CustomEvent<CheckboxUpdateEventDetail>) => void;
/**
* Marks the checkbox as required.
*/
required?: boolean;
/**
* The validation state.
*/
state?: CheckboxState;
/**
* Adapts the color depending on the theme.
*/
theme?: Theme;
/**
* The checkbox value. When a form is submitted, only a checkbox which is currently checked is included in the submission.
*/
value?: string;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;