updated comment for allowSwipeInChildren

docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json

@@ -1,7 +1,7 @@
 {
   "componentDescription": "",
   "propDescriptions": {
-    "allowSwipeInChildren": "Callback to determine what children of the drawer the user can use to drag open the drawer. Can be a custom function to control the behavior. Set or return true / false to allow / disallow the swipe event.",
+    "allowSwipeInChildren": "If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children. This can be useful in scenarios where the drawer is partially visible. You can customize it further with a callback that determines which children the user can drag over to open the drawer (for example, to ignore other elements that handle touch move events, like sliders).",
     "children": "The content of the component.",
     "disableBackdropTransition": "Disable the backdrop transition. This can improve the FPS on low-end devices.",
     "disableDiscovery": "If <code>true</code>, touching the screen near the edge of the drawer will not slide in the drawer a bit to promote accidental discovery of the swipe gesture.",

packages/mui-material/src/SwipeableDrawer/SwipeableDrawer.d.ts

@@ -3,9 +3,10 @@ import { DrawerProps } from '../Drawer';
 
 export interface SwipeableDrawerProps extends Omit<DrawerProps, 'onClose' | 'open'> {
   /**
-   * Callback to determine what children of the drawer the user can use to drag open the drawer.
-   * Can be a custom function to control the behavior.
-   * Set or return true / false to allow / disallow the swipe event.
+   * If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children.
+   * This can be useful in scenarios where the drawer is partially visible.
+   * You can customize it further with a callback that determines which children the user can drag over to open the drawer
+   * (for example, to ignore other elements that handle touch move events, like sliders).
    *
    * @param {TouchEvent} event The 'touchstart' event
    * @param {HTMLDivElement} swipeArea The swipe area element

packages/mui-material/src/SwipeableDrawer/SwipeableDrawer.js

@@ -634,9 +634,10 @@ SwipeableDrawer.propTypes /* remove-proptypes */ = {
   // |     To update them edit the d.ts file and run "yarn proptypes"     |
   // ----------------------------------------------------------------------
   /**
-   * Callback to determine what children of the drawer the user can use to drag open the drawer.
-   * Can be a custom function to control the behavior.
-   * Set or return true / false to allow / disallow the swipe event.
+   * If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children.
+   * This can be useful in scenarios where the drawer is partially visible.
+   * You can customize it further with a callback that determines which children the user can drag over to open the drawer
+   * (for example, to ignore other elements that handle touch move events, like sliders).
    *
    * @param {TouchEvent} event The 'touchstart' event
    * @param {HTMLDivElement} swipeArea The swipe area element