Interface IViewModelBase

Базовая вью модель.

interface IViewModelBase {
    alias: null | string;
    disposeList: DisposeList;
    info: null | IStorage;
    isMounted: boolean;
    isReady: boolean;
    onReady: EventHandler<EmptyEvent, IViewModelBase>;
    uiId: number;
    dispose(): void;
    mount(
        ref?: ViewModelBaseComponentRef<unknown>,
        actionsRef?: ViewModelBaseComponentRef<unknown>,
    ): void;
    tryGetComponentActionsRef<T = object>(): null | T;
    tryGetComponentRef<T = Element>(): null | T;
    unmount(): void;
}

Hierarchy (View Summary)

Implemented by

Properties

alias disposeList info isMounted isReady onReady uiId

Methods

dispose mount tryGetComponentActionsRef tryGetComponentRef unmount

Properties

alias

alias: null | string

Псевдоним модели представления.

ReadonlydisposeList

disposeList: DisposeList

Функции, которые будут вызваны в конце жизненного цикла вью модели. Может использоваться для очистки связанных объектов, если их жизненный цикл совпадает с жизненным циклом вью модели.

Example

vm.disposeList.add(reaction(
  () => vm.isMounted,
  v => console.log(`vm.isMounted = ${v}`)
));

info

info: null | IStorage

Хранилище любой дополнительной информации вью модели.

ReadonlyisMounted

isMounted: boolean

Флаг указывающий на то, что вью компонент смонтирован.

ReadonlyisReady

isReady: boolean

Флаг указывающий на то, что вью модель готова к работе.

ReadonlyonReady

onReady: EventHandler<EmptyEvent, IViewModelBase>

Событие вызывается когда вью модель готова к использованию. Событие может вызываться несколько раз за время жизни вью модели. Обработчик может вернуть функцию очистки, которая будет вызвана, когда вью модель перестанет считаться готовой к работе, т.е. компонент размонтирован или вызван dispose вью модели.

Example

vm.onReady.add(() => {
 console.log('ready');
 return () => console.log('unready');
});

ReadonlyuiId

uiId: number

Уникальный идентификатор UI элемента.

Methods

dispose

  • dispose(): void

    Returns void

mount

  • mount(
        ref?: ViewModelBaseComponentRef<unknown>,
        actionsRef?: ViewModelBaseComponentRef<unknown>,
    ): void

    Метод вызывается при монтировании вью компонента и может передавать ссылку на сам компонент.

    Parameters

    Returns void

tryGetComponentActionsRef

  • tryGetComponentActionsRef<T = object>(): null | T

    Ссылка на императивные методы вью компонента.

    Type Parameters

    • T = object

    Returns null | T

tryGetComponentRef

  • tryGetComponentRef<T = Element>(): null | T

    Ссылка на вью компонент.

    Type Parameters

    • T = Element

    Returns null | T

unmount

  • unmount(): void

    Метод вызывается при размонтировании вью компонента.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods