@breautek/router 3.0.1 → 4.0.0

package/dist/src/DefaultStrategy.d.ts

@@ -1,5 +1,5 @@
-import { IRouterStrategyClass } from './IRouterStrategyClass';
-/**
-Alias for {@link HashStrategy}
-*/
-export declare let DefaultStrategy: IRouterStrategyClass;
+import { IRouterStrategyClass } from './IRouterStrategyClass';
+/**
+Alias for {@link HashStrategy}
+*/
+export declare let DefaultStrategy: IRouterStrategyClass;

package/dist/src/HashStrategy.d.ts

@@ -1,29 +1,29 @@
-import { RouterStrategy } from './RouterStrategy';
-import { Router } from './Router';
-/**
-    A {@link RouterStrategy} that manages a history stack using inline pound symbols `#`.
-    URLs will have a starting point `/#/`, as a default base.
+import { RouterStrategy } from './RouterStrategy';
+import { Router } from './Router';
+/**
+    A {@link RouterStrategy} that manages a history stack using inline pound symbols `#`.
+    URLs will have a starting point `/#/`, as a default base.
 
-    For example, if you [pushState("mylink")]{@link pushState}, the url
-    `/#/mylink` will be produced.
-*/
-export declare class HashStrategy extends RouterStrategy {
-    private $base;
-    private $stack;
-    private $position;
-    private $lastFiredLocation;
-    constructor(router: Router);
-    private $init;
-    getLocation(): string;
-    getLocationAt(position: number): string;
-    getHistoryLength(): number;
-    getScrollRestoration(): ScrollRestoration;
-    canGo(to: number): boolean;
-    peek(to: number): string;
-    go(to: number): void;
-    pushState(url: string, state?: Record<any, any>): void;
-    replaceState(url: string, state?: Record<any, any>): void;
-    clear(): void;
-    private $navigate;
-    protected _fireURLChange(url: string): void;
-}
+    For example, if you [pushState("mylink")]{@link pushState}, the url
+    `/#/mylink` will be produced.
+*/
+export declare class HashStrategy extends RouterStrategy {
+    private $base;
+    private $stack;
+    private $position;
+    private $lastFiredLocation;
+    constructor(router: Router);
+    private $init;
+    getLocation(): string;
+    getLocationAt(position: number): string;
+    getHistoryLength(): number;
+    getScrollRestoration(): ScrollRestoration;
+    canGo(to: number): boolean;
+    peek(to: number): string;
+    go(to: number): void;
+    pushState(url: string, state?: Record<any, any>): void;
+    replaceState(url: string, state?: Record<any, any>): void;
+    clear(): void;
+    private $navigate;
+    protected _fireURLChange(url: string): void;
+}

package/dist/src/IOnNoRoute.d.ts

@@ -1,4 +1,4 @@
-import * as React from 'react';
-export interface IOnNoRoute {
-    (indexRoute: React.ReactElement, routes: Array<React.ReactElement>): React.ReactElement;
-}
+import * as React from 'react';
+export interface IOnNoRoute {
+    (indexRoute: React.ReactElement, routes: Array<React.ReactElement>): React.ReactElement;
+}

package/dist/src/IRouterStrategyClass.d.ts

@@ -1,8 +1,8 @@
-import { RouterStrategy } from './RouterStrategy';
-import { Router } from './Router';
-/**
- * An interface to generically reference a {@link RouterStrategy} class
- */
-export interface IRouterStrategyClass {
-    new (router: Router): RouterStrategy;
-}
+import { RouterStrategy } from './RouterStrategy';
+import { Router } from './Router';
+/**
+ * An interface to generically reference a {@link RouterStrategy} class
+ */
+export interface IRouterStrategyClass {
+    new (router: Router): RouterStrategy;
+}

package/dist/src/IViewStylesheet.d.ts

@@ -1,4 +1,4 @@
-export interface IViewStylesheet {
-    use: () => void;
-    unuse: () => void;
-}
+export interface IViewStylesheet {
+    use: () => void;
+    unuse: () => void;
+}

package/dist/src/Route.d.ts

