npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

svelte-page-router

v1.1.0

Published

Simple wrapper based on pagejs to make DX similar to config-based router.

Downloads

5

Readme

svelte-page-router

Simple wrapper based on pagejs to make DX similar to config-based router. Play well with Svelte 3.

Usage

Install with npm or yarn:

npm install --save svelte-page-router

Then import router to your main.js file:

import Router from 'svelte-page-router';

import App from './App.svelte';

const options = {
	click: true,
	popstate: true,
	dispatch: true,
	hashbang: false,
};

const router = new Router({
	routes: [{
		path: '/static',
		component: import('./pages/Static')
	},{
		path: '/dynamic/:id/:type?',
		component: ctx => import('~/pages/Dynamic') // for lazy-loaded routes
	},{
		path: '/secure',
		component: import('~/pages/Secure'),
		before(ctx, next) {
			(/* check authorization */) ? 
				next() : 
				router.redirect('/static');
		}				
	}, {
		path: '*',
		component: import('~/pages/NotFound'),
	}],
	hooks: [
		(ctx, next) => {
			/* simple hooks to modify context for any route */
			next();
		}
	],
	...options
});

// simple integrate with Svelte

const app = new App({
	target: document.body,
	props: { component: null }
});

router.enter((ctx, next) => {
	app.$set({ ...ctx });
	tick().then(next);
});

router.exit((ctx, next) => {
	app.$set({ component: null });
	tick().then(next);
});

router.start();

Switch pages in App.svelte:

<svelte:component 
	this={component || Loading} 
	{...state} 
	{pathname} 
	{path} 
	{hash} 
	{params} 
	{query}
/>

<script>
	import Loading from './Loading.svelte';

	export let component = null,
		pathname = '',
		path = '',
		hash = '',
		params = {},
		query = {},
		state = {};
</script>

Use preload function to preload some data before page component will be rendered:

<ul>
{#each items as item}
	<li>{item.title}</li>
{/each}
</ul>

<script context="module">
	export async function preload(ctx) {
		const res = fetch(`/items/${ctx.params.id}?type=${ctx.params.type}&page=${ctx.query.page}`);
		const items = res.json();
		return { items };
	}
</script>

<script>
	export let items = [];
</script>

Context

Is a context object from pagejs with additional property component which is a Svelte component associated with the current route.

Methods

router.base(); // base path
router.strict(true); // strict matching

router.before((ctx, next) => { /* ... */ }); // guard before any route
router.after((ctx, next) => { /* ... */ }); // guard after any route

router.enter((ctx, next) => { /* ... */ }); // guard entring any route
router.exit((ctx, next) => { /* ... */ }); // guard exiting any route

router.start(); // start listening
router.stop(); // stop listening

router.redirect('/some'); // redirects
router.back(); // history back

License

MIT