Skip to main content

DialogCheckboxProps

SteamClientHomebrewSDK v1.0.0


SteamClientHomebrewSDK / client/src / DialogCheckboxProps

Interface: DialogCheckboxProps

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:7

Extends

Properties

actionDescriptionMap?

optional actionDescriptionMap: ActionDescriptionMap;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:51

Inherited from

FooterLegendProps.actionDescriptionMap


bottomSeparator?

optional bottomSeparator: "standard" | "thick" | "none";

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:15


checked?

optional checked: boolean;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:17


children?

optional children: ReactNode;

Defined in: typescript-packages/client/src/components/Dialog.ts:9

Inherited from

DialogCommonProps.children


className?

optional className: string;

Defined in: typescript-packages/client/src/components/Dialog.ts:8

Inherited from

DialogCommonProps.className


color?

optional color: string;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:13


controlled?

optional controlled: boolean;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:16


description?

optional description: ReactNode;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:10


disabled?

optional disabled: boolean;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:11


highlightColor?

optional highlightColor: string;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:14


key?

optional key: null | Key;

Defined in: node_modules/.pnpm/@types+react@18.3.3/node_modules/@types/react/index.d.ts:261

Inherited from

DialogCommonProps.key


label?

optional label: ReactNode;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:9


onButtonDown()?

optional onButtonDown: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:57

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onButtonDown


onButtonUp()?

optional onButtonUp: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:58

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onButtonUp


onCancelActionDescription?

optional onCancelActionDescription: ReactNode;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:53

Inherited from

FooterLegendProps.onCancelActionDescription


onCancelButton()?

optional onCancelButton: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:60

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onCancelButton


onGamepadBlur()?

optional onGamepadBlur: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:65

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadBlur


onGamepadDirection()?

optional onGamepadDirection: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:63

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadDirection


onGamepadFocus()?

optional onGamepadFocus: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:64

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadFocus


onMenuActionDescription?

optional onMenuActionDescription: ReactNode;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:56

Inherited from

FooterLegendProps.onMenuActionDescription


onMenuButton()?

optional onMenuButton: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:66

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onMenuButton


onOKActionDescription?

optional onOKActionDescription: ReactNode;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:52

Inherited from

FooterLegendProps.onOKActionDescription


onOKButton()?

optional onOKButton: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:59

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onOKButton


onOptionsActionDescription?

optional onOptionsActionDescription: ReactNode;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:55

Inherited from

FooterLegendProps.onOptionsActionDescription


onOptionsButton()?

optional onOptionsButton: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:62

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onOptionsButton


onSecondaryActionDescription?

optional onSecondaryActionDescription: ReactNode;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:54

Inherited from

FooterLegendProps.onSecondaryActionDescription


onSecondaryButton()?

optional onSecondaryButton: (evt) => void;

Defined in: typescript-packages/client/src/components/FooterLegend.ts:61

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onSecondaryButton


ref?

optional ref: LegacyRef<HTMLDivElement>;

Defined in: node_modules/.pnpm/@types+react@18.3.3/node_modules/@types/react/index.d.ts:303

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See

React Docs

Inherited from

DialogCommonProps.ref


style?

optional style: CSSProperties;

Defined in: typescript-packages/client/src/components/Dialog.ts:7

Inherited from

DialogCommonProps.style


tooltip?

optional tooltip: string;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:12

Methods

onChange()?

optional onChange(checked): void;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:8

Parameters

checked

boolean

Returns

void


onClick()?

optional onClick(evt): void;

Defined in: typescript-packages/client/src/components/DialogCheckbox.ts:18

Parameters

evt

Event

Returns

void