Type alias TNavigationConnection

TNavigationConnection: {
    direction?: string;
    icon?: string;
    isEntering?: boolean;
    toMapName?: string;
    type: string;
}

Represent a result of a connectionTemplate function.

Type declaration

  • Optional direction?: string

    Direction "up" or "down" or null if on the same Floor

  • Optional icon?: string

    Icon to use for the Connection, can be wrapped in SVG and for styling

    Example

    <svg height="16" viewBox="0 0 36 36" width="16">
    <g fill="white">
    ${icon}
    </g>
    </svg>
  • Optional isEntering?: boolean

    Whether the user is entering or exiting the Connection

  • Optional toMapName?: string

    Depending on the direction of the journey, the map name of the destination map or where a Connection enters the map

  • type: string

    Connection type, "escalator", "elevator", etc