@brightspace-ui/core 3.219.5 → 3.219.7

package/custom-elements.json

@@ -2924,9 +2924,9 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "max-width",
@@ -2934,18 +2934,18 @@
           "type": "number"
         },
         {
-          "name": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -2953,6 +2953,11 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "vertical-offset",
           "description": "Provide custom offset, positive or negative",
@@ -2982,12 +2987,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "no-padding",
           "description": "Render with no padding",
@@ -3012,12 +3011,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trap-focus",
           "description": "Optionally render a d2l-focus-trap around the dropdown content",
@@ -3033,10 +3026,10 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "attribute": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "maxHeight",
+          "attribute": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "maxWidth",
@@ -3045,21 +3038,21 @@
           "type": "number"
         },
         {
-          "name": "minWidth",
-          "attribute": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "minHeight",
+          "attribute": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "maxHeight",
-          "attribute": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "minWidth",
+          "attribute": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "minHeight",
-          "attribute": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobileBreakpointOverride",
+          "attribute": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -3068,6 +3061,12 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "noMobileCloseButton",
+          "attribute": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "verticalOffset",
           "attribute": "vertical-offset",
@@ -3102,13 +3101,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "noMobileCloseButton",
-          "attribute": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "noPadding",
           "attribute": "no-padding",
@@ -3137,13 +3129,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobileBreakpointOverride",
-          "attribute": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trapFocus",
           "attribute": "trap-focus",
@@ -3300,9 +3285,9 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "max-width",
@@ -3310,18 +3295,18 @@
           "type": "number"
         },
         {
-          "name": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -3329,6 +3314,11 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "vertical-offset",
           "description": "Provide custom offset, positive or negative",
@@ -3358,12 +3348,6 @@
           "type": "boolean",
           "default": "true"
         },
-        {
-          "name": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "no-padding",
           "description": "Render with no padding",
@@ -3388,12 +3372,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trap-focus",
           "description": "Optionally render a d2l-focus-trap around the dropdown content",
@@ -3409,10 +3387,10 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "attribute": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "maxHeight",
+          "attribute": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "maxWidth",
@@ -3421,21 +3399,21 @@
           "type": "number"
         },
         {
-          "name": "minWidth",
-          "attribute": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "minHeight",
+          "attribute": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "maxHeight",
-          "attribute": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "minWidth",
+          "attribute": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "minHeight",
-          "attribute": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobileBreakpointOverride",
+          "attribute": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -3444,6 +3422,12 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "noMobileCloseButton",
+          "attribute": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "verticalOffset",
           "attribute": "vertical-offset",
@@ -3478,13 +3462,6 @@
           "type": "boolean",
           "default": "true"
         },
-        {
-          "name": "noMobileCloseButton",
-          "attribute": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "noPadding",
           "attribute": "no-padding",
@@ -3513,13 +3490,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobileBreakpointOverride",
-          "attribute": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trapFocus",
           "attribute": "trap-focus",
@@ -3676,9 +3646,9 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "max-width",
@@ -3686,18 +3656,18 @@
           "type": "number"
         },
         {
-          "name": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -3705,6 +3675,11 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "vertical-offset",
           "description": "Provide custom offset, positive or negative",
@@ -3734,12 +3709,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "no-padding",
           "description": "Render with no padding",
@@ -3764,12 +3733,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trap-focus",
           "description": "Optionally render a d2l-focus-trap around the dropdown content",
@@ -3785,10 +3748,10 @@
           "type": "'start'|'end'"
         },
         {
-          "name": "boundary",
-          "attribute": "boundary",
-          "description": "Optionally provide boundaries to where the dropdown will appear. Valid properties are \"above\", \"below\", \"left\", and \"right\".",
-          "type": "object"
+          "name": "maxHeight",
+          "attribute": "max-height",
+          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "type": "number"
         },
         {
           "name": "maxWidth",
@@ -3797,21 +3760,21 @@
           "type": "number"
         },
         {
-          "name": "minWidth",
-          "attribute": "min-width",
-          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
+          "name": "minHeight",
+          "attribute": "min-height",
+          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
           "type": "number"
         },
         {
-          "name": "maxHeight",
-          "attribute": "max-height",
-          "description": "Override max-height. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "minWidth",
+          "attribute": "min-width",
+          "description": "Override default min-width (undefined). Specify a number that would be the px value.",
           "type": "number"
         },
         {
-          "name": "minHeight",
-          "attribute": "min-height",
-          "description": "Override default height used for required space when `no-auto-fit` is true. Specify a number that would be the px value. Note that the default behaviour is to be as tall as necessary within the viewport, so this property is usually not needed.",
+          "name": "mobileBreakpointOverride",
+          "attribute": "mobile-breakpoint",
+          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
           "type": "number"
         },
         {
@@ -3820,6 +3783,12 @@
           "description": "Mobile dropdown style.",
           "type": "'left'|'right'|'bottom'"
         },
+        {
+          "name": "noMobileCloseButton",
+          "attribute": "no-mobile-close-button",
+          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
+          "type": "boolean"
+        },
         {
           "name": "verticalOffset",
           "attribute": "vertical-offset",
@@ -3854,13 +3823,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "noMobileCloseButton",
-          "attribute": "no-mobile-close-button",
-          "description": "Opt-out of showing a close button in the footer of tray-style mobile dropdowns.",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "noPadding",
           "attribute": "no-padding",
@@ -3889,13 +3851,6 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "mobileBreakpointOverride",
-          "attribute": "mobile-breakpoint",
-          "description": "Override the breakpoint at which mobile styling is used. Defaults to 616px.",
-          "type": "number",
-          "default": "616"
-        },
         {
           "name": "trapFocus",
           "attribute": "trap-focus",

package/helpers/README.md

@@ -296,17 +296,3 @@ import '@brightspace-ui/core/helpers/viewport-size.js';
     min-width: calc(var(--d2l-vw, 1vw) * 100);
 }
 ```
-
-## Visual Ready
-
-A helper for determining that the page is visually "ready" (i.e., necessary pieces are loaded) and calculations can be done. Currently it handles waiting for fonts to be ready, but going forward it can have other pieces added as needed. This is useful in places like the tooltip, where the fonts being loaded has an impact on the tooltip position calculation.
-
-Example usage within a component:
-```javascript
-import { visualReady } from '../../helpers/visualReady.js';
-
-async getUpdateComplete() {
-    await super.getUpdateComplete();
-    await visualReady;
-}
-```