48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
|
## API Report File for "@tldraw/state-react"
|
||
|
|
||
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||
|
|
||
|
```ts
|
||
|
|
||
|
import { Atom } from '@tldraw/state';
|
||
|
import { AtomOptions } from '@tldraw/state';
|
||
|
import { Computed } from '@tldraw/state';
|
||
|
import { ComputedOptions } from '@tldraw/state';
|
||
|
import { FunctionComponent } from 'react';
|
||
|
import { default as React_2 } from 'react';
|
||
|
import { Signal } from '@tldraw/state';
|
||
|
|
||
|
// @public
|
||
|
export function track<T extends FunctionComponent<any>>(baseComponent: T): React_2.NamedExoticComponent<React_2.ComponentProps<T>>;
|
||
|
|
||
|
// @public
|
||
|
export function useAtom<Value, Diff = unknown>(
|
||
|
name: string,
|
||
|
valueOrInitialiser: (() => Value) | Value,
|
||
|
options?: AtomOptions<Value, Diff>): Atom<Value, Diff>;
|
||
|
|
||
|
// @public
|
||
|
export function useComputed<Value>(name: string, compute: () => Value, deps: any[]): Computed<Value>;
|
||
|
|
||
|
// @public (undocumented)
|
||
|
export function useComputed<Value, Diff = unknown>(name: string, compute: () => Value, opts: ComputedOptions<Value, Diff>, deps: any[]): Computed<Value>;
|
||
|
|
||
|
// @public (undocumented)
|
||
|
export function useQuickReactor(name: string, reactFn: () => void, deps?: any[]): void;
|
||
|
|
||
|
// @public (undocumented)
|
||
|
export function useReactor(name: string, reactFn: () => void, deps?: any[] | undefined): void;
|
||
|
|
||
|
// @public
|
||
|
export function useStateTracking<T>(name: string, render: () => T): T;
|
||
|
|
||
|
// @public
|
||
|
export function useValue<Value>(value: Signal<Value>): Value;
|
||
|
|
||
|
// @public (undocumented)
|
||
|
export function useValue<Value>(name: string, fn: () => Value, deps: unknown[]): Value;
|
||
|
|
||
|
// (No @packageDocumentation comment for this package)
|
||
|
|
||
|
```
|