Spec-Zone.ru › Angular.js 1.2

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

  1. $route
  2. provider в модуле ngRoute

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

См. $route для примера настройки и использования ngRoute.

Зависимости

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

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

$routeProvider();

Методы

  • 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 Object

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

    Возвращаемое значение

    Object

    self

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

Spec-Zone.ru

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