eleva-router/types/index.d.ts

A Router Plugin for Eleva.

export default ElevaRouter;
export type RouteDefinition = {
    /**
     * - The URL path (e.g., "/" or "/about" or "/users/:id").
     */
    path: string;
    /**
     * - The component name (if registered globally) or a component definition.
     */
    component: string | Object;
    /**
     * - Additional properties to pass to the routed component.
     */
    props?: Object | undefined;
};
export type RouterOptions = {
    /**
     * - The app layout DOM element. The router will look for a view element
     * (with data-view attribute, .view class, or #view id) within this layout to mount routed components.
     * If no view element is found, the layout element itself will be used as the mounting target.
     */
    layout: HTMLElement;
    /**
     * - The routing mode: "hash", "query", or "history".
     */
    mode?: string | undefined;
    /**
     * - An array of route definitions.
     */
    routes: Array<RouteDefinition>;
    /**
     * - A default route object to use when no route matches.
     */
    defaultRoute?: RouteDefinition | undefined;
    /**
     * - Whether to automatically start the router.
     * If set to false, the router must be manually started using eleva.router.start().
     */
    autoStart?: boolean | undefined;
};
declare namespace ElevaRouter {
    let name: string;
    function install(eleva: any, options?: {}): void;
}
//# sourceMappingURL=index.d.ts.map