ButtonProps
Interface: ButtonProps
Defined in: src/components/Button.ts:5
Extends
Properties
actionDescriptionMap?
optional actionDescriptionMap: ActionDescriptionMap;
Defined in: src/components/FooterLegend.ts:53
Inherited from
DialogButtonProps.actionDescriptionMap
children?
optional children: ReactNode;
Defined in: src/components/Dialog.ts:9
Inherited from
className?
optional className: string;
Defined in: src/components/Dialog.ts:8
Inherited from
disabled?
optional disabled: boolean;
Defined in: src/components/Dialog.ts:30
Disables the button - assigned on* methods will not be invoked if clicked.
Note
Depending on where it is, it might still get focus. In such case it can be partially disabled separately.
See
focusable.
Inherited from
focusable?
optional focusable: boolean;
Defined in: src/components/Dialog.ts:40
Enables/disables the navigation based focus on button - you won't be able to navigate to it via the gamepad or keyboard.
Note
If set to false, it still can be clicked and WILL become focused until navigated away.
Depending on the context of where the button is, even a disabled button can focused.
Inherited from
key?
optional key: null | Key;
Defined in: node_modules/@types/react/index.d.ts:137
Inherited from
noFocusRing?
optional noFocusRing: boolean;
Defined in: src/components/Dialog.ts:19
Enables/disables the focus around the button.
Note
Default value depends on context, so setting it to false will enable it.
Inherited from
onButtonDown()?
optional onButtonDown: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:59
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onButtonDown
onButtonUp()?
optional onButtonUp: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:60
Parameters
evt
Returns
void
Inherited from
onCancelActionDescription?
optional onCancelActionDescription: ReactNode;
Defined in: src/components/FooterLegend.ts:55
Inherited from
DialogButtonProps.onCancelActionDescription
onCancelButton()?
optional onCancelButton: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:62
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onCancelButton
onGamepadBlur()?
optional onGamepadBlur: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:67
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onGamepadBlur
onGamepadDirection()?
optional onGamepadDirection: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:65
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onGamepadDirection
onGamepadFocus()?
optional onGamepadFocus: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:66
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onGamepadFocus
onMenuActionDescription?
optional onMenuActionDescription: ReactNode;
Defined in: src/components/FooterLegend.ts:58
Inherited from
DialogButtonProps.onMenuActionDescription
onMenuButton()?
optional onMenuButton: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:68
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onMenuButton
onOKActionDescription?
optional onOKActionDescription: ReactNode;
Defined in: src/components/FooterLegend.ts:54
Inherited from
DialogButtonProps.onOKActionDescription
onOKButton()?
optional onOKButton: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:61
Parameters
evt
Returns
void
Inherited from
onOptionsActionDescription?
optional onOptionsActionDescription: ReactNode;
Defined in: src/components/FooterLegend.ts:57
Inherited from
DialogButtonProps.onOptionsActionDescription
onOptionsButton()?
optional onOptionsButton: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:64
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onOptionsButton
onSecondaryActionDescription?
optional onSecondaryActionDescription: ReactNode;
Defined in: src/components/FooterLegend.ts:56
Inherited from
DialogButtonProps.onSecondaryActionDescription
onSecondaryButton()?
optional onSecondaryButton: (evt: GamepadEvent) => void;
Defined in: src/components/FooterLegend.ts:63
Parameters
evt
Returns
void
Inherited from
DialogButtonProps.onSecondaryButton
ref?
optional ref: Ref<HTMLDivElement>;
Defined in: node_modules/@types/react/index.d.ts:140
Inherited from
style?
optional style: CSSProperties;
Defined in: src/components/Dialog.ts:7
Inherited from
Methods
onClick()?
optional onClick(e: MouseEvent): void
Defined in: src/components/Dialog.ts:42
Parameters
e
MouseEvent
Returns
void
Inherited from
onMouseDown()?
optional onMouseDown(e: MouseEvent): void
Defined in: src/components/Dialog.ts:46
Parameters
e
MouseEvent
Returns
void
Inherited from
onMouseUp()?
optional onMouseUp(e: MouseEvent): void
Defined in: src/components/Dialog.ts:47
Parameters
e
MouseEvent
Returns
void
Inherited from
onPointerCancel()?
optional onPointerCancel(e: PointerEvent): void
Defined in: src/components/Dialog.ts:45
Parameters
e
PointerEvent
Returns
void
Inherited from
DialogButtonProps.onPointerCancel
onPointerDown()?
optional onPointerDown(e: PointerEvent): void
Defined in: src/components/Dialog.ts:43
Parameters
e
PointerEvent
Returns
void
Inherited from
DialogButtonProps.onPointerDown
onPointerUp()?
optional onPointerUp(e: PointerEvent): void
Defined in: src/components/Dialog.ts:44
Parameters
e
PointerEvent
Returns
void
Inherited from
onSubmit()?
optional onSubmit(e: SubmitEvent): void
Defined in: src/components/Dialog.ts:51
Parameters
e
SubmitEvent
Returns
void
Inherited from
onTouchCancel()?
optional onTouchCancel(e: TouchEvent): void
Defined in: src/components/Dialog.ts:50
Parameters
e
TouchEvent
Returns
void
Inherited from
DialogButtonProps.onTouchCancel
onTouchEnd()?
optional onTouchEnd(e: TouchEvent): void
Defined in: src/components/Dialog.ts:49
Parameters
e
TouchEvent
Returns
void
Inherited from
onTouchStart()?
optional onTouchStart(e: TouchEvent): void
Defined in: src/components/Dialog.ts:48
Parameters
e
TouchEvent
Returns
void