fix: add needRemoveScroll prop

TiendaNube · Apr 15, 2024 · ed3b10b · ed3b10b
1 parent bf032f2
commit ed3b10b
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -7,6 +7,7 @@ Nimbus is an open-source Design System created by Tiendanube / Nuvesmhop’s tea
 ### 🐛 Bug fixes
 
 - Added `RemoveScroll` component from `react-remove-scroll` library to prevent scroll resetting on the body of the `Sidebar` component. ([#233](https://github.com/TiendaNube/nimbus-design-system/pull/233) by [@juanchigallego](https://github.com/juanchigallego))
+- Added `needRemoveScroll` optional prop to `Sidebar` component. ([#233](https://github.com/TiendaNube/nimbus-design-system/pull/233) by [@juanchigallego](https://github.com/juanchigallego))
 - Fixed type bug on expected icon and text color values on `Toast` component. ([#233](https://github.com/TiendaNube/nimbus-design-system/pull/233) by [@juanchigallego](https://github.com/juanchigallego))
 
 ### 📚 3rd party library updates

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nimbus-ds/components",
-  "version": "5.5.2-rc.3",
+  "version": "5.5.2-rc.7",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [

diff --git a/packages/react/src/composite/Sidebar/package.json b/packages/react/src/composite/Sidebar/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nimbus-ds/sidebar",
-  "version": "3.2.3-rc.5",
+  "version": "3.3.0-rc.2",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [

diff --git a/packages/react/src/composite/Sidebar/src/Sidebar.tsx b/packages/react/src/composite/Sidebar/src/Sidebar.tsx
@@ -19,6 +19,7 @@ const Sidebar: React.FC<SidebarProps> & SidebarComponents = ({
   position = "right",
   maxWidth = "375px",
   open = false,
+  needRemoveScroll = false,
   children,
   onRemove,
   ...rest
@@ -61,7 +62,11 @@ const Sidebar: React.FC<SidebarProps> & SidebarComponents = ({
               open && sidebar.classnames.isVisible,
             ].join(" ")}
           >
-            <RemoveScroll>{children}</RemoveScroll>
+            {needRemoveScroll ? (
+              <RemoveScroll>{children}</RemoveScroll>
+            ) : (
+              children
+            )}
           </div>
         </FloatingFocusManager>
       </FloatingOverlay>

diff --git a/packages/react/src/composite/Sidebar/src/sidebar.types.ts b/packages/react/src/composite/Sidebar/src/sidebar.types.ts
@@ -34,6 +34,11 @@ export interface SidebarProperties extends SidebarSprinkle {
    * @default true
    */
   open?: boolean;
+  /**
+   * Determines if RemoveScroll wraps sidebar's children component.
+   * @default true
+   */
+  needRemoveScroll?: boolean;
 }
 
 export type SidebarProps = SidebarProperties & HTMLAttributes<HTMLDivElement>;