@workday/canvas-kit-docs 7.0.0-alpha.96-next.22 → 7.0.0-alpha.97-next.23

package/dist/mdx/7.0-MIGRATION-GUIDE.mdx

@@ -785,6 +785,65 @@ anyway since the buttons will no longer scroll with overflowed `Body` content.
 </Modal.Card>
 ```
 
+#### Popup Model
+
+In addition to the other [Model Changes](#model-changes), the `show` and `hide` events of all
+disclosure-type models have been updated to remove the extra event wrapper. This change allows
+developers to directly attach the `show` and `hide` events to React event handlers.
+
+The following models were affected:
+
+- `useDisclosureModel`
+- `usePopupModel`
+- `useModalModel`
+- `useDisclosureModel`
+
+```tsx
+// v6
+<button onClick={() => model.events.show()} /> // most use-cases look like this
+<button onClick={event => model.events.show({event})} />
+
+// v7
+<button onClick={model.events.show} />
+```
+
+Removing the object wrapper around the `event` allows us to directly pass the `show` or `hide` event
+to the `onClick` handler which is much more convenient. We couldn't find many uses of the `event` in
+the wild, so the impact will be minimal. Most usage of `show` or `hide` events are called without
+`event`, so this change will not impact most people. There is **no** codemod for this change,
+because the usage is very difficult to detect since most people pass a callback that doesn't take
+parameters.
+
+Guards and callback signatures have also changed to remove the object wrapper around the `event`.
+The following v6 example includes the [Model Changes](#model-changes) which this change compounds
+upon.
+
+```tsx
+// v6
+const model = usePopupModel({
+  shouldShow({data: {event}, state}) {
+    console.log(event, state);
+  },
+  onShow({data: {event}, prevState}) {
+    console.log(event, prevState);
+  },
+});
+
+// v7
+const model = usePopupModel({
+  shouldShow(event, state) {
+    console.log(event, state);
+  },
+  onShow(event, prevState) {
+    console.log(event, prevState);
+  },
+});
+```
+
+🤖 The codemod will update all inline guards and callbacks defined like they are in this example. If
+a guard or callback was defined outside the model config block, it will not be covered by the
+codemod.
+
 ---
 
 ### Segmented Control

package/dist/mdx/preview-react/_examples/examples/SelectWithFormik.tsx

@@ -7,7 +7,7 @@ import {
   useFormFieldModel,
 } from '@workday/canvas-kit-preview-react/form-field';
 
-export default () => {
+export const SelectWithFormik = () => {
   const formik = useFormik({
     initialValues: {
       selectedBook: '',

package/dist/mdx/preview-react/menu/examples/ContextMenu.tsx

@@ -19,9 +19,9 @@ const ContextMenuTarget = createComponent('div')({
 
     const onContextMenu = (event: React.MouseEvent) => {
       if (model.state.visibility === 'visible') {
-        model.events.hide({event});
+        model.events.hide(event);
       } else if (model.state.visibility === 'hidden') {
-        model.events.show({event});
+        model.events.show(event);
       }
 
       // Prevent the default context menu from showing to avoid double menus

package/dist/mdx/react/_examples/examples/CookieBanner.tsx

@@ -17,7 +17,7 @@ const CookieBanner = createComponent('div')({
   subComponents: {Item: CookieBannerItem},
 });
 
-export default () => {
+export const Basic = () => {
   const DefaultNotice = `We use cookies to ensure that we give you the best experience on our website. 
     If you continue without changing your settings, we'll assume that you are willing to receive cookies.`;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "7.0.0-alpha.96-next.22+29ac2599",
+  "version": "7.0.0-alpha.97-next.23+36224fdd",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -41,7 +41,7 @@
   ],
   "dependencies": {
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-react": "^7.0.0-alpha.96-next.22+29ac2599"
+    "@workday/canvas-kit-react": "^7.0.0-alpha.97-next.23+36224fdd"
   },
   "devDependencies": {
     "fs-extra": "^10.0.0",
@@ -49,5 +49,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.1"
   },
-  "gitHead": "29ac25992f1ca92c4cc885813c271120511038b5"
+  "gitHead": "36224fddf0e1c2382b1cbbeb1a2a2d356bfd22a3"
 }