Skip to main content

Interface: SettingItemProperties

Defined in: src/components/shared/SettingItem.tsx:14

Props for the SettingItem component

Hierarchy​

View Summary

Extends​

Properties​

children?​

readonly optional children?: ReactNode;

Defined in: shared/types/componentProps.ts:36

Component content (text, elements, or other components)

Inherited from​

CoreComponentProperties.children

className?​

readonly optional className?: string;

Defined in: shared/types/componentProps.ts:38

Additional CSS classes for styling customization

Inherited from​

CoreComponentProperties.className

control​

readonly control:
  | ReactNode
  | (() => ReactNode);

Defined in: src/components/shared/SettingItem.tsx:22

Control component (input, select, checkbox, etc.).

Remarks​

A render callback is supported to avoid passing JSX as a prop in places where strict performance lint rules are enabled.

description?​

readonly optional description?: string;

Defined in: src/components/shared/SettingItem.tsx:24

Description of the setting

disabled?​

readonly optional disabled?: boolean;

Defined in: src/components/shared/SettingItem.tsx:26

Whether the setting is disabled

Overrides​

CoreComponentProperties.disabled

icon?​

readonly optional icon?: ReactNode;

Defined in: src/components/shared/SettingItem.tsx:28

Optional leading icon for the setting title

iconClassName?​

readonly optional iconClassName?: string;

Defined in: src/components/shared/SettingItem.tsx:33

Optional className forwarded to the icon element (e.g., settings accent colors).

iconComponent?​

readonly optional iconComponent?: IconType;

Defined in: src/components/shared/SettingItem.tsx:38

Preferred icon API: pass an IconType instead of JSX to avoid jsx-as-prop perf lint issues.

iconSize?​

readonly optional iconSize?: number;

Defined in: src/components/shared/SettingItem.tsx:40

Optional icon size (px). Defaults to 16.

title​

readonly title: string;

Defined in: src/components/shared/SettingItem.tsx:42

Title of the setting