@@ -1,33 +1,33 @@
-import * as React from 'react';
-import { View } from './View';
-import { RouteMatcher } from './RouteMatcher';
-import { RouterStrategy } from './RouterStrategy';
-import { TransitionStrategy } from 'TransitionStrategy';
-export interface IRouteProps<T> {
-    url: string;
-    component: React.ComponentClass<any>;
-    index?: boolean;
-    entryTransition?: TransitionStrategy;
-    exitTransition?: TransitionStrategy;
-    base?: string;
-    componentProps?: T;
-    matcher?: RouteMatcher;
-}
-export interface IComponentProps {
-    url: string;
-    router: RouterStrategy;
-    [key: string]: any;
-}
-export interface IRouteState {
-}
-/**
- * This class represents a route that renders a {@link View} component
- */
-export declare class Route<TComponentProps extends IComponentProps = IComponentProps, TRouteProps extends IRouteProps<TComponentProps> = IRouteProps<TComponentProps>, TRouteState extends IRouteState = IRouteState> extends React.Component<TRouteProps, TRouteState> {
-    private $node;
-    constructor(props: TRouteProps);
-    render(): React.ReactNode;
-    getView(): View;
-    private $getComponentsToRender;
-    private $getChildren;
-}
+import * as React from 'react';
+import { View } from './View';
+import { RouteMatcher } from './RouteMatcher';
+import { RouterStrategy } from './RouterStrategy';
+import { TransitionStrategy } from 'TransitionStrategy';
+export interface IRouteProps<T> {
+    url: string;
+    component: React.ComponentClass<any>;
+    index?: boolean;
+    entryTransition?: TransitionStrategy;
+    exitTransition?: TransitionStrategy;
+    base?: string;
+    componentProps?: T;
+    matcher?: RouteMatcher;
+}
+export interface IComponentProps {
+    url: string;
+    router: RouterStrategy;
+    [key: string]: any;
+}
+export interface IRouteState {
+}
+/**
+ * This class represents a route that renders a {@link View} component
+ */
+export declare class Route<TComponentProps extends IComponentProps = IComponentProps, TRouteProps extends IRouteProps<TComponentProps> = IRouteProps<TComponentProps>, TRouteState extends IRouteState = IRouteState> extends React.Component<TRouteProps, TRouteState> {
+    private $node;
+    constructor(props: TRouteProps);
+    render(): React.ReactNode;
+    getView(): View;
+    private $getComponentsToRender;
+    private $getChildren;
+}

package/dist/src/RouteMatcher.d.ts

@@ -1,31 +1,30 @@
-/// <reference types="react" />
-import "regenerator-runtime/runtime";
-import { RouterStrategy } from './RouterStrategy';
-/**
- * Will be invoked when no routes are found. Default implementation is to simply return the `indexRoute`.
- * @param {React.ReactElement} indexRoute The `ReactElement` of a `Route`
- * @param {Array<React.ReactElement>} routes An array of `ReactElement` of `Route`
- * @returns {React.ReactElement} An `ReactElement` of a `Route`
- */
-export interface IOnNoRouteFunction {
-    (indexRoute: React.ReactElement, routes: Array<React.ReactElement>): React.ReactElement;
-}
-/**
- * This class is reponsible for determing which route to render
- * based on the URL and the route url patterns.
- */
-export declare class RouteMatcher {
-    private $strategy;
-    constructor(routerStrategy: RouterStrategy);
-    private $defaultNoRouteFunction;
-    /**
-     * Matches the url to the appropriate renderable route
-     *
-     * @param url
-     * @param children
-     * @param base
-     * @param indexRoute
-     * @param onNoRoute
-     */
-    match(url: string, children: Array<React.ReactElement>, base: string, indexRoute?: React.ReactElement, onNoRoute?: IOnNoRouteFunction): React.ReactElement;
-}
+/// <reference types="react" />
+import { RouterStrategy } from './RouterStrategy';
+/**
+ * Will be invoked when no routes are found. Default implementation is to simply return the `indexRoute`.
+ * @param {React.ReactElement} indexRoute The `ReactElement` of a `Route`
+ * @param {Array<React.ReactElement>} routes An array of `ReactElement` of `Route`
+ * @returns {React.ReactElement} An `ReactElement` of a `Route`
+ */
+export interface IOnNoRouteFunction {
+    (indexRoute: React.ReactElement, routes: Array<React.ReactElement>): React.ReactElement;
+}
+/**
+ * This class is reponsible for determing which route to render
+ * based on the URL and the route url patterns.
+ */
+export declare class RouteMatcher {
+    private $strategy;
+    constructor(routerStrategy: RouterStrategy);
+    private $defaultNoRouteFunction;
+    /**
+     * Matches the url to the appropriate renderable route
+     *
+     * @param url
+     * @param children
+     * @param base
+     * @param indexRoute
+     * @param onNoRoute
+     */
+    match(url: string, children: Array<React.ReactElement>, base: string, indexRoute?: React.ReactElement, onNoRoute?: IOnNoRouteFunction): React.ReactElement;
+}

package/dist/src/Router.d.ts

