Struct yew_ansi::AnsiRenderer
source · pub struct AnsiRenderer<Text, Builder>where
Text: Clone + PartialEq,
Builder: StyleBuilder,{ /* private fields */ }
Expand description
Component for rendering text containing ANSI escape codes.
This takes two type arguments, Text
and Builder
.
Text
is the type that is passed to AnsiProps::text
. It can be any type that implements Borrow<str>
.
Builder
specifies the StyleBuilder
. You probably want to use InlineStyle
.
Unless you have special requirements you should use one of the helper types instead of this:
See AnsiProps
for the props that can be passed to this component.
Trait Implementations§
source§impl<Text, Builder> Component for AnsiRenderer<Text, Builder>where
Text: Borrow<str> + Clone + PartialEq + 'static,
Builder: StyleBuilder + 'static,
impl<Text, Builder> Component for AnsiRenderer<Text, Builder>where Text: Borrow<str> + Clone + PartialEq + 'static, Builder: StyleBuilder + 'static,
§type Message = ()
type Message = ()
Messages are used to make Components dynamic and interactive. Simple
Component’s can declare their Message type to be
()
. Complex Component’s
commonly use an enum to declare multiple Message types.§type Properties = AnsiProps<Text>
type Properties = AnsiProps<Text>
The Component’s properties. Read more
source§fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
Called when a new message is sent to the component via its scope. Read more
source§fn changed(&mut self, ctx: &Context<Self>, _old: &Self::Properties) -> bool
fn changed(&mut self, ctx: &Context<Self>, _old: &Self::Properties) -> bool
Called when properties passed to the component change Read more
source§fn view(&self, ctx: &Context<Self>) -> Html
fn view(&self, ctx: &Context<Self>) -> Html
Components define their visual layout using a JSX-style syntax through the use of the
html!
procedural macro. The full guide to using the macro can be found in Yew’s
documentation. Read moresource§fn rendered(&mut self, ctx: &Context<Self>, first_render: bool)
fn rendered(&mut self, ctx: &Context<Self>, first_render: bool)
The
rendered
method is called after each time a Component is rendered but
before the browser updates the page. Read moreAuto Trait Implementations§
impl<Text, Builder> RefUnwindSafe for AnsiRenderer<Text, Builder>where Builder: RefUnwindSafe, Text: RefUnwindSafe,
impl<Text, Builder> Send for AnsiRenderer<Text, Builder>where Builder: Send, Text: Send,
impl<Text, Builder> Sync for AnsiRenderer<Text, Builder>where Builder: Sync, Text: Sync,
impl<Text, Builder> Unpin for AnsiRenderer<Text, Builder>where Builder: Unpin, Text: Unpin,
impl<Text, Builder> UnwindSafe for AnsiRenderer<Text, Builder>where Builder: UnwindSafe, Text: UnwindSafe,
Blanket Implementations§
source§impl<T> BaseComponent for Twhere
T: Component + 'static,
impl<T> BaseComponent for Twhere T: Component + 'static,
§type Properties = <T as Component>::Properties
type Properties = <T as Component>::Properties
The Component’s Properties.
source§fn update(
&mut self,
ctx: &Context<T>,
msg: <T as BaseComponent>::Message
) -> bool
fn update( &mut self, ctx: &Context<T>, msg: <T as BaseComponent>::Message ) -> bool
Updates component’s internal state.
source§fn changed(
&mut self,
ctx: &Context<T>,
old_props: &<T as BaseComponent>::Properties
) -> bool
fn changed( &mut self, ctx: &Context<T>, old_props: &<T as BaseComponent>::Properties ) -> bool
React to changes of component properties.
source§fn view(&self, ctx: &Context<T>) -> Result<VNode, RenderError>
fn view(&self, ctx: &Context<T>) -> Result<VNode, RenderError>
Returns a component layout to be rendered.
source§fn rendered(&mut self, ctx: &Context<T>, first_render: bool)
fn rendered(&mut self, ctx: &Context<T>, first_render: bool)
Notified after a layout is rendered.
source§fn prepare_state(&self) -> Option<String>
fn prepare_state(&self) -> Option<String>
Prepares the server-side state.
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoPropValue<Option<T>> for T
impl<T> IntoPropValue<Option<T>> for T
source§fn into_prop_value(self) -> Option<T>
fn into_prop_value(self) -> Option<T>
Convert
self
to a value of a Properties
struct.source§impl<T> IntoPropValue<T> for T
impl<T> IntoPropValue<T> for T
source§fn into_prop_value(self) -> T
fn into_prop_value(self) -> T
Convert
self
to a value of a Properties
struct.