sidebar doc updates

api-generator/components/sidebar.js

@@ -46,6 +46,12 @@ const SidebarProps = [
         type: 'string',
         default: 'close',
         description: 'Aria label of the close icon.'
+    },
+    {
+        name: 'blockScroll',
+        type: 'boolean',
+        default: 'false',
+        description: 'Whether background scroll should be blocked when sidebar is visible.'
     }
 ];
 

components/sidebar/Sidebar.d.ts

@@ -44,6 +44,10 @@ export interface SidebarProps {
      * Default value is true.
      */
     modal?: boolean | undefined;
+    /**
+     * Whether background scroll should be blocked when sidebar is visible.
+     */
+    blockScroll?: boolean | undefined;
 }
 
 export interface SidebarSlots {

components/sidebar/Sidebar.spec.js

@@ -70,14 +70,6 @@ describe('Sidebar.vue', () => {
         expect(bindOutsideClickListenerSpy).toHaveBeenCalled();
     });
 
-    /* it('When transition trigger to onAfterLeave, bindOutsideClickListener should be triggered', async () => {
-        const bindOutsideClickListenerSpy = vi.spyOn(wrapper.vm, 'bindOutsideClickListener');
-
-        await wrapper.vm.onAfterLeave();
-
-        expect(bindOutsideClickListenerSpy).toHaveBeenCalled();
-    }); */
-
     it('When keydown is triggered , hide method should be triggered', async () => {
         const hideSpy = vi.spyOn(wrapper.vm, 'hide');
 

components/sidebar/Sidebar.vue

@@ -67,7 +67,6 @@ export default {
             default: true
         }
     },
-    maskClickListener: null,
     container: null,
     content: null,
     headerContainer: null,

pages/sidebar/SidebarDoc.vue

@@ -121,6 +121,12 @@ import Sidebar from 'primevue/sidebar';
                             <b> Deprecated: </b> <i>aria.close</i> can be used in defaults to PrimeVue <router-link to="/locale">Locale</router-link> configuration.
                         </td>
                     </tr>
+                    <tr>
+                        <td>blockScroll</td>
+                        <td>boolean</td>
+                        <td>true</td>
+                        <td>Whether background scroll should be blocked when sidebar is visible.</td>
+                    </tr>
                 </tbody>
             </table>
         </div>