code/tamagui.dev/data/docs/components/select/2.0.0.mdx
<Highlights
features={[
Comes with styling, yet completely customizable and themeable.,
Accepts animations, themes, size props and more.,
Accessible, keyboard navigable, full-featured.,
]}
/>
Select provides a dropdown menu for choosing from a list of options. It's fully accessible with keyboard navigation, supports typeahead search, and automatically stacks above other content.
Select is already installed in tamagui, or you can install it independently:
npm install @tamagui/select
import { Select } from 'tamagui' // or '@tamagui/select'
export default () => (
<Select defaultValue="">
<Select.Trigger>
<Select.Value placeholder="Search..." />
</Select.Trigger>
<Select.FocusScope loop trapped focusOnIdle={true}>
<Select.Content>
<Select.ScrollUpButton />
<Select.Viewport>
<Select.Group>
<Select.Label />
<Select.Item>
<Select.ItemText />
</Select.Item>
</Select.Group>
</Select.Viewport>
<Select.ScrollDownButton />
</Select.Content>
</Select.FocusScope>
</Select>
)
Contains every component for the select:
<PropsTable
data={[
{
name: 'id',
type: 'string',
description: Optional for usage with Label.,
},
{
name: 'size',
type: 'SizeTokens',
description: Set the size of itself and pass to all inner elements.,
},
{
name: 'children',
type: 'React.ReactNode',
description: Select children API components.,
},
{
name: 'value',
type: 'string',
description: Controlled value.,
},
{
name: 'defaultValue',
type: 'string',
description: Default value.,
},
{
name: 'onValueChange',
type: '(value: string) => void',
description: Callback on value change.,
},
{
name: 'open',
type: 'boolean',
description: Controlled open value.,
},
{
name: 'defaultOpen',
type: 'boolean',
description: Default open value.,
},
{
name: 'onOpenChange',
type: '(open: boolean) => void',
description: Callback on open change.,
},
{
name: 'dir',
type: 'Direction',
description: Direction of text display.,
},
{
name: 'name',
type: 'string',
description: For use in forms.,
},
{
name: 'native',
type: 'NativeValue',
description: If passed, will render a native component instead of the custom one. Currently only \web` is supported., }, { name: 'renderValue', type: '(value: string) => ReactNode', description: Render function for the selected value. Useful for SSR when you need custom display text. By default, Select falls back to showing the raw value for SSR compatibility., }, { name: 'lazyMount', type: 'boolean', default: 'false', description: When true, defers mounting Select items until opened using React's startTransition. Significantly improves initial render performance for pages with many Selects. Should be combined with `renderValue` for best results., }, { name: 'zIndex', type: 'number', description: z-index for the select portal. Use when select dropdowns need to appear above other portaled content like dialogs or fixed headers. Defaults to automatic stacking (~100000).`,
},
]}
/>
Extends ListItem to give sizing, icons, and more.
Extends Paragraph, adding:
<PropsTable
data={[
{
name: 'placeholder',
type: 'string',
description: Optional placeholder to show when no value selected.,
},
]}
/>
Main container for Select content, used to contain the up/down arrows, no API beyond children.
Inside Content first, displays when you can scroll up, stuck to the top.
Extends YStack.
Inside Content last, displays when you can scroll down, stuck to the bottom.
Extends YStack.
Extends ThemeableStack. Contains scrollable content items as children.
<PropsTable
data={[
{
name: 'disableScroll',
type: 'boolean',
description: Removes ability to scroll and all style and functionality related to scrolling.,
},
{
name: 'unstyled',
type: 'boolean',
description: Removes all default styles.,
},
]}
/>
Extends YStack. Use only when grouping together items, alongside a Label as the first child.
Extends SizableText. Used to label Groups. Includes size-based padding and minHeight for consistent appearance with other Select items.
Extends ListItem. Used to add selectable values to the list. Must provide an index as React Native doesn't give any escape hatch for us to configure that automatically.
<PropsTable
data={[
{
name: 'index',
type: 'number',
required: true,
description: Incrementally starting from 0, matching its appearance in the list.,
},
{
name: 'value',
type: 'string',
description: `Provide a value that will be passed on selection.`,
},
]} />
Extends Paragraph. Used inside Item to provide unselectable text that will show above once selected in the parent Select.
An animated indicator that highlights the currently focused item. Place it inside Select.Viewport to enable a smooth sliding highlight animation as users navigate through options.
<Select.Viewport>
<Select.Indicator transition="quick" />
<Select.Group></Select.Group>
</Select.Viewport>
Use the transition prop to control the animation speed. You can use any animation name from your config like quick, quicker, or quickest.
Provides access to the underlying FocusScope component used by Select for focus management. Can be used to control focus behavior from a parent component.
<PropsTable
data={[
{
name: 'enabled',
type: 'boolean',
default: 'true',
description: Whether focus management is enabled.,
},
{
name: 'loop',
type: 'boolean',
default: 'false',
description: When true, tabbing from last item will focus first tabbable and shift+tab from first item will focus last tabbable.,
},
{
name: 'trapped',
type: 'boolean',
default: 'false',
description: When true, focus cannot escape the focus scope via keyboard, pointer, or programmatic focus.,
},
{
name: 'focusOnIdle',
type: 'boolean | number',
default: 'false',
description: When true, waits for idle before focusing. When a number, waits that many ms. This prevents reflows during animations.,
},
{
name: 'onMountAutoFocus',
type: '(event: Event) => void',
description: Event handler called when auto-focusing on mount. Can be prevented.,
},
{
name: 'onUnmountAutoFocus',
type: '(event: Event) => void',
description: Event handler called when auto-focusing on unmount. Can be prevented.,
},
]}
/>
For pages with many Select components, you can significantly improve initial render performance by using the lazyMount prop combined with renderValue:
const labels = {
apple: 'Apple',
orange: 'Orange',
banana: 'Banana',
}
<Select
lazyMount
renderValue={(value) => labels[value]}
defaultValue="apple"
>
<Select.Trigger>
<Select.Value />
</Select.Trigger>
<Select.Content>
<Select.Viewport>
<Select.Item index={0} value="apple">
<Select.ItemText>Apple</Select.ItemText>
</Select.Item>
</Select.Viewport>
</Select.Content>
</Select>
How it works:
lazyMount defers mounting all Select items until the dropdown is first openedstartTransition, keeping the trigger responsiverenderValue provides the display text synchronously, avoiding the need to mount items just to show the selected valueThis is especially useful when rendering many Selects on a single page, as each Select with 20+ items would otherwise mount all those items on initial page load.
When used alongside <Adapt />, Select will render as a sheet when that breakpoint is active.
This is the only way to render a Select on Native for now, as mobile apps tend to show Select very differently from web and Tamagui wants to present the right abstractions for each platform.
See Sheet for more props.
Must use Select.Adapt.Contents inside the Select.Sheet.Frame to insert the contents given to Select.Content
import { Select } from 'tamagui' // or '@tamagui/select'
export default () => (
<Select defaultValue="">
<Select.Trigger>
<Select.Value placeholder="Search..." />
</Select.Trigger>
<Adapt when="max-md" platform="touch">
<Sheet>
<Sheet.Frame>
<Adapt.Contents />
</Sheet.Frame>
<Sheet.Overlay />
</Sheet>
</Adapt>
<Select.Content>
<Select.ScrollUpButton />
<Select.Viewport>
<Select.Group>
<Select.Label />
<Select.Item>
<Select.ItemText />
</Select.Item>
</Select.Group>
</Select.Viewport>
<Select.ScrollDownButton />
</Select.Content>
</Select>
)