Documentation
    Preparing search index...

    Type Alias LoginPromptOptions

    Styling options for login prompt

    type LoginPromptOptions = {
        addLinks?: { text: string; url: string }[];
        background?: string;
        backgroundColor?: string;
        color?: string;
        glow?: string;
        hideApps?: boolean;
        hideLogo?: boolean;
        logo?: string;
        logoPosition?:
            | "left"
            | "right"
            | "aboveTitle"
            | "belowTitle"
            | "belowSubtitle";
        persist?: boolean;
        platform?: "android"
        | "ios"
        | "mac"
        | "windows"
        | "linux"
        | "unknown";
        pwaSettings?: ApiOptions["pwaSettings"];
        subtitle?: string;
        subtitleFontFamily?: string;
        subtitleFontSize?: string;
        subtitleFontUrl?: string;
        subtitleTextColor?: string;
        subtitleTextShadow?: string;
        textColor?: string;
        title?: string;
        titleFontFamily?: string;
        titleFontSize?: string;
        titleFontUrl?: string;
        titleTextShadow?: string;
    }
    Index

    Properties

    addLinks? background? backgroundColor? color? glow? hideApps? hideLogo? logo? logoPosition? persist? platform? pwaSettings? subtitle? subtitleFontFamily? subtitleFontSize? subtitleFontUrl? subtitleTextColor? subtitleTextShadow? textColor? title? titleFontFamily? titleFontSize? titleFontUrl? titleTextShadow?

    Properties

    addLinks?: { text: string; url: string }[]

    Add links to top of page

    background?: string

    Background image URL

    backgroundColor?: string

    Use background color instead of image

    color?: string

    Primary color as hex: #000000

    glow?: string

    Change glow color, defaults to color or set to falsy to disable

    hideApps?: boolean

    Hide app links

    hideLogo?: boolean

    Hide Logo regardless of existing Logo Url

    logo?: string

    Logo URL

    logoPosition?: "left" | "right" | "aboveTitle" | "belowTitle" | "belowSubtitle"

    'left' | 'right' | 'aboveTitle' | 'belowTitle' | 'belowSubtitle'

    persist?: boolean

    Allow users to stay logged in

    platform?: "android" | "ios" | "mac" | "windows" | "linux" | "unknown"
    pwaSettings?: ApiOptions["pwaSettings"]
    subtitle?: string

    Subtitle text

    subtitleFontFamily?: string

    Custom font for subtitle

    subtitleFontSize?: string

    Font size for subtitle

    subtitleFontUrl?: string

    Import URL for custom font

    subtitleTextColor?: string

    Color for subtitle

    subtitleTextShadow?: string

    Text shadow for subtitle

    textColor?: string

    Color of headers & links

    title?: string

    Header string or HTML: logo

    titleFontFamily?: string

    Custom font for title

    titleFontSize?: string

    Font size for title

    titleFontUrl?: string

    Import URL for custom font

    titleTextShadow?: string

    Text shadow for the title

    Settings

    Member Visibility

    On This Page

    Properties