# Button

Source: /tuil/docs/reference/packages/ink/api/button
Locale: en

function exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function Button({
  children,
  onPress,
  command,
  hotkeys = emptyHotkeys,
  autoFocus,
  focusOrder,
  focusScopeId,
  slots,
  slotProps,
  disabled = false,
  readOnly = false,
  prefix,
  suffix,
  variant = "solid",
  size,
  unstyled,
  className,
  ...props
}: ButtonProps): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                                                                                                                                                                                                                                    | Type          | Required | Description                                                                                                                                                                                                                                                                                                    | Related types                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `{   children,   onPress,   command,   hotkeys = emptyHotkeys,   autoFocus,   focusOrder,   focusScopeId,   slots,   slotProps,   disabled = false,   readOnly = false,   prefix,   suffix,   variant = "solid",   size,   unstyled,   className,   ...props }` | `ButtonProps` | Yes      | Supplies the `{   children,   onPress,   command,   hotkeys = emptyHotkeys,   autoFocus,   focusOrder,   focusScopeId,   slots,   slotProps,   disabled = false,   readOnly = false,   prefix,   suffix,   variant = "solid",   size,   unstyled,   className,   ...props }` value as `ButtonProps`. | [`ButtonProps`](/tuil/docs/reference/packages/ink/api/button-props) |

## Returns [#returns]

`ReactNode` — Returns a value that satisfies `ReactNode`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`ButtonProps`](/tuil/docs/reference/packages/ink/api/button-props)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/components.tsx)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)