pub struct ScrollToTop { /* private fields */ }
Expand description
scroll_to_top A Yew component that provides a button to scroll to the top of the page when clicked.
§Arguments
props
- The properties of the component.css
- Custom CSS classes for styling the scroll-to-top button. Defaults to predefined Tailwind classes.top_offset
- The vertical offset value (Y position) to show the button. Defaults to 500.0 pixels.svg_content
- Custom SVG content for the scroll-to-top button. Defaults to a default arrow SVG.
§Returns
(Html): An HTML representation of the scroll-to-top button.
§Examples
// Example of using the scroll_to_top component
use yew::prelude::*;
use yew_scroll::{ScrollToTop, ScrollToTopProps};
// Custom SVG content for the scroll-to-top button (an arrow).
fn custom_svg() -> Html {
html! {
<svg
class="w-6 h-6"
fill="none"
stroke="currentColor"
viewBox="0 0 24 24"
xmlns="http://www.w3.org/2000/svg"
>
<path
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="2"
d="M5 10l7-7m0 0l7 7m-7-7v18"
/>
</svg>
}
}
#[function_component(MyComponent)]
pub fn my_component() -> Html {
// Set props for the scroll_to_top component
let scroll_to_top_props = ScrollToTopProps {
css: "custom-css", // Add any custom CSS classes
top_offset: 0.0, // Set the desired top offset value to show the button
svg_content: custom_svg(), // Provide custom SVG content
};
// Render the scroll_to_top component with the specified props
html! {
<>
// Other content in your component
<p>{"Scroll down to see the button"}</p>
// Use the scroll_to_top component
<ScrollToTop ..scroll_to_top_props />
// Default Usage
<ScrollToTop />
</>
}
}
Trait Implementations§
Source§impl BaseComponent for ScrollToTopwhere
Self: 'static,
impl BaseComponent for ScrollToTopwhere
Self: 'static,
Source§type Properties = ScrollToTopProps
type Properties = ScrollToTopProps
The Component’s Properties.
Source§fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
Updates component’s internal state.
Source§fn changed(
&mut self,
_ctx: &Context<Self>,
_old_props: &Self::Properties,
) -> bool
fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool
React to changes of component properties.
Source§fn view(&self, ctx: &Context<Self>) -> HtmlResult
fn view(&self, ctx: &Context<Self>) -> HtmlResult
Returns a component layout to be rendered.
Source§fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)
fn rendered(&mut self, _ctx: &Context<Self>, _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 Debug for ScrollToTop
impl Debug for ScrollToTop
Source§impl FunctionProvider for ScrollToTop
impl FunctionProvider for ScrollToTop
Source§type Properties = ScrollToTopProps
type Properties = ScrollToTopProps
Properties for the Function Component.
Source§fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult
fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult
Auto Trait Implementations§
impl !Freeze for ScrollToTop
impl !RefUnwindSafe for ScrollToTop
impl !Send for ScrollToTop
impl !Sync for ScrollToTop
impl Unpin for ScrollToTop
impl !UnwindSafe for ScrollToTop
Blanket Implementations§
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.