Документация API / RouterHistory
Интерфейс: RouterHistory
Интерфейс, который имплементирует реализации истории, которые могут быть переданы роутеру в качестве Router.history.
Свойства
base
• Только для чтения base: string
Базовый путь, который добавляется ко всем URL. Это позволяет размещать одностраничное приложение (SPA) в подпапке домена, например, example.com/sub-folder, установив base равным /sub-folder.
location
• Только для чтения location: string
Текущее местоположение истории
state
• Только для чтения state: HistoryState
Текущее состояние истории
Methods
createHref
▸ createHref(location): string
Генерирует соответствующий href для использования в якорной ссылке.
Параметры
| Название | Тип | Описание |
|---|---|---|
location | string | адрес истории, который должен создать href |
Возвращает
string
destroy
▸ destroy(): void
Очищает все слушатели событий, добавленные реализацией истории.
Возвращает
void
go
▸ go(delta, triggerListeners?): void
Перемещение истории в заданном направлении.
Параметры
| Название | Тип | Описание |
|---|---|---|
delta | number | расстояние, на которое нужно переместиться. Если delta < 0, то будет совершено перемещение назад, а если > 0, то вперед на заданное количество шагов. |
triggerListeners? | boolean | следует ли запускать слушателей, добавленных к истории |
Возвращает
void
Пример
myHistory.go(-1) // эквивалент window.history.back()
myHistory.go(1) // эквивалент window.history.forward()listen
▸ listen(callback): () => void
Добавляет к реализации истории слушатель, который будет срабатывать при вызове навигации снаружи (например, через кнопки браузера "назад" и "вперед" ) или при передаче true в RouterHistory.back и RouterHistory.forward
Параметры
| Название | Тип | Описание |
|---|---|---|
callback | NavigationCallback | слушатель для добавления |
Возвращает
fn
коллбек для удаления слушателя
▸ (): void
Возвращает
void
push
▸ push(to, data?): void
Осуществляет переход к местоположению. В случае HTML5 History, это вызовет history.pushState для эффективного изменения URL.
Параметры
| Название | Тип | Описание |
|---|---|---|
to | string | описания пути для перехода |
data? | HistoryState | опциональное HistoryState, связанное с записью навигации |
Возвращает
void
replace
▸ replace(to, data?): void
Аналогично RouterHistory.push, но заместо history.replaceState вызывается history.pushState
Параметры
| Название | Тип | Описание |
|---|---|---|
to | string | описание пути |
data? | HistoryState | опциональное HistoryState, связанное с записью навигации |
Возвращает
void