Struct TextArea 

pub struct TextArea { /* private fields */ }

Text area component

A text area component is used for entering a paragraph of text that is longer than one line.

See: https://www.patternfly.org/components/text-area

Properties

Defined by `TextAreaProperties.

Change events

The component emits changes of the input value through the onchange event once the component looses the focus (same of plain HTML). It also emits the full input value via the oninput event and does the same using the onvalidate event. This duplication is required to support both change events as well as supporting the ValidatingComponent trait.

If a value is provided via the value property, that value must be updated through the oninput callback. Otherwise the value will be reset immediately and the component will be effectively read-only:

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

#[function_component(Example)]
fn example() -> Html {
  let value = use_state_eq(String::default);
  let onchange = {
    let value = value.clone();
    Callback::from(move |data| value.set(data))
  };

  html!(<TextArea value={(*value).clone()}/>)
}

Trait Implementations

impl BaseComponent for TextArea

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = TextAreaProperties

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 TextArea

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

Formats the value using the given formatter.

impl FunctionProvider for TextArea

type Properties = TextAreaProperties

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.

impl ValidatingComponent for TextArea

type Value = String