DialogButtonProps
SteamClientHomebrewSDK / client/src / DialogButtonProps
Interface: DialogButtonProps
Defined in: typescript-packages/client/src/components/Dialog.ts:12
Extends
Extended by
Properties
actionDescriptionMap?
optional actionDescriptionMap: ActionDescriptionMap;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:51
Inherited from
FooterLegendProps.actionDescriptionMap
children?
optional children: ReactNode;
Defined in: typescript-packages/client/src/components/Dialog.ts:9
Inherited from
className?
optional className: string;
Defined in: typescript-packages/client/src/components/Dialog.ts:8
Inherited from
disabled?
optional disabled: boolean;
Defined in: typescript-packages/client/src/components/Dialog.ts:28
Disables the button - assigned on* methods will not be invoked if clicked.
Depending on where it is, it might still get focus. In such case it can be partially disabled separately.
See
focusable.
focusable?
optional focusable: boolean;
Defined in: typescript-packages/client/src/components/Dialog.ts:37
Enables/disables the navigation based focus on button - you won't be able to navigate to it via the gamepad or keyboard.
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.
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
noFocusRing?
optional noFocusRing: boolean;
Defined in: typescript-packages/client/src/components/Dialog.ts:18
Enables/disables the focus around the button.
Default value depends on context, so setting it to false will enable it.
onButtonDown()?
optional onButtonDown: (evt) => void;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:57
Parameters
evt
Returns
void
Inherited from
FooterLegendProps.onButtonDown
onButtonUp()?
optional onButtonUp: (evt) => void;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:58
Parameters
evt
Returns
void
Inherited from
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
Returns
void
Inherited from
FooterLegendProps.onCancelButton
onGamepadBlur()?
optional onGamepadBlur: (evt) => void;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:65
Parameters
evt
Returns
void
Inherited from
FooterLegendProps.onGamepadBlur
onGamepadDirection()?
optional onGamepadDirection: (evt) => void;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:63
Parameters
evt
Returns
void
Inherited from
FooterLegendProps.onGamepadDirection
onGamepadFocus()?
optional onGamepadFocus: (evt) => void;
Defined in: typescript-packages/client/src/components/FooterLegend.ts:64
Parameters
evt
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
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
Returns
void
Inherited from
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
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
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
Inherited from
style?
optional style: CSSProperties;
Defined in: typescript-packages/client/src/components/Dialog.ts:7
Inherited from
Methods
onClick()?
optional onClick(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:39
Parameters
e
MouseEvent
Returns
void
onMouseDown()?
optional onMouseDown(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:43
Parameters
e
MouseEvent
Returns
void
onMouseUp()?
optional onMouseUp(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:44
Parameters
e
MouseEvent
Returns
void
onPointerCancel()?
optional onPointerCancel(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:42
Parameters
e
PointerEvent
Returns
void
onPointerDown()?
optional onPointerDown(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:40
Parameters
e
PointerEvent
Returns
void
onPointerUp()?
optional onPointerUp(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:41
Parameters
e
PointerEvent
Returns
void
onSubmit()?
optional onSubmit(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:48
Parameters
e
SubmitEvent
Returns
void
onTouchCancel()?
optional onTouchCancel(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:47
Parameters
e
TouchEvent
Returns
void
onTouchEnd()?
optional onTouchEnd(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:46
Parameters
e
TouchEvent
Returns
void
onTouchStart()?
optional onTouchStart(e): void;
Defined in: typescript-packages/client/src/components/Dialog.ts:45
Parameters
e
TouchEvent
Returns
void