Юниверс DG SDK UI
v2.15.0

Интерфейс History

interface History {
    action: Action;
    length: number;
    location: Location;
    block(
        prompt?:
            | string
            | boolean
            | ((location: Location, action: Action) => string | false | void),
    ): () => void;
    createHref(
        location: Universe.Platform.Router.LocationDescriptorObject,
    ): string;
    go(n: number): void;
    goBack(): void;
    goForward(): void;
    listen(listener: (location: Location, action: Action) => void): () => void;
    push(location: LocationDescriptor<unknown>, state?: unknown): void;
    replace(location: LocationDescriptor<unknown>, state?: unknown): void;
}
Индекс

Свойства

action: Action

Действие выполняемое при работе с историей

length: number

Количество записей в истории

location: Location

Текущее положение в истории

Методы

  • Блокирует или задает пользовательское подтверждение при изменении истории.

    Параметры

    • Optionalprompt:
          | string
          | boolean
          | ((location: Location, action: Action) => string | false | void)

      Настраиваемое подтверждение или функция обратного вызова.

    Возвращает () => void

  • Переходит на указанное количество записей в истории.

    Параметры

    • n: number

      Количество шагов (положительное или отрицательное).

    Возвращает void

  • Переходит на предыдущую запись в истории.

    Возвращает void

  • Переходит на следующую запись в истории.

    Возвращает void

  • Добавляет слушатель изменений в истории.

    Параметры

    • listener: (location: Location, action: Action) => void

      Функция, вызываемая при смене состояния.

    Возвращает () => void

  • Добавляет новую запись в историю.

    Параметры

    • location: LocationDescriptor<unknown>

      Путь или объект параметров.

    • Optionalstate: unknown

      Дополнительное состояние.

    Возвращает void

  • Заменяет текущую запись в истории.

    Параметры

    • location: LocationDescriptor<unknown>

      Путь или объект параметров.

    • Optionalstate: unknown

      Дополнительное состояние.

    Возвращает void