Button

A sizeable, themeable button

Usage

When using the simple Button API, it's as simple as this:

import { Button } from 'tamagui'

export default () => <Button>Lorem ipsum</Button>

Sizing

Sizing buttons provides a unique challenge especially for a compiler, because you need to adjust many different properties - not just on the outer frame, but on the text wrapped inside. Tamagui supports adjusting the padding, border radius, font size and icons sizes all in one with the size prop.

import { Button } from 'tamagui'

export default () => <Button size="$6">Lorem ipsum</Button>

Given your theme defines a size 6, the button will adjust all of the properties appropriately. You can also pass a plain number to get an arbitrary size.

Icon Theming

You can pass icons as either elements or components. If passing components, Tamagui will automatically pass the size and color prop to them based on your theme.

You can use the source of Button itself  to see in more detail what variants you can override, and how we use this pattern internally to create our Button component.

Creating your own Button

Tamagui now has all the features necessary to make creating a custom Button easy enough that you don't really need to use our Button at all as a base.

Learn how to do it with our dedicated guide, How to Build a Button.

API Reference

Buttons extend Stack views inheriting all the Tamagui standard props, plus: