fix: renamed refUploadCtxProvider to apiRef

uploadcare · Apr 29, 2024 · 4440e68 · 4440e68
1 parent 71de0ff
commit 4440e68
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/packages/react-uploader/README.md b/packages/react-uploader/README.md
@@ -103,8 +103,8 @@ import {FileUploaderRegular} from "@uploadcare/react-uploader";
 
 ## File Uploader API
 
-For convenience, we provide the ability to access the File Uploader API using `refUploadCtxProvider`.
-You can see what methods are available in `refUploadCtxProvider` in the [documentation][uc-docs-file-uploader-api].
+For convenience, we provide the ability to access the File Uploader API using `apiRef`.
+You can see what methods are available in `apiRef` in the [documentation][uc-docs-file-uploader-api].
 It is important to note that we now pass all InstanceType from UploadCtxProvider.
 
 ```jsx
@@ -118,7 +118,7 @@ const Example = () => {
     const uploaderRef = useRef < InstanceType < UploadCtxProvider > | null > (null);
 
 
-    <FileUploaderRegular refUploadCtxProvider={uploaderRef} pubkey="YOUR_PUBLIC_KEY"/>;
+    <FileUploaderRegular apiRef={uploaderRef} pubkey="YOUR_PUBLIC_KEY"/>;
 }
 ```
 

diff --git a/packages/react-uploader/src/Uploader/Inline/FileUploaderInline.tsx b/packages/react-uploader/src/Uploader/Inline/FileUploaderInline.tsx
@@ -20,7 +20,7 @@ const CSS_SRC_INLINE = getStyleSource("inline");
 export const FileUploaderInline: FC<TProps> = ({
   ctxName,
   className,
-  refUploadCtxProvider,
+  apiRef,
   ...props
 }) => {
   const CTX_NAME = useMemo(() => ctxName ?? LR.UID.generate(), [ctxName]);
@@ -36,7 +36,7 @@ export const FileUploaderInline: FC<TProps> = ({
       <AdapterConfig userAgentIntegration={getUserAgentIntegration()} ctx-name={CTX_NAME} {...config} />
       {/* @ts-ignore */}
       <AdapterUploadCtxProvider
-        ref={refUploadCtxProvider}
+        ref={apiRef}
         ctx-name={CTX_NAME}
         {...eventHandlers}
       />

diff --git a/packages/react-uploader/src/Uploader/Minimal/FileUploaderMinimal.tsx b/packages/react-uploader/src/Uploader/Minimal/FileUploaderMinimal.tsx
@@ -21,7 +21,7 @@ const CSS_SRC_MINIMAL = getStyleSource("minimal");
 export const FileUploaderMinimal: FC<TProps> = ({
   ctxName,
   className,
-  refUploadCtxProvider,
+  apiRef,
   ...props
 }) => {
   const CTX_NAME = useMemo(() => ctxName ?? LR.UID.generate(), [ctxName]);
@@ -37,7 +37,7 @@ export const FileUploaderMinimal: FC<TProps> = ({
       <AdapterConfig userAgentIntegration={getUserAgentIntegration()} ctx-name={CTX_NAME} {...config} />
       {/* @ts-ignore */}
       <AdapterUploadCtxProvider
-        ref={refUploadCtxProvider}
+        ref={apiRef}
         ctx-name={CTX_NAME}
         {...eventHandlers}
       />

diff --git a/packages/react-uploader/src/Uploader/Regular/FileUploaderRegular.tsx b/packages/react-uploader/src/Uploader/Regular/FileUploaderRegular.tsx
@@ -22,7 +22,7 @@ const CSS_SRC_REGULAR = getStyleSource("regular");
 export const FileUploaderRegular: FC<TProps> = ({
   ctxName,
   className,
-  refUploadCtxProvider,
+  apiRef,
   ...props
 }) => {
   const CTX_NAME = useMemo(() => ctxName ?? LR.UID.generate(), [ctxName]);
@@ -38,7 +38,7 @@ export const FileUploaderRegular: FC<TProps> = ({
       <AdapterConfig userAgentIntegration={getUserAgentIntegration()} ctx-name={CTX_NAME} {...config} />
       {/* @ts-ignore */}
       <AdapterUploadCtxProvider
-        ref={refUploadCtxProvider}
+        ref={apiRef}
         ctx-name={CTX_NAME}
         {...eventHandlers}
       />

diff --git a/packages/react-uploader/src/Uploader/types.ts b/packages/react-uploader/src/Uploader/types.ts
@@ -18,7 +18,7 @@ export type TEventsSchema = {
 };
 
 type TRefUploadCtxProvider = {
-  refUploadCtxProvider?: Ref<InstanceType<UploadCtxProvider>>;
+  apiRef?: Ref<InstanceType<UploadCtxProvider>>;
 };
 
 type TPropsWithEvents = Partial<TEventsSchema>;