Struct yew_tou_rs::prelude::TourConfig

pub struct TourConfig {
    pub id: Option<String>,
    pub steps: Vec<TourStep>,
}

Configuration for a tour.

TourConfig holds all the necessary information to define and run a tour, including an optional identifier and a list of steps.

Fields

• id - An optional unique identifier for the tour.
• steps - A vector of TourSteps that define the content and order of the tour.

Examples

use yew_tou_rs::prelude::{TourConfig, TourStep};

let config = TourConfig {
    id: Some("main-tour".to_string()),
    steps: vec![
        TourStep {
            selector: ".intro-element".to_string(),
            content: "Welcome to the tour!".to_string(),
        },
        TourStep {
            selector: "#feature-button".to_string(),
            content: "Click here to see our main feature.".to_string(),
        },
    ],
};

Yew Properties

This struct derives Properties, allowing it to be used as properties for Yew components.

Serialization

TourConfig can be serialized and deserialized, which is useful for storing configurations or passing them between different parts of your application.

Clone and Debug

This struct can be cloned and easily printed for debugging purposes.

Fields

id: Option<String>

An optional unique identifier for the tour.

This can be used to distinguish between different tours in your application or to persist tour state. If not provided, a default value may be used.

The #[prop_or_default] attribute means this field will use its default value (None) if not explicitly set when creating a TourConfig instance in a Yew component.

steps: Vec<TourStep>

A vector of steps that define the content and order of the tour.

Each step is represented by a TourStep struct, which includes information about what element to highlight and what content to display for that step.

Trait Implementations

impl Clone for TourConfig

fn clone(&self) -> TourConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TourConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TourConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TourConfig

fn eq(&self, other: &TourConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for TourConfig

type Builder = TourConfigBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl Serialize for TourConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TourConfig