FieldProps

@steambrew/client v4.2.1

---

Interface: FieldProps

Defined in: src/components/Field.ts:6

Extends

• 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/Field.ts:9

---

children?

optional children: ReactNode;

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

---

childrenContainerWidth?

optional childrenContainerWidth: "min" | "max" | "fixed";

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

---

childrenLayout?

optional childrenLayout: "below" | "inline";

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

---

className?

optional className: string;

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

---

description?

optional description: ReactNode;

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

---

disabled?

optional disabled: boolean;

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

---

focusable?

optional focusable: boolean;

Defined in: src/components/Field.ts:22

---

highlightOnFocus?

optional highlightOnFocus: boolean;

Defined in: src/components/Field.ts:19

---

icon?

optional icon: ReactNode;

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

---

indentLevel?

optional indentLevel: number;

Defined in: src/components/Field.ts:20

---

inlineWrap?

optional inlineWrap: "keep-inline" | "shift-children-below";

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

---

label?

optional label: ReactNode;

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

---

onActivate()?

optional onActivate: (e: MouseEvent | CustomEvent) => void;

Defined in: src/components/Field.ts:23

Parameters

e

MouseEvent | CustomEvent

Returns

void

---

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

---

onClick()?

optional onClick: (e: MouseEvent | CustomEvent) => void;

Defined in: src/components/Field.ts:24

Parameters

e

MouseEvent | CustomEvent

Returns

void

---

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

---

padding?

optional padding: "standard" | "none" | "compact";

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

---

spacingBetweenLabelAndChild?

optional spacingBetweenLabelAndChild: "none";

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

---

verticalAlignment?

optional verticalAlignment: "none" | "center";

Defined in: src/components/Field.ts:21