Spec-Zone.ru › Angular.js 1.3

Улучшить эту документацию Посмотреть исходный код $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.3.20/docs/api/ngRoute/provider/$routeProvider

Spec-Zone.ru

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