Spec-Zone.ru › Angular.js 1.4

Улучшить эту документацию Просмотреть исходный код $routeProvider

  1. $route
  2. поставщик в модуле ngRoute

Используется для конфигурации маршрутов.

См. $route для примера конфигурации и использования ngRoute.

Зависимости

Требуется модуль ngRoute для установки.

Методы

  • when(path, route);

    Добавляет новое определение маршрута в сервис $route.

    Параметры

    Параметр Тип Подробности
    path string

    Путь маршрута (сопоставляется с $location.path). Если $location.path содержит лишний конечный слэш или ему не хватает одного, маршрут всё равно будет сопоставлен, и $location.path будет обновлён, чтобы добавить или удалить конечный слэш для точного соответствия определению маршрута.

    • path может содержать именованные группы, начинающиеся с двоеточия: например, :name. Все символы до следующего слэша сопоставляются и сохраняются в $routeParams под заданным name при совпадении маршрута.
    • path может содержать именованные группы, начинающиеся с двоеточия и заканчивающиеся звездочкой: например, :name*. Все символы жадно сохраняются в $routeParams под заданным name при совпадении маршрута.
    • path может содержать необязательные именованные группы с вопросительным знаком: например, :name?.

      Например, маршруты, такие как /color/:color/largecode/:largecode*\/edit будут соответствовать /color/brown/largecode/code/with/slashes/edit и извлекать:

    • color: brown

    • largecode: code/with/slashes.
    route Object

    Информация о сопоставлении, которая должна быть назначена $route.current при совпадении маршрута.

    Свойства объекта:

    • controller – {(string|function()=} – Функция контроллера, которая должна быть связана с вновь созданным scope или имя зарегистрированного контроллера, если передано в виде строки.
    • controllerAs – {string=} – Имя идентификатора для ссылки на контроллер. Если присутствует, контроллер будет опубликован в scope под именем controllerAs.
    • template – {string=|function()=} – html шаблон в виде строки или функции, которая возвращает html шаблон в виде строки, который должен быть использован директивами ngView или ngInclude. Это свойство имеет приоритет над templateUrl.

      Если template является функцией, она будет вызвана со следующими параметрами:

      • {Array.<Object>} - параметры маршрута, извлечённые из текущего $location.path() путём применения текущего маршрута
    • templateUrl – {string=|function()=} – путь или функция, которая возвращает путь к html шаблону, который должен быть использован директивой ngView.

      Если templateUrl является функцией, она будет вызвана со следующими параметрами:

      • {Array.<Object>} - параметры маршрута, извлечённые из текущего $location.path() путём применения текущего маршрута
    • resolve - {Object.<string, function>=} - необязательный набор зависимостей, которые должны быть инжектированы в контроллер. Если какие-либо из этих зависимостей являются обещаниями, маршрутизатор будет ждать, пока все они будут решены или одна будет отклонена, прежде чем контроллер будет создан. Если все обещания будут успешно решены, значения разрешённых обещаний будут инжектированы, и событие $routeChangeSuccess будет сгенерированно. Если любое из обещаний будет отклонено, событие $routeChangeError будет сгенерированно. Объект карты:

      • key – {string}: имя зависимости, которая должна быть инжектирована в контроллер.
      • factory - {string|function}: Если string - это псевдоним сервиса. В противном случае, если функция, она будет инжектирована, а возвращаемое значение будет рассматриваться как зависимость. Если результат является обещанием, оно разрешается, прежде чем его значение будет инжектировано в контроллер. Имейте в виду, что ngRoute.$routeParams всё равно будет ссылаться на предыдущий маршрут в этих функциях разрешения. Используйте $route.current.params для доступа к параметрам нового маршрута.
    • redirectTo – {(string|function())=} – значение для обновления пути $location и запуска перенаправления маршрута.

      Если redirectTo является функцией, она будет вызвана со следующими параметрами:

      • {Object.<string>} - параметры маршрута, извлечённые из текущего $location.path() путём применения текущего шаблона маршрута
      • {string} - текущий $location.path()
      • {Object} - текущий $location.search()

      Ожидается, что настраиваемая функция redirectTo вернёт строку, которая будет использована для обновления $location.path() и $location.search().

    • [reloadOnSearch=true] - {boolean=} - перезагрузить маршрут, когда изменяются только $location.search() или $location.hash().

      Если параметр установлен в false и URL в браузере изменится, то событие $routeUpdate будет распространено в корневом scope.

    • [caseInsensitiveMatch=false] - {boolean=} - соответствие маршрутов без учёта регистра

      Если параметр установлен в true, то конкретный маршрут может быть сопоставлен без учёта регистра.

    Возвращает

    Object

    self

  • otherwise(params);

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

    Параметры

    Параметр Тип Подробности
    params Objectstring

    Информация о сопоставлении, которая должна быть назначена $route.current. Если используется строка, значение сопоставляется с redirectTo.

    Возвращает

    Object

    self

Свойства

  • caseInsensitiveMatch

    Логическое свойство, указывающее, должны ли маршруты, определённые с помощью этого поставщика, сопоставляться с помощью алгоритма, не учитывающего регистр. По умолчанию false.

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.4.14/docs/api/ngRoute/provider/$routeProvider

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API