@workday/canvas-kit-docs 8.6.10 → 8.6.12

package/dist/es6/lib/docs.js

@@ -108712,6 +108712,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/PopupPopper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "popperOptions",
@@ -108972,7 +108993,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -144111,6 +144132,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "onPlacementChange",
@@ -144212,7 +144254,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -173082,6 +173124,81 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "Placement",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "Placement",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "type",
+      "typeParameters": [],
+      "value": {
+        "kind": "symbol",
+        "name": "PopperJSPlacement",
+        "value": "Placement"
+      }
+    }
+  },
+  {
+    "name": "Options",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "Options",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "object",
+      "properties": [
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": true,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ]
+    }
+  },
+  {
+    "name": "fallbackPlacementsModifier",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "fallbackPlacementsModifier",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/fallbackPlacements.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "symbol",
+      "name": "name"
+    }
+  },
   {
     "name": "getTransformFromPlacement",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/getTransformFromPlacement.ts",
@@ -176246,69 +176363,9 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       "kind": "type",
       "typeParameters": [],
       "value": {
-        "kind": "union",
-        "value": [
-          {
-            "kind": "string",
-            "value": "auto"
-          },
-          {
-            "kind": "string",
-            "value": "left"
-          },
-          {
-            "kind": "string",
-            "value": "right"
-          },
-          {
-            "kind": "string",
-            "value": "top"
-          },
-          {
-            "kind": "string",
-            "value": "bottom"
-          },
-          {
-            "kind": "string",
-            "value": "auto-start"
-          },
-          {
-            "kind": "string",
-            "value": "auto-end"
-          },
-          {
-            "kind": "string",
-            "value": "top-start"
-          },
-          {
-            "kind": "string",
-            "value": "top-end"
-          },
-          {
-            "kind": "string",
-            "value": "bottom-start"
-          },
-          {
-            "kind": "string",
-            "value": "bottom-end"
-          },
-          {
-            "kind": "string",
-            "value": "right-start"
-          },
-          {
-            "kind": "string",
-            "value": "right-end"
-          },
-          {
-            "kind": "string",
-            "value": "left-start"
-          },
-          {
-            "kind": "string",
-            "value": "left-end"
-          }
-        ]
+        "kind": "symbol",
+        "name": "PopperJSPlacement",
+        "value": "Placement"
       }
     }
   },
@@ -176328,11 +176385,31 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       "typeParameters": [],
       "value": {
         "kind": "symbol",
-        "name": "PopperJS.Options",
+        "name": "Options",
         "value": "Options"
       }
     }
   },
+  {
+    "name": "defaultFallbackPlacements",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx",
+    "description": "",
+    "declarations": [
+      {
+        "name": "defaultFallbackPlacements",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "array",
+      "value": {
+        "kind": "symbol",
+        "name": "Placement",
+        "value": "Placement"
+      }
+    }
+  },
   {
     "name": "PopperProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx",
@@ -176547,6 +176624,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "onPlacementChange",
@@ -176648,7 +176746,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -178121,6 +178219,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/PopupPopper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "popperOptions",
@@ -178381,7 +178500,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -188329,6 +188448,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "default": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "onPlacementChange",
@@ -188426,7 +188566,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -188660,6 +188800,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "bottom"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "onPlacementChange",
@@ -188761,7 +188922,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "typeParameters": [
               {
                 "kind": "symbol",
-                "name": "PopperJS.Instance",
+                "name": "Instance",
                 "value": "Instance"
               }
             ]
@@ -223550,6 +223711,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "string",
             "value": "top"
           }
+        },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/OverflowTooltip.tsx"
+            }
+          ],
+          "tags": {}
         }
       ]
     }
@@ -223652,6 +223834,27 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "top"
           }
         },
+        {
+          "kind": "property",
+          "name": "fallbackPlacements",
+          "required": false,
+          "type": {
+            "kind": "array",
+            "value": {
+              "kind": "symbol",
+              "name": "Placement",
+              "value": "Placement"
+            }
+          },
+          "description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
+          "declarations": [
+            {
+              "name": "fallbackPlacements",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/Tooltip.tsx"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "type",

package/dist/es6/lib/specs.js

@@ -1215,6 +1215,70 @@ module.exports = {specifications: [
       }
     ]
   },
+  {
+    "type": "file",
+    "name": "Dialog.spec.ts",
+    "children": [
+      {
+        "type": "describe",
+        "name": "Popup",
+        "children": [
+          {
+            "type": "describe",
+            "name": "given the [Testing/Popups/Dialog, DialogWithFallbackPlacements] example is rendered",
+            "children": [
+              {
+                "type": "describe",
+                "name": "check the fallback placements",
+                "children": [
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to bottom",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: top"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to top",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: left"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "type": "file",
     "name": "ExpandableContainer.spec.ts",
@@ -1571,6 +1635,48 @@ module.exports = {specifications: [
                 ]
               }
             ]
+          },
+          {
+            "type": "describe",
+            "name": "given the [Testing/Popups/Menu, MenuWithFallbackPlacements] example is rendered",
+            "children": [
+              {
+                "type": "describe",
+                "name": "check the fallback placements",
+                "children": [
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to top",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: left"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
           }
         ]
       }
@@ -2859,6 +2965,48 @@ module.exports = {specifications: [
                 ]
               }
             ]
+          },
+          {
+            "type": "describe",
+            "name": "given the [Testing/Popups/Popup, PopupWithFallbackPlacements] example is rendered",
+            "children": [
+              {
+                "type": "describe",
+                "name": "check the fallback placements",
+                "children": [
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to top",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: left"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to right",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
           }
         ]
       }
@@ -6983,6 +7131,48 @@ module.exports = {specifications: [
                 ]
               }
             ]
+          },
+          {
+            "type": "describe",
+            "name": "given the [Testing/Popups/Tooltip, TooltipWithFallbackPlacements] example is rendered",
+            "children": [
+              {
+                "type": "describe",
+                "name": "check the fallback placements",
+                "children": [
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to top",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to left",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: right"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "describe",
+                    "name": "when the preferred placement is set to left",
+                    "children": [
+                      {
+                        "type": "it",
+                        "name": "should show the fallback placement: bottom"
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
           }
         ]
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "8.6.10",
+  "version": "8.6.12",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,9 +44,9 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^8.6.10",
-    "@workday/canvas-kit-preview-react": "^8.6.10",
-    "@workday/canvas-kit-react": "^8.6.10",
+    "@workday/canvas-kit-labs-react": "^8.6.12",
+    "@workday/canvas-kit-preview-react": "^8.6.12",
+    "@workday/canvas-kit-react": "^8.6.12",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "markdown-to-jsx": "^6.10.3",
     "ts-node": "^10.9.1"
@@ -57,5 +57,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "bb8329642b121f28363380a4de395d97c30afa7a"
+  "gitHead": "1921673512f69968238d3e4aab543810ce80b2d6"
 }