Interface HowToUseProps

interface HowToUseProps {
    buttonHref: string;
    buttonText?: string;
    onNavigate?: ((url) => void);
    screenMode: "desktop" | "mobile";
    stepItems: HowToUseStepItem[];
    subtitle: string;
    tertiaryText?: string;
    title: string;
}

Properties

buttonHref buttonText? onNavigate? screenMode stepItems subtitle tertiaryText? title

Properties

buttonHref

buttonHref: string

URL for the call to action button

Optional buttonText

buttonText?: string

Text for the call to action button

Optional onNavigate

onNavigate?: ((url) => void)

Function to call when the user clicks the call to action button

Type declaration

    • (url): void

    • Function to call when the user clicks the call to action button

      Parameters

      • url: string

      Returns void

screenMode

screenMode: "desktop" | "mobile"

What size the screen currently is (affects page layout)

stepItems

stepItems: HowToUseStepItem[]

Each step item to display in the guide

subtitle

subtitle: string

Subtitle text

Optional tertiaryText

tertiaryText?: string

Optional extra text to show below everything else

title

title: string

Biggest text on the page

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc