@yorkie-js/react 0.7.6 → 0.7.8

package/README.md

@@ -8,7 +8,7 @@ To get started using Yorkie React SDK, see: https://yorkie.dev/docs/getting-star
 
 ## Contributing
 
-See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
+See [CONTRIBUTING](../../CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
 
 ## Contributors ✨
 

package/dist/yorkie-js-react.d.ts

@@ -10,6 +10,7 @@ import { Presence } from '@yorkie-js/sdk';
 import { PropsWithChildren } from 'react';
 import { RevisionSummary } from '@yorkie-js/sdk';
 import { StreamConnectionStatus } from '@yorkie-js/sdk';
+import { SyncMode } from '@yorkie-js/sdk';
 import { Text as Text_2 } from '@yorkie-js/sdk';
 import { Tree } from '@yorkie-js/sdk';
 
@@ -19,12 +20,17 @@ import { Tree } from '@yorkie-js/sdk';
  *
  * @example
  * ```tsx
+ * import { ChannelProvider, SyncMode } from '@yorkie-js/react';
+ *
  * <YorkieProvider apiKey="..." rpcAddr="...">
- *   <ChannelProvider channelKey="room-123" isRealtime={true}>
+ *   <ChannelProvider channelKey="room-123" syncMode={SyncMode.Realtime}>
  *     <ChatRoom />
  *   </ChannelProvider>
  * </YorkieProvider>
  * ```
+ *
+ * The boolean `isRealtime` prop is also accepted as a shortcut for
+ * the Realtime/Manual choice (`true` → Realtime, `false` → Manual).
  */
 export declare const ChannelProvider: React.FC<ChannelProviderProps>;
 
@@ -37,10 +43,24 @@ declare type ChannelProviderProps = PropsWithChildren<{
      */
     channelKey: string;
     /**
-     * `isRealtime` determines the synchronization mode.
-     * - true: Realtime mode (automatic updates via watch stream)
-     * - false: Manual mode (requires manual sync)
-     * @default true
+     * `syncMode` selects how the channel keeps presence in sync with the server.
+     * - `SyncMode.Realtime` (default): open a watch stream and run the
+     *   heartbeat. Required to receive broadcast events.
+     * - `SyncMode.Polling`: heartbeat-only. No watch stream is opened.
+     *   Recommended for large channels where broadcast is not needed.
+     * - `SyncMode.Manual`: no automatic activity.
+     *
+     * If `isRealtime` is also set, `syncMode` wins.
+     */
+    syncMode?: SyncMode;
+    /**
+     * `isRealtime` is a convenience prop covering only Realtime/Manual.
+     * - `true`: equivalent to `syncMode={SyncMode.Realtime}`.
+     * - `false`: equivalent to `syncMode={SyncMode.Manual}`.
+     *
+     * Use `syncMode` directly when you want `SyncMode.Polling`, which this
+     * boolean prop cannot express. When neither prop is set, the channel
+     * falls back to `SyncMode.Realtime`.
      */
     isRealtime?: boolean;
 }>;
@@ -92,6 +112,8 @@ export { RevisionSummary }
  */
 export declare function shallowEqual<T>(valueA: T, valueB: T): boolean;
 
+export { SyncMode }
+
 export { Text_2 as Text }
 
 export { Tree }