enact logoEnact
Edit on GitHub

sandstone/ActionGuide

Sandstone styled action guide component and behaviors.

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

Members

ActionGuideComponent

An Action Guide component, ready to use in Sandstone applications.

ActionGuide may be used to display text and icon to describe an action.

Usage:

<ActionGuide icon="arrowlargedown">Hello</ActionGuide>
import ActionGuide from '@enact/sandstone/ActionGuide';

ActionGuideBaseComponent

An Action Guide component.

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

import {ActionGuideBase} from '@enact/sandstone/ActionGuide';
Properties
children
String

The contents for the action guide.

css
Object

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:

  • actionGuide - The root component class

icon
String

The icon displayed within the action guide.

Default: 'arrowsmalldown'

ActionGuideDecoratorHigher-Order Component

Applies Sandstone specific behaviors to ActionGuide.

import {ActionGuideDecorator} from '@enact/sandstone/ActionGuide';
ArrayBooleanFunctionModuleNumberObjectString