Struct patternfly_yew::components::code_block::CodeBlock

pub struct CodeBlock { /* private fields */ }

Code Block component

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

See: https://www.patternfly.org/components/code-block

Properties

Defined by CodeBlockProperties.

Children

A code block can contain any children, but is expected to contain a CodeBlockCode component.

It may also be wrapped with a detached crate::prelude::ExpandableSection component. The crate::prelude::ExpandableSectionToggle would then be a child of this component, but stay outside the nested code component.

Example

A simple example would be:

use yew::prelude::*;
use patternfly_yew::prelude::*;

#[function_component(Example)]
fn example() -> Html {
  html!(
    <CodeBlock>
      <CodeBlockCode>{r#"some code"#}</CodeBlockCode>
    </CodeBlock>
  )
}

Trait Implementations

impl BaseComponent for CodeBlockwhere Self: 'static,

type Message = ()

The Component’s Message.

type Properties = CodeBlockProperties

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for CodeBlock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FunctionProvider for CodeBlock

type Properties = CodeBlockProperties

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.