Import
import { Workbench } from '@contentful/f36-workbench';
Props (API reference)
Open in StorybookWorkbench
Name | Type | Default |
|---|---|---|
| children required | ReactNode | |
| className | string CSS class to be appended to the root element | |
| testId | string A [data-test-id] attribute used for testing purposes |
Workbench.Header
Name | Type | Default |
|---|---|---|
| title required | string ReactElement<any, string | JSXElementConstructor<any>> This is the title that will be shown inside the Header component | |
| actions | string number false true {} ReactElement<any, string | JSXElementConstructor<any>> ReactNodeArray ReactPortal It's possible to pass a ReactNode to be shown at the end of the Header | |
| className | string CSS class to be appended to the root element | |
| description | string number false true {} ReactElement<any, string | JSXElementConstructor<any>> ReactNodeArray ReactPortal This is the text that will be shown on the right side of the title in the Header component | |
| icon | ExoticComponent<any> ComponentClass<any, any> FunctionComponent<any> ReactElement<any, string | JSXElementConstructor<any>> This is the icon that will be shown on the left side of the title and it's possible to use Forma 36’s icons or external icons | |
| onBack | () => void If a function is passed to the onBack prop the Header will show a back button that will call this function when clicked | |
| testId | string A [data-test-id] attribute used for testing purposes | cf-ui-workbench-header |
Workbench.Content
Name | Type | Default |
|---|---|---|
| children required | ReactNode | |
| className | string CSS class to be appended to the root element | |
| css | string number false true ComponentSelector Keyframes SerializedStyles ArrayInterpolation<undefined> ObjectInterpolation<undefined> (theme: any) => Interpolation<undefined> | |
| testId | string A [data-test-id] attribute used for testing purposes | cf-ui-workbench-content |
| type | "text" "default" "full" This props define the max-width of the content container The default value is "default" which translates to `max-width: 1200px` in the browser | default |
Workbench.Sidebar
Name | Type | Default |
|---|---|---|
| children required | ReactNode | |
| className | string CSS class to be appended to the root element | |
| css | string number false true ComponentSelector Keyframes SerializedStyles ArrayInterpolation<undefined> ObjectInterpolation<undefined> (theme: any) => Interpolation<undefined> | |
| position | "left" "right" It sets the correct border style for the Sidebar | left |
| testId | string A [data-test-id] attribute used for testing purposes | cf-ui-workbench-sidebar |
Content guidelines
Header
The Header provides navigational guidance and primary actions on the current view.
- The Header should only provide actions which are global to the current view (e.g. Button to create a user on a users list view)
- When multiple global actions are needed a dropdown menu should be used
- Buttons that submit a form on the current view should not be placed in the title bar but be part of that specific form.
Main content
The main content area provides the main functionality of the current view.
Depending on the displayed information one of the 3 width configurations should be applied:
- Views that just consist of forms or text should have a maximum width of 768px for enhanced readability.
- Static table views which contents are not configurable should default to a maximum width of 1280px.
- Rich data views like dashboards or configurable tables should use the entire available width.
Sidebars
The left sidebar provides quick access to saved views and filters. The right sidebar provides secondary interactions depending on the current view as well as documentation spaces and entry points for extensibility.
- The left sidebar serves as secondary navigation and provides predefined and user-defined filters
- It should not include any view actions like adding or removing content