packages/react-components/react-button/library/README.md
Button components for Fluent UI React
To import Button:
import { Button, CompoundButton, MenuButton, SplitButton, ToggleButton } from '@fluentui/react-components';
<Button>Submit</Button>
<Button icon={<SVGIcon />} />
<Button icon={<SVGIcon />}>Submit</Button>
<Button icon={<SVGIcon />} iconPosition="after">Submit</Button>
<Button appearance="primary">Submit</Button>
<Button disabled>Submit</Button>
<Button size="small">Submit</Button>
<Button size="large">Submit</Button>
<CompoundButton icon={<CalendarMonth />} secondaryContent="Secondary content" {...props}>
Example
</CompoundButton>
<Menu>
<MenuTrigger>
<MenuButton>Example</MenuButton>
</MenuTrigger>
<MenuPopover>
<MenuList>
<MenuItem>Item a</MenuItem>
<MenuItem>Item b</MenuItem>
</MenuList>
</MenuPopover>
</Menu>
<Menu positioning="below-end">
<MenuTrigger>
{(triggerProps: MenuButtonProps) => <SplitButton menuButton={triggerProps}>Example</SplitButton>}
</MenuTrigger>
<MenuPopover>
<MenuList>
<MenuItem>Item a</MenuItem>
<MenuItem>Item b</MenuItem>
</MenuList>
</MenuPopover>
</Menu>
<ToggleButton>Toggle volume</ToggleButton>
<ToggleButton defaultChecked={true}>Toggle volume</ToggleButton>
<ToggleButton checked={true}>Toggle volume</ToggleButton>
<ToggleButton checked={false}>Toggle volume</ToggleButton>
See Fluent UI Storybook for more detailed usage examples.
Alternatively, run Storybook locally with:
yarn startreact-button from the list.See SPEC.md.
If you're upgrading to Fluent UI v9 see MIGRATION.md for guidance on updating to the latest component implementations.