Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Hooks

  • useObservable<T>(initializer: T | (() => T), deps?: DependencyList, options?: UseObservableOptions<T>): T
  • React hooks to make current component reactive to mobx observables, both locally and externally.

    Example:

    // create local store
    let localStore = useObservable({ name: 'jon', description: 'Knows nothing' })

    // use external observable
    useObservable(storeFromEssos)

    // mixed
    let localStore = useObservable({
    name: 'jon',
    get familyName() {
    if (this.name === 'jon') {
    return starkFamily.bastardName // 'snow'
    } else {
    return starkFamily.name // 'stark'
    }
    }
    })

    Type Parameters

    • T extends Store

      Plain object or an observable

    Parameters

    • initializer: T | (() => T)

      Observable initializer

    • deps: DependencyList = []

      Dependency list of initializer. When changed, a new observable will be created

    • options: UseObservableOptions<T> = {}

    Returns T

    An observable

Store: Record<string, any>

Types

UseObservableOptions<T>: { annotations?: AnnotationsMap<T, never>; onUpdate?: any; autorunOptions?: IAutorunOptions; batch?: boolean }

Options for useObservable

Type Parameters

  • T

Type declaration

Generated using TypeDoc