Struct Background 

pub struct Background { /* private fields */ }

Background image component

A background image allows you to place an image in the background of your page or area of a page.

See: https://www.patternfly.org/components/background-image

Properties

Defined by BackgroundProperties.

Example

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

#[function_component(Example)]
fn example() -> Html {
  html!(
    <>
      <Background style="assets/images/pfbg-icon.svg"/>
      <p>{"Content on the background"}</p>
    </>
  )
}

Trait Implementations

impl BaseComponent for Background

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = BackgroundProperties

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 Background

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

Formats the value using the given formatter.

impl FunctionProvider for Background

type Properties = BackgroundProperties

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.