@formvk/reactive-react 1.1.1 → 1.2.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [1.2.0-beta.1](https://github.com/formvk/core/compare/v1.2.0-beta.0...v1.2.0-beta.1) (2026-11-18)
7
+
8
+ **Note:** Version bump only for package @formvk/reactive-react
9
+
10
+ # [1.2.0-beta.0](https://github.com/formvk/core/compare/v1.1.1...v1.2.0-beta.0) (2026-11-17)
11
+
12
+ **Note:** Version bump only for package @formvk/reactive-react
13
+
6
14
  ## [1.1.1](https://github.com/formvk/core/compare/v1.1.0...v1.1.1) (2026-11-17)
7
15
 
8
16
  **Note:** Version bump only for package @formvk/reactive-react
package/README.en.md ADDED
@@ -0,0 +1,56 @@
1
+ # @formvk/reactive-react
2
+
3
+ [English](./README.en.md) | [简体中文](./README.md)
4
+
5
+ React bindings for `@formvk/reactive`. Wrap a component with `observer` and it re-renders whenever observable data read during render changes.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ pnpm add @formvk/reactive-react
11
+ ```
12
+
13
+ `react` and `react-dom` (`>= 18`) are peer dependencies.
14
+
15
+ ## Usage
16
+
17
+ ```tsx
18
+ import { observable } from '@formvk/reactive'
19
+ import { observer } from '@formvk/reactive-react'
20
+
21
+ const state = observable({ count: 0 })
22
+
23
+ export const Counter = observer(() => <button onClick={() => (state.count += 1)}>count: {state.count}</button>)
24
+ ```
25
+
26
+ Render-prop form for local subscriptions:
27
+
28
+ ```tsx
29
+ import { Observer } from '@formvk/reactive-react'
30
+
31
+ function Count() {
32
+ return <Observer>{() => <span>{state.count}</span>}</Observer>
33
+ }
34
+ ```
35
+
36
+ `observer` accepts `{ forwardRef, displayName, scheduler }` options:
37
+
38
+ ```tsx
39
+ const Input = observer(MyInput, { forwardRef: true, displayName: 'Input' })
40
+ ```
41
+
42
+ ## API
43
+
44
+ - `observer(Component, options?)` — memoized wrapper that tracks observable reads and re-renders.
45
+ - `Observer` — component with a render-prop `children`.
46
+ - `useObserver(view, options?)` — run a render function inside the observer tracker.
47
+ - `useForceUpdate()` — force a re-render.
48
+ - Types — `IObserverOptions`, `IObserverProps`, `ReactFC`.
49
+
50
+ ## Documentation
51
+
52
+ https://formvk.github.io/core/en/api/react
53
+
54
+ ## License
55
+
56
+ MIT
package/README.md CHANGED
@@ -1,18 +1,18 @@
1
1
  # @formvk/reactive-react
2
2
 
3
- [English](./README.md) | [简体中文](./README.zh-CN.md)
3
+ [English](./README.en.md) | [简体中文](./README.md)
4
4
 
5
- React bindings for `@formvk/reactive`. Wrap a component with `observer` and it re-renders whenever observable data read during render changes.
5
+ `@formvk/reactive` 的 React 绑定。用 `observer` 包裹组件后,组件在渲染期间读取的可观察数据发生变化时会自动重新渲染。
6
6
 
7
- ## Install
7
+ ## 安装
8
8
 
9
9
  ```bash
10
10
  pnpm add @formvk/reactive-react
11
11
  ```
12
12
 
13
- `react` and `react-dom` (`>= 18`) are peer dependencies.
13
+ `react` 与 `react-dom`(`>= 18`)是 peer 依赖。
14
14
 
15
- ## Usage
15
+ ## 使用
16
16
 
17
17
  ```tsx
18
18
  import { observable } from '@formvk/reactive'
@@ -23,7 +23,7 @@ const state = observable({ count: 0 })
23
23
  export const Counter = observer(() => <button onClick={() => (state.count += 1)}>count: {state.count}</button>)
24
24
  ```
25
25
 
26
- Render-prop form for local subscriptions:
26
+ 用于局部订阅的 render-prop 形式:
27
27
 
28
28
  ```tsx
29
29
  import { Observer } from '@formvk/reactive-react'
@@ -33,7 +33,7 @@ function Count() {
33
33
  }
34
34
  ```
35
35
 
36
- `observer` accepts `{ forwardRef, displayName, scheduler }` options:
36
+ `observer` 支持 `{ forwardRef, displayName, scheduler }` 选项:
37
37
 
38
38
  ```tsx
39
39
  const Input = observer(MyInput, { forwardRef: true, displayName: 'Input' })
@@ -41,13 +41,13 @@ const Input = observer(MyInput, { forwardRef: true, displayName: 'Input' })
41
41
 
42
42
  ## API
43
43
 
44
- - `observer(Component, options?)` — memoized wrapper that tracks observable reads and re-renders.
45
- - `Observer` — component with a render-prop `children`.
46
- - `useObserver(view, options?)` — run a render function inside the observer tracker.
47
- - `useForceUpdate()` — force a re-render.
48
- - Types — `IObserverOptions`, `IObserverProps`, `ReactFC`.
44
+ - `observer(Component, options?)` — 带缓存的包装器,追踪可观察读取并触发重渲染。
45
+ - `Observer` — 以 render prop 作为 `children` 的组件。
46
+ - `useObserver(view, options?)` — 在 observer 的追踪上下文中执行渲染函数。
47
+ - `useForceUpdate()` — 强制重新渲染。
48
+ - 类型 — `IObserverOptions`、`IObserverProps`、`ReactFC`。
49
49
 
50
- ## Documentation
50
+ ## 文档
51
51
 
52
52
  https://formvk.github.io/core/api/react
53
53
 
package/dist/index.d.ts CHANGED
@@ -1,4 +1,9 @@
1
- import { default as default_2 } from 'react';
1
+ import { FC } from 'react';
2
+ import { MemoExoticComponent } from 'react';
3
+ import { PropsWithoutRef } from 'react';
4
+ import { ReactElement } from 'react';
5
+ import { ReactNode } from 'react';
6
+ import { RefAttributes } from 'react';
2
7
  import { Tracker } from '@formvk/reactive';
3
8
 
4
9
  /* Excluded from this release type: createAdministration */
@@ -15,7 +20,7 @@ export declare interface IObserverOptions {
15
20
  }
16
21
 
17
22
  export declare interface IObserverProps {
18
- children?: (() => default_2.ReactElement) | default_2.ReactNode;
23
+ children?: (() => ReactElement) | ReactNode;
19
24
  }
20
25
 
21
26
  export declare type Modify<T, R> = Omit<T, keyof R> & R;
@@ -27,16 +32,16 @@ export declare function observer<P, Options extends IObserverOptions = IObserver
27
32
  /* Excluded from this release type: ObserverAdministration */
28
33
 
29
34
  /** observer 包裹后的组件类型:按 forwardRef 选项决定是否携带 ref */
30
- declare type ObserverComponent<P, Options extends IObserverOptions> = default_2.MemoExoticComponent<ReactFC<Options extends {
35
+ declare type ObserverComponent<P, Options extends IObserverOptions> = MemoExoticComponent<ReactFC<Options extends {
31
36
  forwardRef: true;
32
37
  } ? P & {
33
- ref?: 'ref' extends keyof P ? P['ref'] : default_2.RefAttributes<unknown>;
34
- } : default_2.PropsWithoutRef<P>>>;
38
+ ref?: 'ref' extends keyof P ? P['ref'] : RefAttributes<unknown>;
39
+ } : PropsWithoutRef<P>>>;
35
40
 
36
- export declare type ReactFC<P = {}> = default_2.FC<ReactPropsWithChildren<P>>;
41
+ export declare type ReactFC<P = {}> = FC<ReactPropsWithChildren<P>>;
37
42
 
38
43
  export declare type ReactPropsWithChildren<P> = Modify<{
39
- children?: default_2.ReactNode | undefined;
44
+ children?: ReactNode | undefined;
40
45
  }, P>;
41
46
 
42
47
  /** 返回一个稳定的强制刷新函数,React 18+ 自动批处理会合并同一轮多次调用 */
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/hooks/trackerRegistry.ts","../src/hooks/useObserver.ts","../src/observer.tsx","../src/hooks/useForceUpdate.ts"],"sourcesContent":["import type { Dispose } from '@formvk/reactive'\n\nconst FALLBACK_DELAY = 10000\n\n/**\n * 渲染期创建的 Tracker 在组件被放弃挂载(StrictMode/Concurrent 中断)时\n * 等不到 effect 清理,需要垃圾回收兜底:原生 FinalizationRegistry 可用时用它,\n * 否则退化为定时器,避免响应式订阅泄漏。\n */\nclass TrackerRegistry {\n private native: FinalizationRegistry<Dispose> | undefined\n private timers = new Map<object, ReturnType<typeof setTimeout>>()\n\n constructor() {\n if (typeof FinalizationRegistry !== 'undefined') {\n this.native = new FinalizationRegistry<Dispose>(dispose => dispose())\n }\n }\n\n /** target 被 GC 时执行 dispose;token 用于后续 unregister */\n register(target: object, dispose: Dispose, token: object): void {\n this.unregister(token)\n if (this.native) {\n this.native.register(target, dispose, token)\n return\n }\n this.timers.set(\n token,\n setTimeout(() => {\n this.timers.delete(token)\n dispose()\n }, FALLBACK_DELAY)\n )\n }\n\n unregister(token: object): void {\n this.native?.unregister(token)\n const timer = this.timers.get(token)\n if (timer) {\n clearTimeout(timer)\n this.timers.delete(token)\n }\n }\n}\n\nexport const trackerRegistry = new TrackerRegistry()\n","import { Tracker } from '@formvk/reactive'\nimport { useRef, useSyncExternalStore } from 'react'\n\nimport type { IObserverOptions } from '../types'\nimport { trackerRegistry } from './trackerRegistry'\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport interface ObserverAdministration {\n tracker: Tracker | null\n onStoreChange: (() => void) | null\n /** 快照值:每次响应式变更都换成新 Symbol,驱动 useSyncExternalStore 重渲染 */\n stateVersion: symbol\n subscribe: (onStoreChange: () => void) => () => void\n getSnapshot: () => symbol\n}\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport function createTracker(adm: ObserverAdministration, options?: IObserverOptions): Tracker {\n return new Tracker(() => {\n adm.stateVersion = Symbol()\n // 首次渲染到挂载之间 onStoreChange 还不存在,useSyncExternalStore 会靠快照版本补刷新\n if (adm.onStoreChange) {\n if (typeof options?.scheduler === 'function') {\n options.scheduler(adm.onStoreChange)\n } else {\n adm.onStoreChange()\n }\n }\n })\n}\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport function createAdministration(options?: IObserverOptions): ObserverAdministration {\n const adm: ObserverAdministration = {\n tracker: null,\n onStoreChange: null,\n stateVersion: Symbol(),\n subscribe(onStoreChange) {\n // 正常挂载后取消 GC 兜底,改由 effect 清理负责\n trackerRegistry.unregister(adm)\n adm.onStoreChange = onStoreChange\n if (!adm.tracker) {\n // StrictMode 重挂载(中间不会重新渲染)或追踪器已被回收时,重建并刷新快照\n adm.tracker = createTracker(adm, options)\n adm.stateVersion = Symbol()\n }\n return () => {\n adm.onStoreChange = null\n adm.tracker?.dispose()\n adm.tracker = null\n }\n },\n getSnapshot() {\n return adm.stateVersion\n },\n }\n return adm\n}\n\n/**\n * 在渲染期执行 view 并追踪其中读取的响应式数据,\n * 依赖变化时自动调度组件重渲染;每次渲染都会重新 track 以拿到最新 props 与依赖。\n */\nexport function useObserver<T>(view: () => T, options?: IObserverOptions): T {\n const admRef = useRef<ObserverAdministration | null>(null)\n if (!admRef.current) {\n admRef.current = createAdministration(options)\n }\n const adm = admRef.current\n if (!adm.tracker) {\n adm.tracker = createTracker(adm, options)\n // 渲染可能被 StrictMode/Concurrent 放弃而永不挂载,注册 GC 兜底回收\n trackerRegistry.register(admRef, () => adm.tracker?.dispose(), adm)\n }\n useSyncExternalStore(adm.subscribe, adm.getSnapshot, adm.getSnapshot)\n return adm.tracker.track(view)\n}\n","import hoistNonReactStatics from 'hoist-non-react-statics'\nimport { createElement, forwardRef, memo, Fragment } from 'react'\nimport type React from 'react'\n\nimport { useObserver } from './hooks/useObserver'\nimport type { IObserverOptions, IObserverProps, ReactFC } from './types'\n\n/** observer 包裹后的组件类型:按 forwardRef 选项决定是否携带 ref */\ntype ObserverComponent<P, Options extends IObserverOptions> = React.MemoExoticComponent<\n ReactFC<\n Options extends { forwardRef: true }\n ? P & {\n ref?: 'ref' extends keyof P ? P['ref'] : React.RefAttributes<unknown>\n }\n : React.PropsWithoutRef<P>\n >\n>\n\nexport function observer<P, Options extends IObserverOptions = IObserverOptions>(\n component: ReactFC<P>,\n options?: Options\n): ObserverComponent<P, Options> {\n const realOptions: IObserverOptions = {\n forwardRef: false,\n ...options,\n }\n\n const wrappedComponent = realOptions.forwardRef\n ? forwardRef(\n // React 19 的 FC 返回类型含 Promise<ReactNode>,forwardRef 渲染函数不接受,此处为同步 observer 场景收窄\n ((props: any, ref: any) => {\n return useObserver(() => component({ ...props, ref }), realOptions)\n }) as React.ForwardRefRenderFunction<any, any>\n )\n : (props: any) => {\n return useObserver(() => component(props), realOptions)\n }\n\n const memoComponent = memo(wrappedComponent)\n\n hoistNonReactStatics(memoComponent, component)\n\n if (realOptions.displayName) {\n memoComponent.displayName = realOptions.displayName\n }\n\n // wrappedComponent 是 forwardRef/普通函数两种形态的联合,按 options 条件类型收窄到声明签名\n return memoComponent as ObserverComponent<P, Options>\n}\n\nexport const Observer = observer((props: IObserverProps) => {\n const children = typeof props.children === 'function' ? props.children() : props.children\n return createElement(Fragment, null, children)\n})\n","import { useReducer } from 'react'\n\n/** 返回一个稳定的强制刷新函数,React 18+ 自动批处理会合并同一轮多次调用 */\nexport function useForceUpdate(): () => void {\n const [, forceUpdate] = useReducer((tick: number) => tick + 1, 0)\n return forceUpdate\n}\n"],"mappings":";;;;AAEA,IAAM,iBAAiB;;;;;;AAOvB,IAAM,kBAAN,MAAsB;CACpB;CACA,yBAAiB,IAAI,IAA2C;CAEhE,cAAc;EACZ,IAAI,OAAO,yBAAyB,aAClC,KAAK,SAAS,IAAI,sBAA8B,YAAW,QAAQ,CAAC;CAExE;;CAGA,SAAS,QAAgB,SAAkB,OAAqB;EAC9D,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,QAAQ;GACf,KAAK,OAAO,SAAS,QAAQ,SAAS,KAAK;GAC3C;EACF;EACA,KAAK,OAAO,IACV,OACA,iBAAiB;GACf,KAAK,OAAO,OAAO,KAAK;GACxB,QAAQ;EACV,GAAG,cAAc,CACnB;CACF;CAEA,WAAW,OAAqB;EAC9B,KAAK,QAAQ,WAAW,KAAK;EAC7B,MAAM,QAAQ,KAAK,OAAO,IAAI,KAAK;EACnC,IAAI,OAAO;GACT,aAAa,KAAK;GAClB,KAAK,OAAO,OAAO,KAAK;EAC1B;CACF;AACF;AAEA,IAAa,kBAAkB,IAAI,gBAAgB;;;AC5BnD,SAAgB,cAAc,KAA6B,SAAqC;CAC9F,OAAO,IAAI,cAAc;EACvB,IAAI,eAAe,OAAO;EAE1B,IAAI,IAAI,eAAe;GACrB,IAAI,OAAO,SAAS,cAAc,YAChC,QAAQ,UAAU,IAAI,aAAa;QAEnC,IAAI,cAAc;EAEtB;CACF,CAAC;AACH;;AAGA,SAAgB,qBAAqB,SAAoD;CACvF,MAAM,MAA8B;EAClC,SAAS;EACT,eAAe;EACf,cAAc,OAAO;EACrB,UAAU,eAAe;GAEvB,gBAAgB,WAAW,GAAG;GAC9B,IAAI,gBAAgB;GACpB,IAAI,CAAC,IAAI,SAAS;IAEhB,IAAI,UAAU,cAAc,KAAK,OAAO;IACxC,IAAI,eAAe,OAAO;GAC5B;GACA,aAAa;IACX,IAAI,gBAAgB;IACpB,IAAI,SAAS,QAAQ;IACrB,IAAI,UAAU;GAChB;EACF;EACA,cAAc;GACZ,OAAO,IAAI;EACb;CACF;CACA,OAAO;AACT;;;;;AAMA,SAAgB,YAAe,MAAe,SAA+B;CAC3E,MAAM,SAAS,OAAsC,IAAI;CACzD,IAAI,CAAC,OAAO,SACV,OAAO,UAAU,qBAAqB,OAAO;CAE/C,MAAM,MAAM,OAAO;CACnB,IAAI,CAAC,IAAI,SAAS;EAChB,IAAI,UAAU,cAAc,KAAK,OAAO;EAExC,gBAAgB,SAAS,cAAc,IAAI,SAAS,QAAQ,GAAG,GAAG;CACpE;CACA,qBAAqB,IAAI,WAAW,IAAI,aAAa,IAAI,WAAW;CACpE,OAAO,IAAI,QAAQ,MAAM,IAAI;AAC/B;;AC1DA,SAAgB,SACd,WACA,SAC+B;CAC/B,MAAM,cAAgC;EACpC,YAAY;EACZ,GAAG;CACL;CAEA,MAAM,mBAAmB,YAAY,aACjC,aAEI,OAAY,QAAa;EACzB,OAAO,kBAAkB,UAAU;GAAE,GAAG;GAAO;EAAI,CAAC,GAAG,WAAW;CACpE,EACF,KACC,UAAe;EACd,OAAO,kBAAkB,UAAU,KAAK,GAAG,WAAW;CACxD;CAEJ,MAAM,gBAAgB,KAAK,gBAAgB;CAE3C,qBAAqB,eAAe,SAAS;CAE7C,IAAI,YAAY,aACd,cAAc,cAAc,YAAY;CAI1C,OAAO;AACT;AAEA,IAAa,WAAW,UAAU,UAA0B;CAC1D,MAAM,WAAW,OAAO,MAAM,aAAa,aAAa,MAAM,SAAS,IAAI,MAAM;CACjF,OAAO,cAAc,UAAU,MAAM,QAAQ;AAC/C,CAAC;;;AClDD,SAAgB,iBAA6B;CAC3C,MAAM,GAAG,eAAe,YAAY,SAAiB,OAAO,GAAG,CAAC;CAChE,OAAO;AACT"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../src/hooks/trackerRegistry.ts","../src/hooks/useObserver.ts","../src/observer.tsx","../src/hooks/useForceUpdate.ts"],"sourcesContent":["import type { Dispose } from '@formvk/reactive'\n\nconst FALLBACK_DELAY = 10000\n\n/**\n * 渲染期创建的 Tracker 在组件被放弃挂载(StrictMode/Concurrent 中断)时\n * 等不到 effect 清理,需要垃圾回收兜底:原生 FinalizationRegistry 可用时用它,\n * 否则退化为定时器,避免响应式订阅泄漏。\n */\nclass TrackerRegistry {\n private native: FinalizationRegistry<Dispose> | undefined\n private timers = new Map<object, ReturnType<typeof setTimeout>>()\n\n constructor() {\n if (typeof FinalizationRegistry !== 'undefined') {\n this.native = new FinalizationRegistry<Dispose>(dispose => dispose())\n }\n }\n\n /** target 被 GC 时执行 dispose;token 用于后续 unregister */\n register(target: object, dispose: Dispose, token: object): void {\n this.unregister(token)\n if (this.native) {\n this.native.register(target, dispose, token)\n return\n }\n this.timers.set(\n token,\n setTimeout(() => {\n this.timers.delete(token)\n dispose()\n }, FALLBACK_DELAY)\n )\n }\n\n unregister(token: object): void {\n this.native?.unregister(token)\n const timer = this.timers.get(token)\n if (timer) {\n clearTimeout(timer)\n this.timers.delete(token)\n }\n }\n}\n\nexport const trackerRegistry = new TrackerRegistry()\n","import { Tracker } from '@formvk/reactive'\nimport { useRef, useSyncExternalStore } from 'react'\n\nimport type { IObserverOptions } from '../types'\nimport { trackerRegistry } from './trackerRegistry'\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport interface ObserverAdministration {\n tracker: Tracker | null\n onStoreChange: (() => void) | null\n /** 快照值:每次响应式变更都换成新 Symbol,驱动 useSyncExternalStore 重渲染 */\n stateVersion: symbol\n subscribe: (onStoreChange: () => void) => () => void\n getSnapshot: () => symbol\n}\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport function createTracker(adm: ObserverAdministration, options?: IObserverOptions): Tracker {\n return new Tracker(() => {\n adm.stateVersion = Symbol()\n // 首次渲染到挂载之间 onStoreChange 还不存在,useSyncExternalStore 会靠快照版本补刷新\n if (adm.onStoreChange) {\n if (typeof options?.scheduler === 'function') {\n options.scheduler(adm.onStoreChange)\n } else {\n adm.onStoreChange()\n }\n }\n })\n}\n\n/** @internal 仅供单元测试验证订阅状态机,不通过包入口公开 */\nexport function createAdministration(options?: IObserverOptions): ObserverAdministration {\n const adm: ObserverAdministration = {\n tracker: null,\n onStoreChange: null,\n stateVersion: Symbol(),\n subscribe(onStoreChange) {\n // 正常挂载后取消 GC 兜底,改由 effect 清理负责\n trackerRegistry.unregister(adm)\n adm.onStoreChange = onStoreChange\n if (!adm.tracker) {\n // StrictMode 重挂载(中间不会重新渲染)或追踪器已被回收时,重建并刷新快照\n adm.tracker = createTracker(adm, options)\n adm.stateVersion = Symbol()\n }\n return () => {\n adm.onStoreChange = null\n adm.tracker?.dispose()\n adm.tracker = null\n }\n },\n getSnapshot() {\n return adm.stateVersion\n },\n }\n return adm\n}\n\n/**\n * 在渲染期执行 view 并追踪其中读取的响应式数据,\n * 依赖变化时自动调度组件重渲染;每次渲染都会重新 track 以拿到最新 props 与依赖。\n */\nexport function useObserver<T>(view: () => T, options?: IObserverOptions): T {\n const admRef = useRef<ObserverAdministration | null>(null)\n if (!admRef.current) {\n admRef.current = createAdministration(options)\n }\n const adm = admRef.current\n if (!adm.tracker) {\n adm.tracker = createTracker(adm, options)\n // 渲染可能被 StrictMode/Concurrent 放弃而永不挂载,注册 GC 兜底回收\n trackerRegistry.register(admRef, () => adm.tracker?.dispose(), adm)\n }\n useSyncExternalStore(adm.subscribe, adm.getSnapshot, adm.getSnapshot)\n return adm.tracker.track(view)\n}\n","import hoistNonReactStatics from 'hoist-non-react-statics'\nimport { createElement, forwardRef, memo, Fragment } from 'react'\nimport type { ForwardRefRenderFunction, MemoExoticComponent, PropsWithoutRef, RefAttributes } from 'react'\n\nimport { useObserver } from './hooks/useObserver'\nimport type { IObserverOptions, IObserverProps, ReactFC } from './types'\n\n/** observer 包裹后的组件类型:按 forwardRef 选项决定是否携带 ref */\ntype ObserverComponent<P, Options extends IObserverOptions> = MemoExoticComponent<\n ReactFC<\n Options extends { forwardRef: true }\n ? P & {\n ref?: 'ref' extends keyof P ? P['ref'] : RefAttributes<unknown>\n }\n : PropsWithoutRef<P>\n >\n>\n\nexport function observer<P, Options extends IObserverOptions = IObserverOptions>(\n component: ReactFC<P>,\n options?: Options\n): ObserverComponent<P, Options> {\n const realOptions: IObserverOptions = {\n forwardRef: false,\n ...options,\n }\n\n const wrappedComponent = realOptions.forwardRef\n ? forwardRef(\n // React 19 的 FC 返回类型含 Promise<ReactNode>,forwardRef 渲染函数不接受,此处为同步 observer 场景收窄\n ((props: any, ref: any) => {\n return useObserver(() => component({ ...props, ref }), realOptions)\n }) as ForwardRefRenderFunction<any, any>\n )\n : (props: any) => {\n return useObserver(() => component(props), realOptions)\n }\n\n const memoComponent = memo(wrappedComponent)\n\n hoistNonReactStatics(memoComponent, component)\n\n if (realOptions.displayName) {\n memoComponent.displayName = realOptions.displayName\n }\n\n // wrappedComponent 是 forwardRef/普通函数两种形态的联合,按 options 条件类型收窄到声明签名\n return memoComponent as ObserverComponent<P, Options>\n}\n\nexport const Observer = observer((props: IObserverProps) => {\n const children = typeof props.children === 'function' ? props.children() : props.children\n return createElement(Fragment, null, children)\n})\n","import { useReducer } from 'react'\n\n/** 返回一个稳定的强制刷新函数,React 18+ 自动批处理会合并同一轮多次调用 */\nexport function useForceUpdate(): () => void {\n const [, forceUpdate] = useReducer((tick: number) => tick + 1, 0)\n return forceUpdate\n}\n"],"mappings":";;;;AAEA,IAAM,iBAAiB;;;;;;AAOvB,IAAM,kBAAN,MAAsB;CACpB;CACA,yBAAiB,IAAI,IAA2C;CAEhE,cAAc;EACZ,IAAI,OAAO,yBAAyB,aAClC,KAAK,SAAS,IAAI,sBAA8B,YAAW,QAAQ,CAAC;CAExE;;CAGA,SAAS,QAAgB,SAAkB,OAAqB;EAC9D,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,QAAQ;GACf,KAAK,OAAO,SAAS,QAAQ,SAAS,KAAK;GAC3C;EACF;EACA,KAAK,OAAO,IACV,OACA,iBAAiB;GACf,KAAK,OAAO,OAAO,KAAK;GACxB,QAAQ;EACV,GAAG,cAAc,CACnB;CACF;CAEA,WAAW,OAAqB;EAC9B,KAAK,QAAQ,WAAW,KAAK;EAC7B,MAAM,QAAQ,KAAK,OAAO,IAAI,KAAK;EACnC,IAAI,OAAO;GACT,aAAa,KAAK;GAClB,KAAK,OAAO,OAAO,KAAK;EAC1B;CACF;AACF;AAEA,IAAa,kBAAkB,IAAI,gBAAgB;;;AC5BnD,SAAgB,cAAc,KAA6B,SAAqC;CAC9F,OAAO,IAAI,cAAc;EACvB,IAAI,eAAe,OAAO;EAE1B,IAAI,IAAI,eAAe;GACrB,IAAI,OAAO,SAAS,cAAc,YAChC,QAAQ,UAAU,IAAI,aAAa;QAEnC,IAAI,cAAc;EAEtB;CACF,CAAC;AACH;;AAGA,SAAgB,qBAAqB,SAAoD;CACvF,MAAM,MAA8B;EAClC,SAAS;EACT,eAAe;EACf,cAAc,OAAO;EACrB,UAAU,eAAe;GAEvB,gBAAgB,WAAW,GAAG;GAC9B,IAAI,gBAAgB;GACpB,IAAI,CAAC,IAAI,SAAS;IAEhB,IAAI,UAAU,cAAc,KAAK,OAAO;IACxC,IAAI,eAAe,OAAO;GAC5B;GACA,aAAa;IACX,IAAI,gBAAgB;IACpB,IAAI,SAAS,QAAQ;IACrB,IAAI,UAAU;GAChB;EACF;EACA,cAAc;GACZ,OAAO,IAAI;EACb;CACF;CACA,OAAO;AACT;;;;;AAMA,SAAgB,YAAe,MAAe,SAA+B;CAC3E,MAAM,SAAS,OAAsC,IAAI;CACzD,IAAI,CAAC,OAAO,SACV,OAAO,UAAU,qBAAqB,OAAO;CAE/C,MAAM,MAAM,OAAO;CACnB,IAAI,CAAC,IAAI,SAAS;EAChB,IAAI,UAAU,cAAc,KAAK,OAAO;EAExC,gBAAgB,SAAS,cAAc,IAAI,SAAS,QAAQ,GAAG,GAAG;CACpE;CACA,qBAAqB,IAAI,WAAW,IAAI,aAAa,IAAI,WAAW;CACpE,OAAO,IAAI,QAAQ,MAAM,IAAI;AAC/B;;AC1DA,SAAgB,SACd,WACA,SAC+B;CAC/B,MAAM,cAAgC;EACpC,YAAY;EACZ,GAAG;CACL;CAEA,MAAM,mBAAmB,YAAY,aACjC,aAEI,OAAY,QAAa;EACzB,OAAO,kBAAkB,UAAU;GAAE,GAAG;GAAO;EAAI,CAAC,GAAG,WAAW;CACpE,EACF,KACC,UAAe;EACd,OAAO,kBAAkB,UAAU,KAAK,GAAG,WAAW;CACxD;CAEJ,MAAM,gBAAgB,KAAK,gBAAgB;CAE3C,qBAAqB,eAAe,SAAS;CAE7C,IAAI,YAAY,aACd,cAAc,cAAc,YAAY;CAI1C,OAAO;AACT;AAEA,IAAa,WAAW,UAAU,UAA0B;CAC1D,MAAM,WAAW,OAAO,MAAM,aAAa,aAAa,MAAM,SAAS,IAAI,MAAM;CACjF,OAAO,cAAc,UAAU,MAAM,QAAQ;AAC/C,CAAC;;;AClDD,SAAgB,iBAA6B;CAC3C,MAAM,GAAG,eAAe,YAAY,SAAiB,OAAO,GAAG,CAAC;CAChE,OAAO;AACT"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@formvk/reactive-react",
3
- "version": "1.1.1",
3
+ "version": "1.2.0-beta.1",
4
4
  "description": "Formvk Reactive React Bindings",
5
5
  "keywords": [
6
6
  "form",
@@ -20,7 +20,7 @@
20
20
  "module": "dist/index.js",
21
21
  "types": "dist/index.d.ts",
22
22
  "dependencies": {
23
- "@formvk/reactive": "~1.1.1",
23
+ "@formvk/reactive": "~1.2.0-beta.1",
24
24
  "hoist-non-react-statics": "^3.3.2"
25
25
  },
26
26
  "devDependencies": {
package/README.zh-CN.md DELETED
@@ -1,56 +0,0 @@
1
- # @formvk/reactive-react
2
-
3
- [English](./README.md) | [简体中文](./README.zh-CN.md)
4
-
5
- `@formvk/reactive` 的 React 绑定。用 `observer` 包裹组件后,组件在渲染期间读取的可观察数据发生变化时会自动重新渲染。
6
-
7
- ## 安装
8
-
9
- ```bash
10
- pnpm add @formvk/reactive-react
11
- ```
12
-
13
- `react` 与 `react-dom`(`>= 18`)是 peer 依赖。
14
-
15
- ## 使用
16
-
17
- ```tsx
18
- import { observable } from '@formvk/reactive'
19
- import { observer } from '@formvk/reactive-react'
20
-
21
- const state = observable({ count: 0 })
22
-
23
- export const Counter = observer(() => <button onClick={() => (state.count += 1)}>count: {state.count}</button>)
24
- ```
25
-
26
- 用于局部订阅的 render-prop 形式:
27
-
28
- ```tsx
29
- import { Observer } from '@formvk/reactive-react'
30
-
31
- function Count() {
32
- return <Observer>{() => <span>{state.count}</span>}</Observer>
33
- }
34
- ```
35
-
36
- `observer` 支持 `{ forwardRef, displayName, scheduler }` 选项:
37
-
38
- ```tsx
39
- const Input = observer(MyInput, { forwardRef: true, displayName: 'Input' })
40
- ```
41
-
42
- ## API
43
-
44
- - `observer(Component, options?)` — 带缓存的包装器,追踪可观察读取并触发重渲染。
45
- - `Observer` — 以 render prop 作为 `children` 的组件。
46
- - `useObserver(view, options?)` — 在 observer 的追踪上下文中执行渲染函数。
47
- - `useForceUpdate()` — 强制重新渲染。
48
- - 类型 — `IObserverOptions`、`IObserverProps`、`ReactFC`。
49
-
50
- ## 文档
51
-
52
- https://formvk.github.io/core/zh/api/react
53
-
54
- ## License
55
-
56
- MIT