Interface Router

interface Router {
    activeRoute: RefCell<ActiveRoute>;
    onNavigate: Emitter<ActiveRoute>;
    onNavigated: Emitter<ActiveRoute>;
    strategy: RouterStategy;
    getUrl(path: Path): string;
    Link(props: { children: ElementChildren; path: Input<Path> }): Element;
    navigate(path: Path, skipHistory?: boolean): Promise<void>;
    Portal(__namedParameters: {}): Element;
    Provider(__namedParameters: { children: ElementChildren }): Element;
    pushState(path: Path): void;
    resolve(path: Path): ActiveRoute;
}

Index

Properties

activeRoute onNavigate onNavigated strategy

Methods

getUrl Link navigate Portal Provider pushState resolve

Properties

`Readonly`activeRoute

activeRoute: RefCell<ActiveRoute>

`Readonly`onNavigate

onNavigate: Emitter<ActiveRoute>

`Readonly`onNavigated

onNavigated: Emitter<ActiveRoute>

`Readonly`strategy

strategy: RouterStategy

Methods

getUrl

getUrl(path: Path): string
Parameters
- path: Path
Returns string
- Defined in src/router.tsx:94

Link

Link(props: { children: ElementChildren; path: Input<Path> }): Element
Parameters
- props: { children: ElementChildren; path: Input<Path> }
Returns Element
- Defined in src/router.tsx:97

navigate

navigate(path: Path, skipHistory?: boolean): Promise<void>
Parameters
- path: Path
- OptionalskipHistory: boolean
Returns Promise<void>
- Defined in src/router.tsx:93

Portal

Portal(__namedParameters: {}): Element
Parameters
- __namedParameters: {}
Returns Element
- Defined in src/router.tsx:95

Provider

Provider(__namedParameters: { children: ElementChildren }): Element
Parameters
- __namedParameters: { children: ElementChildren }
Returns Element
- Defined in src/router.tsx:96

pushState

pushState(path: Path): void
Parameters
- path: Path
Returns void
- Defined in src/router.tsx:92

resolve

resolve(path: Path): ActiveRoute
Parameters
- path: Path
Returns ActiveRoute
- Defined in src/router.tsx:91