Document allowPinchZoom changes (#433)

benoitgrelard · andy-hook · commit 47d5bd4215b4 · 2022-07-18T15:37:48.000+01:00
* Document `allowPinchZoom` changes

* Feedback
diff --git a/data/primitives/components/alert-dialog/0.1.8.mdx b/data/primitives/components/alert-dialog/0.1.8.mdx
@@ -94,31 +94,6 @@ Contains all the parts of an alert dialog.
       description:
         'Event handler called when the open state of the dialog changes.',
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
     {
       name: 'id',
       type: 'string',
diff --git a/data/primitives/components/context-menu/0.1.7.mdx b/data/primitives/components/context-menu/0.1.7.mdx
@@ -130,31 +130,6 @@ Contains all the parts of a context menu.
         </span>
       ),
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
   ]}
 />
 
diff --git a/data/primitives/components/dialog/0.1.8.mdx b/data/primitives/components/dialog/0.1.8.mdx
@@ -114,31 +114,6 @@ Contains all the parts of a dialog.
         </span>
       ),
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
     {
       name: 'id',
       type: 'string',
diff --git a/data/primitives/components/dropdown-menu/0.1.7.mdx b/data/primitives/components/dropdown-menu/0.1.7.mdx
@@ -140,31 +140,6 @@ Contains all the parts of a dropdown menu.
         </span>
       ),
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
     {
       name: 'dir',
       required: false,
diff --git a/data/primitives/components/popover/0.1.7.mdx b/data/primitives/components/popover/0.1.7.mdx
@@ -110,31 +110,6 @@ Contains all the parts of a popover.
         </span>
       ),
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
   ]}
 />
 
diff --git a/data/primitives/components/select/0.1.2.mdx b/data/primitives/components/select/0.1.2.mdx
@@ -157,31 +157,6 @@ Contains all the parts of a select.
       description:
         'The name of the select. Submitted with its owning form as part of a name/value pair.',
     },
-    {
-      name: 'allowPinchZoom',
-      required: false,
-      type: 'boolean',
-      default: 'false',
-      description: (
-        <span>
-          The <Code>allowPinchZoom</Code> prop from{' '}
-          <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll"
-            target="_blank"
-          >
-            react-remove-scroll
-          </Link>
-          . See <Link
-            variant="blue"
-            href="https://github.com/theKashey/react-remove-scroll#usage"
-            target="_blank"
-          >
-            their docs
-          </Link> for information on functionality and limitations.
-        </span>
-      ),
-    },
   ]}
 />
 
diff --git a/data/primitives/overview/releases.mdx b/data/primitives/overview/releases.mdx
@@ -18,26 +18,28 @@ metaDescription: Radix Primitives releases and their changelogs.
 
 - Improve compatibility with JS animation libraries with `forceMount` on `AlertDialog.Portal` <PRLink id={1075} />
 - Fix regressions with page interactivity while/after closing dialog <PRLink id={1401} />
+- [**Breaking**] Remove `allowPinchZoom` prop, now defaults to `true` <PRLink id={1514} />
 
 <PackageRelease name="Context Menu" version="0.1.7" />
 
 - Fix issue with native context menu appearing in React 18 <PRLink id={1378} />
 - Add `data-highlighted` attribute to support styling <PRLink id={1388} />
 - [**Breaking**] Improve indirect nesting of context menus. Submenus must now be created using explicit parts. <PRLink id={1394} />
-- [**Breaking**] Move `allowPinchZoom` to root. <PRLink id={1400} />
+- [**Breaking**] Remove `allowPinchZoom` prop, now defaults to `true` <PRLink id={1514} />
 - [**Breaking**] Add new `Portal` part. To avoid regressions, use this part if you want portalling behavior. Note that `z-index` isn't managed anymore so you have full control of layering. <PRLink id={1429} />
 - Add `data-state` attribute to `Trigger` part <PRLink id={1455} />
 
 <PackageRelease name="Dialog" version="0.1.8" />
 
 - Improve compatibility with JS animation libraries with `forceMount` on `Dialog.Portal` <PRLink id={1075} />
 - Fix regressions with page interactivity while/after closing dialog <PRLink id={1401} />
+- [**Breaking**] Remove `allowPinchZoom` prop, now defaults to `true` <PRLink id={1514} />
 
 <PackageRelease name="Dropdown Menu" version="0.1.7" />
 
 - Add `data-highlighted` attribute to support styling <PRLink id={1388} />
 - [**Breaking**] Improve indirect nesting of dropdown menus. Submenus must now be created using explicit parts. <PRLink id={1394} />
-- [**Breaking**] Move `allowPinchZoom` to root <PRLink id={1400} />
+- [**Breaking**] Remove `allowPinchZoom` prop, now defaults to `true` <PRLink id={1514} />
 - Prevent escape key from exiting fullscreen mode in Firefox & Safari <PRLink id={1423} />
 - [**Breaking**] Add new `Portal` part. To avoid regressions, use this part if you want portalling behavior. Note that `z-index` isn't managed anymore so you have full control of layering. <PRLink id={1429} />
 
@@ -52,7 +54,7 @@ metaDescription: Radix Primitives releases and their changelogs.
 
 <PackageRelease name="Popover" version="0.1.7" />
 
-- [**Breaking**] Move `allowPinchZoom` to root <PRLink id={1400} />
+- [**Breaking**] Remove `allowPinchZoom` prop, now defaults to `true` <PRLink id={1514} />
 - [**Breaking**] Add new `Portal` part. To avoid regressions, use this part if you want portalling behavior. Note that `z-index` isn't managed anymore so you have full control of layering. <PRLink id={1425} />
 
 <PackageRelease name="Portal" version="0.1.5" />
@@ -78,7 +80,6 @@ metaDescription: Radix Primitives releases and their changelogs.
 - Add support for placeholder via `placeholder` prop on `Select.Value` <PRLink id={1384} />
 - Resolve value mismatch with underlying native select <PRLink id={1421} />
 - [**Breaking**] Add new `Portal` part. To avoid regressions, use this part if you want portalling behavior. Note that `z-index` isn't managed anymore so you have full control of layering. <PRLink id={1459} />
-- Add pinch to zoom support via `allowPinchZoom` prop on `Select.Root` <PRLink id={1459} />
 
 <PackageRelease name="Slot" version="0.1.3" />
 
