sandstone/Panels

Set of functions that control how the panels are transitioned into and out of the viewport.

Hint string read when focusing the back button.

Background opacity of the application back button.

Panel to be rendered

Hint string read when focusing the application close button.

Background opacity of the application close button.

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:

• panels - The root class name

• viewport - The node containing the panel instances

Unique identifier for the Panels instance.

When defined, Panels will manage the presentation state of Panel instances in order to restore it when returning to the Panel. See noSharedState for more details on shared state.

Index of the active panel

Disables panel transitions.

Omits the back button.

Omits the close button.

Prevents maintaining shared state for framework components within this Panels instance.

When false, each Panel will track the state of some framework components in order to restore that state when the Panel is recreated. For example, the scroll position of a sandstone/Scroller within a Panel will be saved and restored when returning to that Panel.

This only applied when navigating "back" (to a lower index) to Panel. When navigating "forwards" (to a higher index), the Panel and its contained components will use their default state.

Called with cancel/back key events.

Called when the app close button is clicked.

Called once when all panels have completed their transition.

Called once before panels begin their transition.

Sets the hint string read when focusing the back button.

Background opacity of the application back button.

Centers the contents of the Header.

This setting does not affect slotBefore or slotAfter.

Children provided are added to the header-components area.

A space for controls which live in the header, apart from the body of the panel view.

Hint string read when focusing the application close button.

Background opacity of the application close button.

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:

• header - The root class name

Determines what triggers the header content to start its animation.

Omits the back button.

Omits the close button.

Called with cancel/back key events.

Called when the app close button is clicked.

A location for arbitrary elements to be placed above the title

This is a slot, so it can be used as a tag-name inside this component.

<Header>
	<slotAbove><Button /></slotAbove>
	<title>My Title</title>
</Header>

A location for arbitrary elements to be placed to the right the title in LTR locales and to the left in RTL locales

This is a slot, so it can be used as a tag-name inside this component.

<Header>
	<title>My Title</title>
	<slotAfter><Button /></slotAfter>
</Header>

A location for arbitrary elements to be placed to the left the title in LTR locales and to the right in RTL locales

This is a slot, so it can be used as a tag-name inside this component.

<Header>
	<slotBefore><Button /></slotBefore>
	<title>My Title</title>
</Header>

Text displayed below the title.

This is a slot, so it can be used as a tag-name inside this component.

Title of the header.

This is a slot, so it can be used as a tag-name inside this component.

Example:

 <Header>
 	<title>Example Header Title</title>
 	<subtitle>The Adventure Continues</subtitle>
 </Header>

Set the type of header to be used.

Sets the strategy used to automatically focus an element within the panel upon render.

• "none" - Automatic focus is disabled

• "last-focused" - The element last focused in the panel with be restored

• "default-element" - The first spottable component within the body will be focused

• Custom Selector - A custom CSS selector may also be provided which will be used to find the target within the Panel

When used within Panels, this prop may be set by Panels to "default-element" when navigating "forward" to a higher index. This behavior may be overridden by setting autoFocus on the Panel instance as a child of Panels or by wrapping Panel with a custom component and overriding the value passed by Panels.

// Panel within CustomPanel will always receive "last-focused"
const CustomPanel = (props) => <Panel {...props} autoFocus="last-focused" />;

// The first panel will always receive "last-focused". The second panel will receive
// "default-element" when navigating from the first panel but `autoFocus` will be unset
// when navigating from the third panel and as a result will default to "last-focused".
const MyPanels = () => (
  <Panels>
    <Panel autoFocus="last-focused" />
    <Panel />
    <Panel />
  </Panels>
);

The "aria-label" for the Panel.

By default, the panel will be labeled by its Header. When aria-label is set, it will be used instead to provide an accessibility label for the panel.

Obtains a reference to the root node.

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:

• panel - The root class name

• body - The node containing the panel's children

Header for the panel.

This is usually passed by the Slottable API by using a Header component as a child of the Panel.

Hides the body components.

When a Panel is used within Panels this property will be set automatically to true on render and false after animating into view.

Prevents the component from restoring any framework shared state.

When false, the default, Panel will store state for some framework components in order to restore that state when returning to the Panel. Setting this prop to true will suppress that behavior and not store or retrieve any framework component state.