Документация API / RouterOptions

Интерфейс: RouterOptions

Параметры инициализации экземпляра Router.

Иерархия

• PathParserOptions

  ↳ RouterOptions

Свойства

end

• Опционально end: boolean

Должен ли RegExp искать до конца при добавлении к нему $.

Значение по умолчанию

true

Наследуется от

PathParserOptions.end

---

history

• history: RouterHistory

Реализация истории, используемая маршрутизатором. Большинство веб-приложений должны использовать createWebHistory, но это требует правильной настройки сервера. Вы также можете использовать историю на основе хеша при помощи createWebHashHistory, которая не требует никакой конфигурации на сервере, но она не обрабатывается поисковыми системами и имеет плохие показатели для SEO.

Пример

createRouter({
  history: createWebHistory(),
  // другие опции...
})

---

linkActiveClass

• Опционально linkActiveClass: string

Класс по умолчанию, применяемый к активному RouterLink. Если ничего не указано, будет применяться router-link-active.

---

linkExactActiveClass

• Опционально linkExactActiveClass: string

Класс по умолчанию, применяемый к активному "по точному совпадению" RouterLink. Если ничего не указано, будет применяться router-link-exact-active.

---

parseQuery

• Опционально parseQuery: (search: string) => LocationQuery

Пользовательская реализация для парсинга query. См. ее аналог, RouterOptions.stringifyQuery.

Пример

Допустим, вы хотите использовать пакет qs для парсинга query, вы можете предоставить как parseQuery, так и stringifyQuery:

import qs from 'qs'

createRouter({
  // другие опции...
  parseQuery: qs.parse,
  stringifyQuery: qs.stringify,
})

Объявление типа

▸ (search): LocationQuery

Пользовательская реализация для парсинга query. См. противоположную функцию RouterOptions.stringifyQuery.

Параметры

Название	Параметры
search	string

Возвращает

LocationQuery

Пример

Допустим, вы хотите использовать пакет qs для парсинга query. Вы можете предоставить как parseQuery, так и stringifyQuery:

import qs from 'qs'

createRouter({
  // другие опции...
  parseQuery: qs.parse,
  stringifyQuery: qs.stringify,
})

---

routes

• routes: readonly RouteRecordRaw[]

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

---

scrollBehavior

• Опционально scrollBehavior: RouterScrollBehavior

Функция для управления прокруткой при переходе между страницами. Может возвращать Promise для задержки прокрутки. См. ScrollBehavior.

Пример

function scrollBehavior(to, from, savedPosition) {
  // `to` и `from` - это оба описания маршрутов
  // `savedPosition` может быть null, если его нет
}

---

sensitive

• Опционально sensitive: boolean

Сделать RegExp регистрозависимым.

Значение по умолчанию

false

Наследуется от

PathParserOptions.sensitive

---

strict

• Опционально strict: boolean

Запрещать или не запрещать слэш в конце строки.

Значение по умолчанию

false

Наследуется от

PathParserOptions.strict

---

stringifyQuery

• Опционально stringifyQuery: (query: LocationQueryRaw) => string

Пользовательская реализация для преобразования объекта запроса в строку query. Не должна добавлять начальный символ ?. parseQuery - противоположная функция для парсинга запроса.

Объявление типа

▸ (query): string

Пользовательская реализация для преобразования объекта запроса в строку query. Не должна добавлять начальный символ ?. parseQuery - противоположная функция для парсинга запроса.

Параметры

Название	Тип
query	LocationQueryRaw

Возвращает

string