svelte-guard-history-router
Advanced tools
svelte guarded history router
<a href="/home">Home</a> elementsimport { Router, route, Guard } from 'svelte-guard-history-router';
import Categories from "./Categories.svelte";
import Category from "./Category.svelte";
import Article from "./Article.svelte";
import Articles from "./Articles.svelte";
import About from "./About.svelte";
import Login from "./Login.svelte";
let session = undefined;
class SessionGuard extends Guard {
async enter(transition) {
if(!session) {
transition.redirect('/login');
}
}
}
export const router = new Router(
[
route("*", Home),
route("/about", About),
route("/login", Login),
route("/article", sessionGuard, Articles),
route("/article/:article", sessionGuard, Article),
route("/category", sessionGuard, Categories),
route("/category/:category", sessionGuard, Category)
],
"/base"
);
<script>
import {
Outlet,
link,
active
} from "svelte-guard-history-router";
import { router } from "./main.mjs";
</script>
<nav>
<a href="/" use:link={router} use:active={router}>Router Example</a>
<ul class="left">
<li>
<a href="/about" use:link={router} use:active={router}>About</a>
</li>
<li>
<a href="/article" use:link={router} use:active={router}>Articles</a>
</li>
<li>
<a href="/category" use:link={router} use:active={router}>Categories</a>
</li>
</ul>
</nav>
<main>
<Outlet {router}/>
</main>
Check out the code in the example folder, or the live example.
To run the sample, clone the repository, install the dependencies, and start:
git clone https://github.com/arlac77/svelte-guard-history-router
cd svelte-guard-history-router
npm install
npm start
then navigate to localhost:5000
export BROWSER=safari|chrome|...
yarn test
or
npm test
Keys also act as svelte stores and can be subscribed.
export const article = derived(
[articles, router.keys.article],
([$articles, $id], set) => {
set($articles.find(a => a.id === $id));
return () => {};
}
);
Type: Object
Type: Object
key subscriptions:
const aKey = router.keys.aKey;
$aKey // fired if value of aKey changes
routes Array<Route>keys Object all possible keys of all routesparams Object value mapping from keys (from current route)state RouterStateroute Route currenttransition Transition ongoing transitionbase string urlLeave current route and enter route for given path The work is done by a Transition
path string where to goRouter subscription Value changes are fired when the route (or the target component changes)
subscription FunctionnodeTransition between routes
start the transition
cleanup transition
Halt current transition and go to another route. To proceed with the original route by call continue()
path string new route to enter temprorarlyContinue a redirected route to its original destination
Bring back the router into the state before the transition has started
e ExceptionBase route without guard
path stringcomponent SvelteComponent target to showpath stringcomponent SvelteComponent target to showpriority numberkeys Array<string> as found in the pathregex RegExEnter the route from a former one. Calls guard enter on all guards present in our gurad but absent in the former one
transition TransitionLeave the route to a new one. Calls guard leave on all our guards which are not in the new route
transition TransitionExtends Route
Route with a guard
path stringcomponent SvelteComponent target to showguard Guardpriority numberkeys Array<string> as found in the pathregex RegExEnter the route from a former one. Calls guard enter on all guards present in our gurad but absent in the former one
transition TransitionLeave the route to a new one. Calls guard leave on all our guards which are not in the new route
transition TransitionHelper function to create routes with optional guards
Enforces conditions of routes Like presents of values in the context
Called when guard is attached to a route (one time)
route RouteCalled while entering a route (current outlet is not yet set)
transition TransitionCalled before leaving a route
transition Transitionexecute guards in a sequence
children Iterable<Guard>execute guards in a parallel
children Iterable<Guard>With npm do:
npm install svelte-guard-history-router
With yarn do:
yarn add svelte-guard-history-router
All unresolvable requests are redirected to /sericeBase/index.html
location /serviceBase {
alias /deploymantLocation;
try_files $uri$args $uri$args/ /sericeBase/index.html;
}
BSD-2-Clause
FAQs
svelte router for SPA (history mode only)
The npm package svelte-guard-history-router receives a total of 388 weekly downloads. As such, svelte-guard-history-router popularity was classified as not popular.
We found that svelte-guard-history-router demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.