Teleforge API Reference - v0.1.0
    Preparing search index...

    Interface RouteDefinition

    Describes an addressable Mini App route and its UI/runtime requirements.

    interface RouteDefinition {
        capabilities?: TeleforgeRouteCapability;
        component?: string;
        coordination?: RouteCoordinationMetadata;
        description?: string;
        guards?: string[];
        launchModes?: string[];
        meta?: { description?: string; title?: string };
        path: string;
        title?: string;
        ui?: {
            header?: { hideBackButton?: boolean; title?: string };
            mainButton?: { text: string; visible?: boolean };
        };
    }
    Index

    Properties

    component?: string
    description?: string
    guards?: string[]
    launchModes?: string[]
    meta?: { description?: string; title?: string }
    path: string
    title?: string
    ui?: {
        header?: { hideBackButton?: boolean; title?: string };
        mainButton?: { text: string; visible?: boolean };
    }