docs: added docs for backgroundComponent

gorhom · Aug 11, 2020 · 7edd480 · 7edd480
1 parent 9a65a74
commit 7edd480
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -142,6 +142,12 @@ Component to be placed as a sheet handle.
 
 > `required:` NO | `type:` React.FC<[BottomSheetHandleProps](./src/components/handle/types.d.ts)>
 
+#### `backgroundComponent`
+
+Component to be placed as a background.
+
+> `required:` NO | `type:` React.FC<ViewProps>
+
 #### `onChange`
 
 Callback when sheet position changed to a provided point.

diff --git a/src/components/bottomSheet/types.d.ts b/src/components/bottomSheet/types.d.ts
@@ -41,7 +41,7 @@ export interface BottomSheetProps extends BottomSheetAnimationConfigs {
   handleComponent?: React.FC<BottomSheetHandleProps>;
   /**
    * Component to be placed as a background.
-   * @type React.FC
+   * @type React.FC\<ViewProps\>
    */
   backgroundComponent?: React.FC<ViewProps>;
   /**