@@ -1,85 +1,89 @@
-import "regenerator-runtime/runtime";
-import * as React from 'react';
-import { RouterStrategy } from './RouterStrategy';
-import { IRouterStrategyClass } from './IRouterStrategyClass';
-import { IOnNoRoute } from './IOnNoRoute';
-export interface IRouterProps {
-    strategy?: IRouterStrategyClass;
-    component: React.ComponentClass<any>;
-    onNoRoute?: IOnNoRoute;
-}
-export interface IRouterState {
-    strategy: RouterStrategy;
-    url: string;
-    shouldTransition: boolean;
-}
-export declare class Router<TRouterProps extends IRouterProps = IRouterProps> extends React.Component<TRouterProps, IRouterState> {
-    state: IRouterState;
-    private $lastRenderedRoute;
-    private $matcher;
-    private $awaitingTransition;
-    private $incomingRoute;
-    private $exitingRoute;
-    private static $instance;
-    constructor(props: TRouterProps);
-    static getInstance(): RouterStrategy;
-    /**
-     * Gets the current routing strategy
-     */
-    getRouterStrategy(): RouterStrategy;
-    /**
-     * @ignore
-     */
-    private $onURLChange;
-    componentDidMount(): void;
-    /**
-     * @ignore
-     */
-    UNSAFE_componentWillReceiveProps(nextProps: TRouterProps): void;
-    /**
-     * @ignore
-     */
-    componentWillUnmount(): void;
-    /**
-     * @ignore
-     */
-    render(): React.ReactNode;
-    /**
-     * @ignore
-     */
-    componentDidUpdate(): void;
-    /**
-     * Gets the number of history entries. Note this does not count the browser history.
-     * Only the history kept track during the life-cycle of the app.
-     */
-    getHistoryLength(): number;
-    /**
-     * Gets the scroll restoration mode
-     */
-    getScrollRestoration(): ScrollRestoration;
-    /**
-     *
-     * @param to An integer, positive means go forward, negative means go backwards. E.g:
-     *              `1`  move forward one step
-     *              `-1` move backward one step
-     *              `0`  navigate to the current page (This is essentially a no-op)
-     */
-    go(to: number): void;
-    /**
-     * Go back one step. This is an alias for [pushState(-1)]{@link go}.
-     */
-    back(): void;
-    /**
-     * Go forward one step. This is an alias for [pushState(1)]{@link go}.
-     */
-    forward(): void;
-    /**
-     * Gets the potential routes
-     */
-    private $getChildren;
-    /**
-     * Finds the index route. Returns null if there are no indexed routes.
-     */
-    private $getIndexRoute;
-}
-export declare let getRouter: () => RouterStrategy;
+import * as React from 'react';
+import { RouterStrategy } from './RouterStrategy';
+import { IRouterStrategyClass } from './IRouterStrategyClass';
+import { IOnNoRoute } from './IOnNoRoute';
+export interface IRouterProps {
+    strategy?: IRouterStrategyClass;
+    component: React.ComponentClass<any>;
+    children?: React.ReactNode;
+    onNoRoute?: IOnNoRoute;
+}
+export interface IRouterState {
+    strategy: RouterStrategy;
+    url: string;
+    shouldTransition: boolean;
+}
+export declare class Router<TRouterProps extends IRouterProps = IRouterProps> extends React.Component<TRouterProps, IRouterState> {
+    state: IRouterState;
+    private $lastRenderedRoute;
+    private $matcher;
+    private $awaitingTransition;
+    private $incomingRoute;
+    private $exitingRoute;
+    private static $instance;
+    constructor(props: TRouterProps);
+    static getInstance(): RouterStrategy;
+    /**
+     * Gets the current routing strategy
+     */
+    getRouterStrategy(): RouterStrategy;
+    /**
+     * @ignore
+     */
+    private $onURLChange;
+    componentDidMount(): void;
+    /**
+     * @ignore
+     */
+    UNSAFE_componentWillReceiveProps(nextProps: TRouterProps): void;
+    /**
+     * @ignore
+     */
+    componentWillUnmount(): void;
+    /**
+     * @ignore
+     */
+    render(): React.ReactNode;
+    /**
+     * @ignore
+     */
+    componentDidUpdate(): void;
+    /**
+     * Gets the number of history entries. Note this does not count the browser history.
+     * Only the history kept track during the life-cycle of the app.
+     */
+    getHistoryLength(): number;
+    /**
+     * Gets the scroll restoration mode
+     */
+    getScrollRestoration(): ScrollRestoration;
+    /**
+     *
+     * @param to An integer, positive means go forward, negative means go backwards. E.g:
+     *              `1`  move forward one step
+     *              `-1` move backward one step
+     *              `0`  navigate to the current page (This is essentially a no-op)
+     */
+    go(to: number): void;
+    /**
+     * Go back one step. This is an alias for [pushState(-1)]{@link go}.
+     */
+    back(): void;
+    /**
+     * Go forward one step. This is an alias for [pushState(1)]{@link go}.
+     */
+    forward(): void;
+    /**
+     * Gets the potential routes
+     */
+    private $getChildren;
+    /**
+     * Finds the index route. Returns null if there are no indexed routes.
+     */
+    private $getIndexRoute;
+}
+/**
+ * @deprecated Use Router.getInstance() instead.
+ * @returns {RouterStrategy}
+ */
+export declare let getRouter: () => RouterStrategy;