Strash Router

Version 1.0.4

Установка
Методы
Псевдонимы

Установка

Инициирование роутера
Добавление точек монтирования в HTML разметку
Создание компонента

Инициирование роутера

В минифицированном файле роутера отсутствуют предупреждения об ошибках.

const router = new STRouter([
  {
    path: '/',
    components: {
      menu: Menu,
      pageOne: PageOne
    }
  },
  {
    path: '/about',
    components: {
      menu: Menu,
      pageTwo: PageTwo
    }
  },
  {
    path: '/project/:placeholder',
    components: {
      menu: Menu,
      pageThree: PageThree
    }
  },
  // 404
  {
    path: '*',
    components: {
      menu: Menu,
      pageError: PageError
    }
  }
]);

// запуск роутера
router.render();

Плейсхолдеры пути

Роутер поддерживает динамические пути с плейсхолдерами — path: /project/:placeholder. Что будет соответствовать пути /projects/the-best-project или /projects/the-best-project/. Плейсхолдеры могут быть многоуровневыми — path: /project/:placeholder/info/:infopage. Имя плейсхолдера ни к чему не привязано, поэтому не имеет значения.

Добавление точек монтирования в разметку.

<router-view name="menu"></router-view>
<router-view name="pageOne"></router-view>
<router-view name="pageTwo"></router-view>
<router-view name="pageThree"></router-view>
<router-view name="pageError"></router-view>

При рендеринге тэги заменяются на <div name="component-ComponentName">. Внутрь <div> монтируется шаблон компонента.

<div name="component-menu"></div>
<div name="component-pageOne"></div>
<div name="component-pageTwo"></div>
<div name="component-pageThree"></div>
<div name="component-pageError"></div>

Создание компонента

Компонент может быть как функцией, которая возвращает объект, так и простым объектом. Внутри компонента доступны свойства:

Component.template — строка шаблона;
Component.children — потомки компонента монтируются как есть без обертки. При этом в шаблон нужно добавить тэг <router-view name="component"></router-view>;
Component.methods — объект с методами. Методы можно вызывать внутри шаблона с помощью двойных фигурных скобок {{addLink}}, один должны возвращать строку. Роутером автоматически будут исполнятся только те методы, которые вызываются из шаблона;
Component.beforeMount — сюда можно записать события, которые нужно выполнить до монтирования компонента. Принимает функцию или промис, который нужно возвратить, чтобы поставить в цепочку.
Component.mounted — сюда можно добавить вызов методов или другие события, которые нужно выполнить во время монтирования компонента.

Помимо свойств и методов роутера в компоненте допускается использовать свои незарезервированные свойства и методы, которые будут игнорироваться роутером.

import Header from './header.js';

let Page = () => {
  return {
    // шаблон
    template: `
    <div>
      <router-view name="header"></router-view>
    </div>
    {{addLink}}`,
    // потомки
    children: {
      // встраиваемый компонент
      header: Header
    },
    // методы
    methods: {
      _scroll () {
        // do something
      }
      checkRoute () {
        if (/projects/.test(location.pathname)) return true;
        else return false;
      },
      addLink () {
        if (this.checkRoute())
        return `<div style="margin:50px 0; padding: 50px; background-color:grey; height:150px; color: white;">Project</li>`;
        else return '';
      }
    },
    // действия выполняемые перед монтированием компонента
    beforeMount () {
      this.checkRoute();
      // например, загрузка данных
      return API.getData();
    },
    // действия выполняемые во время монтирования
    mounted () {
      this.checkRoute();
      // добавление в реестр слушателя
      router.addListener({
        target:   document,
        type:     'scroll',
        listener: _scroll.bind(this),
        name:     'scrollPage',
        once:     true
      });
    }
  };
};

Активные ссылки

Роутер автоматически проставляет активным ссылкам класс .router-link-active.

addListener

Метод new STRouter().addListener() устанавливает слушателя событий. Принимает объект с шестью свойствами:

target {object HTMLDocument} — Обязательный параметр. Объект слушателя;
type {String} — Обязательный параметр и нативный атрибут. Тип слушателя;
listener {Function} — Обязательный параметр и нативный атрибут. Функция колбэка;
options {Object} — Опциональный объект и нативный атрибут, который определяет характеристики объекта, прослушивающего событие;
name {String} — Обязательный параметр. Имя слушателя для поиска по реестру слушателей;
once {Boolean} — Опциональный параметр. Жизненный цикл слушателя. При значении true слушатель удаляется автоматически во время перехода на другую страницу. При значении false слушатель не удаляется автоматически. По-умолчанию установлено значение false.

new STRouter().addListener({
  target: document,
  type: 'click',
  listener: callback.bind(this),
  options:  {
    capture: Boolean,
    once:    Boolean,
    passive: Boolean
  },
  name: 'clickButtons',
  once: true
});

Реестр зарегистрированных слушателей можно получить из new STRouter().listeners. Удалить слушателя можно с помощью метода new STRouter().removeListeners.

getDefaultRoute

Геттер new STRouter().getDefaultRoute возвращает объект с компонентами для несуществующих страниц, например 404. Если не задан объект по-умолчанию, то роутер выдаст предупреждение.

getLocation

Геттер new STRouter().getLocation или STRouter.getLocation возвращает объект с данными адресной строки.

{
  hash:   location.hash,
  href:   location.href,
  origin: location.origin,
  path:   location.pathname,
  search: location.search,
}

getRouteComponents

Метод new STRouter().getRouteComponents() возвращает объект с компонентами, соответствующими текущему пути. Если не заданы пути, то роутер выдаст предупреждение.

{
  components: {
    menu:    Function || Object,
    pageOne: Function || Object
  }
  path: '/'
}

removeListeners

Метод new STRouter().removeListeners() принимает строку с именем слушателя или объект с тремя свойствами:

target {object HTMLDocument} — Объект слушателя;
type {String} — Нативный атрибут. Тип слушателя;
name {String} — Имя слушателя для поиска по реестру слушателей.

Позволяет удалять зарегистрированных слушателей с помощью метода new STRouter().addListener(). При удалении слушателей с объектов прослушивания, они удаляются и из реестра. Доступные способы удаления:

Без аргументов удаляются слушатели имеющие флаг once: true;
С аргументом {target}. Удаляются все слушатели с данного объекта;
С аргументом {type}. Удаляются все слушатели данного типа;
С аргументом {target, type}. Удаляются все слушатели данного типа с заданного объекта.
С аргументом {name} или 'name' или {target, type, name}. Удаляются все слушатели с таким именем. При всех переданных аргументах учитывается только name.

render

Метод new STRouter().render() перерендерит страницу если экземпляр класса уже был создан. Если не был создан, то в роутер необходимо передать компонент, который должен быть отрендерен.

version

Геттер STRouter.version возвращает строку с версией роутера.

Псевдонимы

window.$routes псевдоним STRouter.routes.

window.$location псевдоним STRouter.getLocation.

strash/Strash-router