sandstone/Button

Sandstone styled button components and behaviors.

import Button from '@enact/sandstone/Button';

A button component, ready to use in Sandstone applications.

Usage:

<Button
backgroundOpacity="transparent"
size="small"
icon="home"
>
	Press me!
</Button>

import Button from '@enact/sandstone/Button';

A button component.

This component is most often not used directly but may be composed within another component as it is within Button.

import {ButtonBase} from '@enact/sandstone/Button';

backgroundOpacity: The background opacity of this button.
Text buttons and icon+text buttons, by default are opaque, while icon-only buttons default to transparent. This value can be overridden by setting this prop.
Valid values are: 'opaque', and 'transparent'.
Default: 'opaque'
color: The color of the underline beneath button's content.
Accepts one of the following color names, which correspond with the colored buttons on a standard remote control: 'red', 'green', 'yellow', 'blue'.
css: Customizes the component by mapping the supplied collection of CSS class names to the corresponding internal elements and states of this component.
The following classes are supported:
button - The root class name
bg - The background node of the button
large - Applied to a size='large' button
selected - Applied to a selected button
small - Applied to a size='small' button
iconPosition: Specifies on which side ('before' or 'after') of the text the icon appears.
Default: 'before'
minWidth: Boolean controlling whether this component should enforce the "minimum width" rules.
NOTE: If you don't specify this prop, it works as false for icon only Button and as true for other Buttons.
size: The size of the button.
Default: 'large'

Applies Sandstone specific behaviors to Button components.

import {ButtonDecorator} from '@enact/sandstone/Button';

Variable Types Key:ArrayBooleanFunctionModuleNumberObjectString