Struct TourStep 

pub struct TourStep {
    pub key: String,
    pub title: Option<String>,
    pub description: Option<Element>,
    pub cover: Option<Element>,
    pub placement: Option<TooltipPlacement>,
    pub target: Option<String>,
    pub next_button_text: Option<String>,
    pub prev_button_text: Option<String>,
}

Data model for a single tour step.

Fields

key: String

Unique key for the step.

title: Option<String>

Title displayed in the tour panel.

description: Option<Element>

Description text or element.

cover: Option<Element>

Cover image or element displayed above the content.

placement: Option<TooltipPlacement>

Placement of the tour panel relative to the target.

target: Option<String>

CSS selector for the target element to highlight. When None, the panel is centered on screen.

next_button_text: Option<String>

Custom “Next” button text.

prev_button_text: Option<String>

Custom “Previous” button text.

Implementations

impl TourStep

pub fn new( key: impl Into<String>, title: impl Into<String>, description: impl Into<String>, ) -> Self

Create a new tour step with title and description.

pub fn target(self, selector: impl Into<String>) -> Self

Set the target CSS selector.

pub fn placement(self, placement: TooltipPlacement) -> Self

Set the placement of the tour panel.

pub fn cover(self, cover: Element) -> Self

Set a cover element.

pub fn description_element(self, desc: Element) -> Self

Set custom description element.

pub fn next_button(self, text: impl Into<String>) -> Self

Set custom next button text.

pub fn prev_button(self, text: impl Into<String>) -> Self

Set custom prev button text.

Trait Implementations

impl Clone for TourStep

fn clone(&self) -> TourStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for TourStep

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for TourStep