Struct patternfly_yew::components::dl::DescriptionList

pub struct DescriptionList { /* private fields */ }

The Description list component.

A description list contains terms and their corresponding descriptions.

See: https://www.patternfly.org/components/description-list

Properties

Defined by DescriptionListProperties. The component only has children.

Example

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

#[function_component(Example)]
pub fn example() -> Html {
  html!(
    <DescriptionList>
      <DescriptionGroup term="42">{"Answer to the Ultimate Question of Life, The Universe, and Everything"}</DescriptionGroup>
    </DescriptionList>
  )
}

Trait Implementations

impl BaseComponent for DescriptionList

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = DescriptionListProperties

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 DescriptionList

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

Formats the value using the given formatter.

impl FunctionProvider for DescriptionList

type Properties = DescriptionListProperties

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.