DialogCheckboxProps

@steambrew/client v4.2.1

---

Interface: DialogCheckboxProps

Defined in: src/components/DialogCheckbox.ts:7

Extends

• DialogCommonProps.FooterLegendProps

Properties

actionDescriptionMap?

optional actionDescriptionMap: ActionDescriptionMap;

Defined in: src/components/FooterLegend.ts:53

Inherited from

FooterLegendProps.actionDescriptionMap

---

bottomSeparator?

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

Defined in: src/components/DialogCheckbox.ts:15

---

checked?

optional checked: boolean;

Defined in: src/components/DialogCheckbox.ts:17

---

children?

optional children: ReactNode;

Defined in: src/components/Dialog.ts:9

Inherited from

DialogCommonProps.children

---

className?

optional className: string;

Defined in: src/components/Dialog.ts:8

Inherited from

DialogCommonProps.className

---

color?

optional color: string;

Defined in: src/components/DialogCheckbox.ts:13

---

controlled?

optional controlled: boolean;

Defined in: src/components/DialogCheckbox.ts:16

---

description?

optional description: ReactNode;

Defined in: src/components/DialogCheckbox.ts:10

---

disabled?

optional disabled: boolean;

Defined in: src/components/DialogCheckbox.ts:11

---

highlightColor?

optional highlightColor: string;

Defined in: src/components/DialogCheckbox.ts:14

---

key?

optional key: null | Key;

Defined in: node_modules/@types/react/index.d.ts:137

Inherited from

DialogCommonProps.key

---

label?

optional label: ReactNode;

Defined in: src/components/DialogCheckbox.ts:9

---

onButtonDown()?

optional onButtonDown: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:59

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onButtonDown

---

onButtonUp()?

optional onButtonUp: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:60

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onButtonUp

---

onCancelActionDescription?

optional onCancelActionDescription: ReactNode;

Defined in: src/components/FooterLegend.ts:55

Inherited from

FooterLegendProps.onCancelActionDescription

---

onCancelButton()?

optional onCancelButton: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:62

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onCancelButton

---

onGamepadBlur()?

optional onGamepadBlur: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:67

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadBlur

---

onGamepadDirection()?

optional onGamepadDirection: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:65

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadDirection

---

onGamepadFocus()?

optional onGamepadFocus: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:66

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onGamepadFocus

---

onMenuActionDescription?

optional onMenuActionDescription: ReactNode;

Defined in: src/components/FooterLegend.ts:58

Inherited from

FooterLegendProps.onMenuActionDescription

---

onMenuButton()?

optional onMenuButton: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:68

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onMenuButton

---

onOKActionDescription?

optional onOKActionDescription: ReactNode;

Defined in: src/components/FooterLegend.ts:54

Inherited from

FooterLegendProps.onOKActionDescription

---

onOKButton()?

optional onOKButton: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:61

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onOKButton

---

onOptionsActionDescription?

optional onOptionsActionDescription: ReactNode;

Defined in: src/components/FooterLegend.ts:57

Inherited from

FooterLegendProps.onOptionsActionDescription

---

onOptionsButton()?

optional onOptionsButton: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:64

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onOptionsButton

---

onSecondaryActionDescription?

optional onSecondaryActionDescription: ReactNode;

Defined in: src/components/FooterLegend.ts:56

Inherited from

FooterLegendProps.onSecondaryActionDescription

---

onSecondaryButton()?

optional onSecondaryButton: (evt: GamepadEvent) => void;

Defined in: src/components/FooterLegend.ts:63

Parameters

evt

GamepadEvent

Returns

void

Inherited from

FooterLegendProps.onSecondaryButton

---

ref?

optional ref: Ref<HTMLDivElement>;

Defined in: node_modules/@types/react/index.d.ts:140

Inherited from

DialogCommonProps.ref

---

style?

optional style: CSSProperties;

Defined in: src/components/Dialog.ts:7

Inherited from

DialogCommonProps.style

---

tooltip?

optional tooltip: string;

Defined in: src/components/DialogCheckbox.ts:12

Methods

onChange()?

optional onChange(checked: boolean): void

Defined in: src/components/DialogCheckbox.ts:8

Parameters

checked

boolean

Returns

void

---

onClick()?

optional onClick(evt: Event): void

Defined in: src/components/DialogCheckbox.ts:18

Parameters

evt

Event

Returns

void