Anatomy
Learn about the individual parts of activity stream compose.
- Header: Area of the component holding the title and settings menu.
- Title: Title of the component.
- Settings menu: Menu holding permission managed features.
- Tabs: Default view of the available journal fields.
- Rich text editor: When configured, RTE is available in the text box.
- Footer: Area of the component holding hint text and action buttons associated with the journal field.
- Hint text (optional): Hint text is shown in the footer for a particular journal field.
- Stacked view toggle: Allows a user to view journal fields in stacked or tabbed views.
- Rich text editor toggle (optional): Allows a user to turn the rich text editor on or off.
- Side-by-side editing toggle: Side-by-side mode allows the user to change the view.
Usage
The activity stream compose component displays journal fields as text boxes for users, who can post text to the record by selecting the post action button.
Configurations
Learn how to customize activity stream by configuring the available properties.
Title
You can change the title as desired. You can also choose to hide the title. The default title is "Compose." The rich text editor must be configured to display.
Presets and controllers
This component contains a preset configuration that automatically configures properties and event handlers for a component, making the component ready to work when you add it to a page. A preset is designed to suit a specific use case. However, you can override preset property values with a custom configuration if you find it necessary for your design. Preset values that you override aren’t upgraded when updates are available. If you don’t want to use the preset values provided, select the option to configure the component manually. You can apply one preset to a single instance of a component on a page. For more information, see Presets.
A preset is always associated with a controller, which acts as a data resource for the component. Controllers provide the configuration data and event bindings the component needs to function in your experience. By selecting a preset, the required controller is added to the page. By adding a controller to the page, any new applicable components will have that controller's preset. For more information about how controllers work, see Controllers. For instructions on using the data inspector to view the default presets for a component, see View properties and events in the Controller API.
Post button
By default, the post button is styled as a tertiary button. However, you can configure this property to style the button as primary, secondary, or tertiary as needed.
Design recommendations
Learn how to apply the activity stream compose component in your design.
Make sure you place the activity stream compose component inside the context of a record.
Don't place the activity stream compose component outside the context of a record.
UI text guidelines
These are some recommendations for using text within the activity stream compose component.
- Use sentence case for all titles, labels, and column headers
- Keep all text labels informative and short to increase readability and scanning
- Keep content concise and purposeful to help a user understand options and actions
- Capitalize only the first letter and any proper nouns in a string of text
- Ensure content is contextual and specific to offer guidance and support to the user
Behavior
Learn how the activity stream compose component behaves when the display changes or a user interacts with the component.
Responsive behaviors
The activity stream compose component automatically resizes to fit a container.
Interactions
Clicking the settings icon opens a menu of viewing options. By default, only the stacked view option displays, which toggles between the stacked and tabbed journal entry views.
If the rich text editor is configured on, then the option is shown in the menu. When available, this toggle shows or hides the rich text editor bar.
Resizing
When text in the activity stream compose text box exceeds the default width and height of the content area, the text box size increases. Once it reaches its maximum height, a scroll bar appears.
Usability
The activity stream compose component complies with all internationalization and accessibility requirements.
Internationalization
When the display translates to a right-to-left (RTL) language, the fields and button sets align on the right. Any proper nouns that can't be translated appear left-to-right (LTR).
Accessibility
Learn how to access the actionable elements of the activity stream compose component through keyboard interactions.
Keyboard interactions
You can access the actionable elements of the activity stream compose component with these keyboard keys:
- Tab: Moves through activity stream compose in the prescribed tab order
- Shift + Tab: Moves through activity stream compose in reverse tab order
- Space/Enter: Opens a menu or activates a button
When the focus is in a menu:
- Up and down arrow keys: Moves within the menu
- Tab: Closes the menu