@yorkie-js/react 0.6.0 → 0.6.1-rc1

package/README.md

@@ -0,0 +1,19 @@
+# Yorkie React SDK
+
+Yorkie React SDK is a library that provides React hooks and components for building collaborative applications with Yorkie.
+
+## How to use React SDK
+
+To get started using Yorkie React SDK, see: https://yorkie.dev/docs/getting-started/with-react
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
+
+## Contributors ✨
+
+Thanks goes to these incredible people:
+
+<a href="https://github.com/yorkie-team/yorkie-js-sdk/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=yorkie-team/yorkie-js-sdk" />
+</a>

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

@@ -0,0 +1,84 @@
+import { Indexable } from '@yorkie-js/sdk';
+import { JSONArray } from '@yorkie-js/sdk';
+import { JSONObject } from '@yorkie-js/sdk';
+import { JSX } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+/**
+ * `DocumentProvider` is a component that provides a document to its children.
+ * This component must be under a `YorkieProvider` component to initialize the
+ * Yorkie client properly.
+ */
+export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ docKey, initialRoot, children, }: {
+    docKey: string;
+    initialRoot: R;
+    children: React.ReactNode;
+}) => JSX.Element;
+
+export { JSONArray }
+
+export { JSONObject }
+
+/**
+ * `useDocument` is a custom hook that returns the root object and update function of the document.
+ * This hook must be used within a `DocumentProvider`.
+ */
+export declare const useDocument: <R, P extends Indexable = Indexable>() => {
+    root: R;
+    presences: {
+        clientID: string;
+        presence: P;
+    }[];
+    update: (callback: (root: R, presence: P) => void) => void;
+    loading: boolean;
+    error: Error | undefined;
+};
+
+/**
+ * `usePresences` is a custom hook that returns the presences of the document.
+ */
+export declare const usePresences: () => {
+    clientID: string;
+    presence: Indexable;
+}[];
+
+/**
+ * `useRoot` is a custom hook that returns the root object of the document.
+ * This hook must be used within a `DocumentProvider`.
+ */
+export declare const useRoot: () => {
+    root: any;
+};
+
+/**
+ * `useYorkieDoc` is a custom hook that initializes a Yorkie client and attaches a document.
+ *
+ * @param apiKey
+ * @param docKey
+ * @param initialRoot
+ * @returns
+ */
+export declare function useYorkieDoc<T>(apiKey: string, docKey: string, initialRoot: T, options?: {
+    rpcAddr?: string;
+}): {
+    root: T;
+    update: (callback: (root: T) => void) => void;
+    loading: boolean;
+    error: Error | undefined;
+};
+
+/**
+ * `YorkieProvider` is a component that provides the Yorkie client to its children.
+ * It initializes the Yorkie client with the given API key and RPC address.
+ */
+export declare const YorkieProvider: React.FC<PropsWithChildren<YorkieProviderProps>>;
+
+/**
+ * `YorkieProviderProps` is a set of properties for `YorkieProvider`.
+ */
+declare interface YorkieProviderProps {
+    apiKey: string;
+    rpcAddr?: string;
+}
+
+export { }