Package org.patternfly.component.codeblock


package org.patternfly.component.codeblock
Provides the PatternFly code block component for displaying blocks of formatted code with optional actions.

A code block contains a read-only block of code that can be copied to the clipboard. It can include actions such as a copy-to-clipboard button or custom action buttons. The code block also supports a truncated/expandable view for long code snippets.

Usage

A basic code block with copy-to-clipboard and a custom action:
import static org.patternfly.component.codeblock.CodeBlock.codeBlock;
import static org.patternfly.component.codeblock.CodeBlockAction.codeBlockAction;
import static org.patternfly.component.codeblock.CodeBlockAction.codeBlockCopyToClipboardAction;

codeBlock()
        .addAction(codeBlockCopyToClipboardAction())
        .addAction(codeBlockAction(play())
                .ariaLabel("Play")
                .onClick((action, codeBlock) -> console.log("Play")))
        .code("apiVersion: helm.openshift.io/v1beta1/\nkind: HelmChartRepository");
A truncated (expandable) code block:
import static org.patternfly.component.codeblock.CodeBlock.codeBlock;
import static org.patternfly.component.codeblock.CodeBlockAction.codeBlockCopyToClipboardAction;

codeBlock()
        .addAction(codeBlockCopyToClipboardAction())
        .truncate()
        .code("long code content...");
See Also: