svelte-guard-history-router
Advanced tools
svelte guarded history router
article/:id<a href="/home">Home</a> elements<script>
import { Router, Route, Outlet, redirectGuard } from "svelte-guard-history-router";
import About from "./About.svelte";
import Categories from "./Categories.svelte";
import Category from "./Category.svelte";
import Articles from "./Articles.svelte";
import Article from "./Article.svelte";
import { enshureSession } from "./main.mjs";
export const enshureSession = redirectGuard("/login", () => !session);
let session = undefined;
</script>
<Router base="/base">
<nav>
<!-- catch all but link to '/' -->
<Route href="/" path="*" component={Home}>Router Example</Route>
<ul class="left">
<li>
<Route path="/about" component={About}>About</Route>
</li>
<li>
<Route path="/article" guards={enshureSession} component={Articles}>
Articles
<Route path="/:artice" component={Article}/>
</Route>
</li>
<li>
<Route path="/category" guards={enshureSession} component={Categories}>
Categories
<Route path="/:category" component={Category}/>
</Route>
</li>
</ul>
</nav>
<main>
<Outlet/>
</main>
</Router>
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
Extends BaseTransition
key subscriptions:
const aKey = router.keys.aKey;
$aKey // fired if value of aKey changes
linkNodes Set<Node> nodes having their active state updatedroutes Array<Route>keys Object collected keys of all routesparams Object value mapping from keys (from current route)route Route currentnested Transition ongoing nested transitionbase string urlCurrent component. Either from a nested transition or from the current route
Returns SvelteComponent
Value if the current route
Returns any
Returns string url path with fragment & query
Replace current route.
path stringReplace current route.
path stringReturns Object former state
Leave current route and enter route for given path. The work is done by a Transition.
path string where to goReturns Transition running transition
Called from a Transition to manifest the new destination. If path is undefined the Transition has been aborderd.
path stringContinue a transition to its original destination. Shortcut for this.transition.continue(). If there is no transition ongoing and a fallbackPath is present, it will be entered. Otherwise does nothing.
fallbackPath stringAbort a transition. Shortcut for this.transition.abort() If there is no transition ongoing and a fallbackPath is present it will be entered. Otherwise does nothing.
fallbackPath stringRouter subscription. Changes in the current route will trigger a update
subscription FunctionUpdate the active state of a node.
node NodeAdd a new Route.
route RouteFind Route for a given object.
object ObjectReturns Route able to support given object
Find path for a given object.
Returns String path + suffix
Deliver url search params form the current location.
Returns URLSearchParams as extracted from the path
Replaces the search part of the path with the given searchParams.
searchParams URLSearchParamsAdd another transition nesting level. Starts a transition from the given factory.
path stringfactory TransitionContinue a nested route to its original destination. Does nothing if the transition has not been nested.
Abort the transition.
errorReturns boolean truen in case there was a nesten transition
Extends ObjectStoreRoute
Route to represent a slice of the prarent list of values.
master Route route holding the master recordsReturns any 1st. entry
Returns any last entry
Enforces conditions of routes Like the presents of values in the context
Called while entering a route (current outlet is not yet set)
transition TransitionCalled before leaving a route
transition TransitionRedirects to a given path if condition is met.
Execute guards in a sequence.
children Iterable<Guard>Execute guards in a parallel.
children Iterable<Guard>Extends SkeletonRoute
Route holding a ordered collection of values.
pathoptionsvalue Array<any>Default empty guard does nothing.
Route at the root of the tree. This route has no parent. All other routes are below of this one.
Are there parameters in the path.
Returns boolean true if route has parameters (:key)
Returns string empty as we are the root
Returns object empty object
Returns Guard empty guard which does nothing
Extends RootRoute
Route Subscriptions on Routes fire when the route value changes.
pathoptions (optional, default {})path string full path of the Route including all parentscomponent SvelteComponent target to showlinkComponent SvelteComponent content for ObjectLinkpropertyMapping Object Map properties to object attributes
Keys are the property names and values are the keys in the resulting object.priority numberkeys Array<string> as found in the pathregex RegExvalue anyEnter the route from a former one. All parent routes up to the common ancestor are also entered.
transition TransitionuntilRoute Route the common ancestor with the former routeLeave the route to a new one. All parent routes up to the common ancestor are also left.
transition TransitionuntilRoute Route the common ancestor with the next routeCheck properties against object.
Returns boolean true if object properties are matching with the given proerties
Extract properties from object. All property values are strings.
object Object source of the valuesReturns (Object | undefined) properties extracted from given object
Find common ancestor with an other Route.
other RouteReturns (Route | undefined) common ancestor Route between receiver and other
Deliver object for a given set of properties. Default implemantation asks the parent route.
transition TransitionReturns Object for matching properties
Extends BaseTransition
Transition between routes.
router Routerpath string new destinationrouter Routerpath string new destinationStart the transition
Cleanup transition. Update Nodes active state
Halt current transition and go to another route. To proceed with the original route by calling continue() The original transition will keept in place and can be continued afterwards.
path string new route to enter temporaryBring back the router into the state before the transition has started. All nested transitions also will be termniated.
e (Exception | undefined)Create a named object wich can act as a store.
name stringinitialValue anyvalue anyReturns Store
Extends Guard
Shows a component during transition.
component SvelteComponent to show up during th transitionrampUpTime number initial delay for the componnt to show up (optional, default 300)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 /deploymentLocation;
try_files $uri$args $uri$args/ /serviceBase/index.html;
}
publish a _redirects file into the app root folder
/* /index.html 200
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.