Skip to content
Patternfly Logo

Code block

A code block is a component that contains two or more lines of ready-only code. The code in a code block can be copied to the clipboard.

Elements

Code block has four main components.

Elements of the code block component
  1. Code snippet: the content that will be copied to the user’s clipboard.
  2. Action buttons: completes an action when clicked. The copy button is always present but additional action buttons can be added on an as needed basis.
  3. Tooltip: informs users that clicking the button will copy the content to their clipboard, or that the content has successfully been copied.
  4. Show more/less (optional): expands and collapses the code snippet.

Multiple action buttons

Code block with multiple actions

Code blocks can include multiple actions. By default, the copy action is always present and any other actions are optional and customizable.

The additional actions can include the option to show a checkmark after the user has clicked the action button. The checkmark can be used to indicate to the user that the action was successfully triggered.

Show more/less

Expanded and collapsed code block

There is the option to include a show more/less section in the code block. The show more/less section can be used to collapse larger code snippets. An expandable code block allows for long lines of code to be stored in an expansion panel. Expanding the code block allows the user to view the full string that they can copy.


View source on GitHub