@srfnstack/fntags/src/fnroute.d.mts

<p align="center"> <img alt="fntags header" src="https://raw.githubusercontent.com/SRFNStack/fntags/master/docs/fntags_header.gif"> </p>

/**
 * An element that is displayed only if the current route starts with elements path attribute.
 *
 * For example,
 *  route({path: "/proc"},
 *      div(
 *          "proc",
 *          div({path: "/cpuinfo"},
 *              "cpuinfo"
 *              )
 *          )
 *      )
 *
 *  You can override this behavior by setting the attribute, absolute to any value
 *
 *  route({path: "/usr"},
 *      div(
 *          "proc",
 *          div({path: "/cpuinfo", absolute: true},
 *              "cpuinfo"
 *              )
 *          )
 *      )
 *
 * @param {(Object|Node)[]} children The attributes and children of this element.
 * @returns {HTMLDivElement} A div element that will only be displayed if the current route starts with the path attribute.
 */
export function route(...children: (any | Node)[]): HTMLDivElement;
/**
 * An element that only renders the first route that matches and updates when the route is changed
 * The primary purpose of this element is to provide catchall routes for not found pages and path variables
 * @param {(Object|Node)[]} children
 * @returns {Node|(()=>Node)}
 */
export function routeSwitch(...children: (any | Node)[]): Node | (() => Node);
/**
 * A link element that is a link to another route in this single page app
 * @param {(Object|Node)[]} children The attributes of the anchor element and any children
 * @returns {HTMLAnchorElement} An anchor element that will navigate to the specified route when clicked
 */
export function fnlink(...children: (any | Node)[]): HTMLAnchorElement;
/**
 * A function to navigate to the specified route
 * @param {string} route The route to navigate to
 * @param {any} context Data related to the route change
 * @param {boolean} replace Whether to replace the state or push it. pushState is used by default.
 * @param {boolean} silent Prevent route change events from being emitted for this route change
 */
export function goTo(route: string, context?: any, replace?: boolean, silent?: boolean): void;
/**
 * Listen for routing events
 * @param event a string event to listen for
 * @param handler A function that will be called when the event occurs.
 *                  The function receives the new and old pathState objects, in that order.
 * @return {()=>void} a function to stop listening with the passed handler.
 */
export function listenFor(event: any, handler: any): () => void;
/**
 * Set the root path of the app. This is necessary to make deep linking work in cases where the same html file is served from all paths.
 * @param {string} rootPath The root path of the app
 */
export function setRootPath(rootPath: string): void;
/**
 * Key value pairs of path parameter names to their values
 * @typedef {Object} PathParameters
 */
/**
 * The path parameters of the current route
 * @type {import('./fntags.mjs').FnState<PathParameters>}
 */
export const pathParameters: import('./fntags.mjs').FnState<PathParameters>;
/**
 * The path information for a route
 * @typedef {{currentPath: string, rootPath: string, context: any}} PathState
 */
/**
 * The current path state
 * @type {import('./fntags.mjs').FnState<PathState>}
 */
export const pathState: import('./fntags.mjs').FnState<PathState>;
/**
 * @typedef {string} RouteEvent
 */
/**
 * Before the route is changed
 * @type {RouteEvent}
 */
export const beforeRouteChange: RouteEvent;
/**
 * After the route is changed
 * @type {RouteEvent}
 */
export const afterRouteChange: RouteEvent;
/**
 * After the route is changed and the route element is rendered
 * @type {RouteEvent}
 */
export const routeChangeComplete: RouteEvent;
/**
 * Key value pairs of path parameter names to their values
 */
export type PathParameters = any;
/**
 * The path information for a route
 */
export type PathState = {
    currentPath: string;
    rootPath: string;
    context: any;
};
export type RouteEvent = string;
//# sourceMappingURL=fnroute.d.mts.map