ButtonProps
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface ButtonProps
extends CommonComponentProps,
SlottedComponentProps<
ButtonSlots,
{ readonly focused: boolean; readonly disabled: boolean }
> {
readonly children?: ReactNode;
readonly onPress?: () => void | Promise<void>;
readonly command?: string;
readonly hotkeys?: readonly string[];
readonly autoFocus?: boolean;
readonly prefix?: ReactNode;
readonly suffix?: ReactNode;
readonly focusOrder?: number;
readonly focusScopeId?: string;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
children | ReactNode | No | The children member uses the ReactNode contract. | — |
onPress | (() => void | Promise<void>) | undefined | No | The onPress member uses the (() => void | Promise<void>) | undefined contract. | — |
command | string | undefined | No | The command member uses the string | undefined contract. | — |
hotkeys | readonly string[] | undefined | No | The hotkeys member uses the readonly string[] | undefined contract. | — |
autoFocus | boolean | undefined | No | The autoFocus member uses the boolean | undefined contract. | — |
prefix | ReactNode | No | The prefix member uses the ReactNode contract. | — |
suffix | ReactNode | No | The suffix member uses the ReactNode contract. | — |
focusOrder | number | undefined | No | The focusOrder member uses the number | undefined contract. | — |
focusScopeId | string | undefined | No | The focusScopeId member uses the string | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").BoxProps; label: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; prefix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; suffix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").BoxProps; label: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; prefix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; suffix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; }>> | undefined contract. | BoxProps, SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").BoxProps; label: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; prefix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; suffix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; }, { readonly focused: boolean; readonly disabled: boolean; }>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").BoxProps; label: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; prefix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; suffix: import(".bun/ink@7.1.1+fb5bfe3da9a88d96/node_modules/ink").TextProps; }, { readonly focused: boolean; readonly disabled: boolean; }>> | undefined contract. | BoxProps, SlotProps, TextProps |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference