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

ninelines-router

v1.0.4

Published

JavaScript router

Downloads

10

Readme

ninelines-router

Минималистичный JavaScript роутер для работы с одностраничными сайтами и приложениями (SPA).

Особенности:

  • Параметризованные URL (благодаря библиотеке path-to-regexp);
  • Поддержка Promise;
  • Удобная работа с URL и GET-параметрами (благодаря библиотекам url-parse и querystringify);
  • Именованные маршруты;
  • Поддержка создания переходов для предзаданных маршрутов.

Установка

NPM

Для установки с помощью npm требуется выполнить следующую команду:

npm install --save ninelines-router

Использование

Основы

После установки роутер необходимо подключить:

import {Router} from 'ninelines-router';

И инициализировать:

let router = new Router();

При отсутствии модульной системы библиотека (dist/ninelines-router.js) экспортирует Router в глобальный объект ninelines.router:

let router = new ninelines.router.Router();

Далее создаем необходимые маршруты:

router.addRoute({
    path: '/',
    onEnter() {
        // ...
    },
});

router.addRoute({
    path: '/about',
    onEnter() {
        // ...
    },
});

router.addRoute({
    path: '/contacts',
    onEnter() {
        // ...
    },
});

И в конце запускаем роутер:

router.start();

Параметризованные URL

Роутер поддерживает создание маршрутов с параметризованными URL.

router.addRoute({
    path: '/article/:id',
    onEnter(prevState, currentState) {
        let id = currentState.params.id;

        // ...
    },
});

prevState и currentState хранят состояние сайта в различный момент времени: prevState до перехода, currentState после перехода.

Объект состояния имеет следующую структуру:

{
    route: Route,
    params: Object,
    query: Object,
}
  • route - инстанс маршрута, который соответствует данному состоянию или null, если такого маршрута нет (например, prevState.route === null при первом переходе на сайт);
  • params - объект с параметрами данного состояния;
  • query - объект с GET-параметрами данного состояния;

Пример:

router.addRoute({
    path: '/article/:id',
    onEnter(prevState, currentState) {
        // При переходе по ссылке /article/42
        // currentState.params === {id: '42'}
        // currentState.query === {}

        // При переходе по ссылке /article/42?x=10&y=4&z=8
        // currentState.params === {id: '42'}
        // currentState.query === {x: '10', y: '4', z: '8'}
    },
});

Более подробную информацию о параметризованных URL можно найти в документации к библиотеке path-to-regexp.

Именованные маршруты

Роутер поддерживает создание именованных маршрутов:

router.addRoute({
    path: '/',
    name: 'home',
    onEnter() {
        // ...
    },
});

router.addRoute({
    path: '/about',
    name: 'about',
    onEnter() {
        // ...
    },
});

router.addRoute({
    path: '/article/:id',
    name: 'article',
    onEnter(prevState, currentState) {
        // ...
    },
});

Переходы между страницами

Перейти на другую страницу можно следующим образом:

router.navigate('/');

router.navigate('/article/42');

// Первым параметром можно передать имя маршрута
router.navigate('article', {
    params: {
        id: 42,
    },
});

Также имеется возможность привязать любую ссылку к роутеру, добавив атрибут data-router-link:

<a href="/article/42" data-router-link>
    Перейти на 42-ую статью
</a>

Если ссылки с атрибутом data-router-link подгружаются динамически вместе с контентом, то требуется вручную привязать их к роутеру:

router.bindLinks();

События

Маршруты поддерживают три основные события:

  • beforeEnter - срабатывает до перехода по маршруту;
  • enter - срабатывает после перехода по маршруту;
  • leave - срабатывает при покидании маршрута;

Пример:

router.addRoute({
    path: '/',
    onBeforeEnter(currentState, nextState) {
        // ...
    },
    onEnter(prevState, currentState) {
        // ...
    },
    onLeave(currentState, nextState) {
        // ...
    },
});

Сам роутер поддерживает следующие события:

  • start - срабатывает до события beforeEnter;
  • leave - срабатывает при покидании какого-либо маршрута;
  • beforeEnter - срабатывает до перехода по какому-либо маршруту;
  • enter - срабатывает после перехода по какому-либо маршруту;
  • complete - срабатывает после завершения события enter;
  • notFound - срабатывает в том случае, если подходящий маршрут не найден;

Пример:

router.on('notFound', (path) => {
    // ...
});

При необходимости событие можно вызвать вручную:

router.trigger('notFound', [location.pathname]);

Использование Promise

При необходимости из любого события можно вернуть Promise:

let pageHome = document.getElementById('page-home');

router.addRoute({
    path: '/',
    onEnter() {
        return new Promise((resolve) => {
            pageHome.classList.remove('is-hidden');

            TweenMax.from(pageHome, 1, {
                opacity: 0,
                clearProps: 'opacity',
                onComplete() {
                    resolve();
                },
            });
        });
    },
    onLeave() {
        return new Promise((resolve) => {
            TweenMax.to(pageHome, 1, {
                opacity: 0,
                onComplete() {
                    pageHome.classList.add('is-hidden');
                    
                    TweenMax.set(pageHome, {
                        clearProps: 'opacity',
                    });
                    
                    resolve();
                },
            });
        });
    },
});

Transition

Transition используется для обработки предзаданных переходов.

router.addRoute({
    path: '/',
});

router.addRoute({
    path: '/about',
});

router.addRoute({
    path: '/article/:id',
    name: 'article',
});

router.addRoute({
    path: '/news/:year/:month/:day',
    name: 'news',
});

// Переход / => /about
router.addTransition({
    from: '/',
    to: '/about',
    onEnter() {
        // ...
    },
});

// Переход article => news
router.addTransition({
    from: 'article',
    to: 'news',
    onEnter() {
        // ...
    },
});

Того же результата можно добиться и без Transition:

router.addRoute({
    path: '/',
});

router.addRoute({
    path: '/about',
    onEnter(prevState, currentState) {
        if (prevState.route.path === '/') {
            // ...
        }
    },
});

router.addRoute({
    path: '/article/:id',
    name: 'article',
});

router.addRoute({
    path: '/news/:year/:month/:day',
    name: 'news',
    onEnter(prevState, currentState) {
        if (prevState.route.name === 'article') {
            // ...
        }
    },
});

Но синтаксис addTransition проще, чем множество условий. К тому же Transition поддерживает события beforeEnter, enter, leave и предоставляет два дополнительных события:

  • start - начало перехода;
  • complete - конец перехода;

Порядок вызова событий выглядит следующим образом:

  1. start
  2. leave
  3. beforeEnter
  4. enter
  5. complete
router.addTransition({
    from: '/',
    to: '/about',
    onStart(currentState, nextState) {
        // ...
    },
    onLeave(currentState, nextState) {
        // ...
    },
    onBeforeEnter(currentState, nextState) {
        // ...
    },
    onEnter(prevState, currentState) {
        // ...
    },
    onComplete(prevState, currentState) {
        // ...
    },
});

API

EventEmitter

EventEmitter()

.on(eventName, handler)

.off(eventName)

.off(eventName, handler)

.trigger(eventName)

.trigger(eventName, params)

.trigger(eventName, params, context)

Route (наследуется от EventEmitter)

Route({path, name, onBeforeEnter, onEnter, onLeave, options})

.execPath(path)

.generatePath({params, query, hash})

Transition (наследуется от EventEmitter)

Transition({from, to, onStart, onLeave, onBeforeEnter, onEnter, onComplete})

Router (наследуется от EventEmitter)

Router({onStart, onLeave, onBeforeEnter, onEnter, onComplete, onNotFound})

.addRoute(route)

.addRoute({path, name, onBeforeEnter, onEnter, onLeave, options})

.addTransition(transition)

.addTransition({from, to, onStart, onLeave, onBeforeEnter, onEnter, onComplete})

.getRouteByPath(path)

.getRouteByName(name)

.getTransitionByRoutes(from, to)

.getTransitionByRoutePaths(fromPath, toPath)

.getTransitionByRouteNames(fromName, toName)

.resolve(path)

.resolve(path, {method})

.navigate(path)

.navigate(path, {params, query, hash, method})

.bindLinks()

.listen()

.start()