@telus-uds/components-base 1.51.0 → 1.51.1

package/CHANGELOG.md

@@ -1,19 +1,27 @@
 # Change Log - @telus-uds/components-base
 
-This log was last generated on Fri, 16 Jun 2023 21:05:00 GMT and should not be manually modified.
+This log was last generated on Tue, 20 Jun 2023 16:00:54 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.51.1
+
+Tue, 20 Jun 2023 16:00:54 GMT
+
+### Patches
+
+- Bump @telus-uds/system-theme-tokens to v2.34.0
+
 ## 1.51.0
 
-Fri, 16 Jun 2023 21:05:00 GMT
+Fri, 16 Jun 2023 21:12:21 GMT
 
 ### Minor changes
 
 - Change in tags due to multibrand standardization (35577399+JoshHC@users.noreply.github.com)
 - feature:update MultiSelectFilter to follow design (samuraix221@hotmail.com)
 - Adapt the tokens to the steptracker (mauricio.batresmontejo@telus.com)
-- Update 'LinkBase' to pass Pressable state through to children  (kyle.king2@telus.com)
+- Update 'LinkBase' to pass Pressable state through to children (kyle.king2@telus.com)
 - Bump @telus-uds/system-theme-tokens to v2.33.0
 
 ## 1.50.0

package/component-docs.json

@@ -287,7 +287,19 @@
         "paddingTop": "size",
         "paddingBottom": "size",
         "marginBottom": "size",
-        "width": "size"
+        "width": "size",
+        "titleHeadingFontSize": "fontSize",
+        "titleHeadingFontName": "fontName",
+        "titleHeadingFontWeight": "fontWeight",
+        "titleHeadingLineHeight": "lineHeight",
+        "titleFontSize": "fontSize",
+        "titleFontName": "fontName",
+        "titleFontWeight": "fontWeight",
+        "titleLineHeight": "lineHeight",
+        "linkFontSize": "fontSize",
+        "linkFontName": "fontName",
+        "linkFontWeight": "fontWeight",
+        "linkLineHeight": "lineHeight"
       },
       "Box": {
         "backgroundColor": "color",
@@ -542,6 +554,9 @@
         "calendarDaySelectedHoverBeforeBorderColor": "color",
         "calendarDaySelectedHoverBorderColor": "color",
         "calendarDaySelectedHoverColor": "color",
+        "calendarDaySelectedDisabledBackground": "color",
+        "calendarDaySelectedDisabledColor": "color",
+        "calendarDaySelectedDisabledContentBackgroundColor": "color",
         "calendarMonthCaptionColor": "color",
         "calendarMonthCaptionFontName": "fontName",
         "calendarMonthCaptionFontSize": "fontSize",
@@ -3301,14 +3316,14 @@
               "name": "string"
             },
             "required": true,
-            "description": ""
+            "description": "Text to be read by screen readers"
           },
           "heading": {
             "type": {
               "name": "bool"
             },
             "required": false,
-            "description": ""
+            "description": "Whether text should be rendered as a heading"
           }
         },
         "attributes": {
@@ -4230,7 +4245,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "A number referring to a position on the space scale to create space on either side of the divider"
           },
           "variant": {
             "type": {
@@ -6001,14 +6016,14 @@
               "name": "elementType"
             },
             "required": true,
-            "description": ""
+            "description": "Defines the icon to be rendered"
           },
           "href": {
             "type": {
               "name": "string"
             },
             "required": false,
-            "description": ""
+            "description": "URL to navigate to when the `Iconbutton` is pressed"
           },
           "hrefAttrs": {
             "type": {
@@ -6047,14 +6062,14 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "URL options to navigate to when the `Iconbutton` is pressed"
           },
           "onPress": {
             "type": {
               "name": "func"
             },
             "required": false,
-            "description": ""
+            "description": "Function to execute when the `Iconbutton` is pressed"
           }
         },
         "attributes": {
@@ -6795,28 +6810,28 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "To define the locale of the copy"
           },
           "isOpen": {
             "type": {
               "name": "bool"
             },
             "required": false,
-            "description": ""
+            "description": "Setting this to `true` will open the `Modal`"
           },
           "onClose": {
             "type": {
               "name": "func"
             },
             "required": false,
-            "description": ""
+            "description": "This function is triggered when the `Modal` is closed"
           },
           "maxWidth": {
             "type": {
               "name": "bool"
             },
             "required": false,
-            "description": ""
+            "description": "`max-width` is applied to the `Modal` container"
           },
           "tokens": {
             "type": {
@@ -7268,7 +7283,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "To change the language for labels"
           },
           "LinkRouter": {
             "type": {
@@ -7359,7 +7374,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "When passed as `{{ compact: true }}`, `Pagination` does not render labels along side buttons"
           },
           "sideButtonTokens": {
             "type": {
@@ -7394,7 +7409,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `PaginationSideButton`"
           }
         },
         "attributes": {
@@ -7484,14 +7499,14 @@
                 "name": "string"
               },
               "required": false,
-              "description": ""
+              "description": "To set custom label for the button"
             },
             "isActive": {
               "type": {
                 "name": "bool"
               },
               "required": false,
-              "description": ""
+              "description": "To set `PageButton` to active state"
             },
             "copy": {
               "type": {
@@ -7508,7 +7523,7 @@
                 ]
               },
               "required": false,
-              "description": ""
+              "description": "To change the language for labels"
             },
             "variant": {
               "type": {
@@ -7770,7 +7785,7 @@
               "name": "string"
             },
             "required": false,
-            "description": ""
+            "description": "The HTML tag to render the list as"
           },
           "tokens": {
             "type": {
@@ -7809,7 +7824,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens override for `Card`"
           },
           "listTokens": {
             "type": {
@@ -7841,7 +7856,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens override for `QuickLinksList`"
           },
           "variant": {
             "type": {
@@ -8511,7 +8526,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "To hide children of `Responsive` if the current viewport is smaller than `min`"
           },
           "max": {
             "type": {
@@ -8536,7 +8551,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "To hide children of `Responsive` if the current viewport is larger than `max`"
           },
           "children": {
             "type": {
@@ -8847,7 +8862,7 @@
                 "name": "string"
               },
               "required": true,
-              "description": ""
+              "description": "The label for the group."
             }
           },
           "attributes": {
@@ -8871,7 +8886,7 @@
                 "name": "string"
               },
               "required": true,
-              "description": ""
+              "description": "The value of the option"
             }
           },
           "attributes": {
@@ -8965,7 +8980,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `SideNav.Item`"
           },
           "groupTokens": {
             "type": {
@@ -8987,7 +9002,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `SideNavItemsGroup`"
           }
         },
         "attributes": {
@@ -9206,7 +9221,7 @@
                 }
               },
               "required": false,
-              "description": ""
+              "description": "Custom tokens for `SideNav.Item`"
             }
           },
           "attributes": {
@@ -9553,6 +9568,7 @@
                     "space": {
                       "name": "custom",
                       "raw": "spacingProps.types.spacingValue",
+                      "description": "A number referring to a position on the space scale to create space on either side of the divider",
                       "required": false
                     },
                     "variant": {
@@ -9683,7 +9699,7 @@
               "name": "number"
             },
             "required": false,
-            "description": ""
+            "description": "The current step, 0-based number"
           },
           "copy": {
             "defaultValue": {
@@ -9713,7 +9729,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "The language to use for the labels"
           },
           "dictionary": {
             "defaultValue": {
@@ -9736,7 +9752,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom dictionary containing the labels to use for the steps"
           },
           "steps": {
             "defaultValue": {
@@ -9750,7 +9766,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "An array of strings defining the step titles"
           },
           "tokens": {
             "type": {
@@ -9872,14 +9888,14 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Array of `TabsItem`s"
           },
           "value": {
             "type": {
               "name": "string"
             },
             "required": false,
-            "description": ""
+            "description": "`id` property of the current tab in the items array"
           },
           "initialValue": {
             "type": {
@@ -9893,7 +9909,7 @@
               "name": "func"
             },
             "required": false,
-            "description": ""
+            "description": "Callback for when the selected tab changes"
           },
           "tokens": {
             "type": {
@@ -9940,7 +9956,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `TabsItem`"
           },
           "scrollButtonTokens": {
             "type": {
@@ -9963,7 +9979,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `HorizontalScrollButton`"
           },
           "variant": {
             "type": {
@@ -13318,7 +13334,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "Changes direction of chevron icon"
           },
           "tokens": {
             "defaultValue": {

package/lib/A11yText/index.js

@@ -57,7 +57,15 @@ const A11yText = /*#__PURE__*/(0, _react.forwardRef)((_ref, ref) => {
 });
 A11yText.displayName = 'A11yText';
 A11yText.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Text to be read by screen readers
+   */
   text: _propTypes.default.string.isRequired,
+
+  /**
+   * Whether text should be rendered as a heading
+   */
   heading: _propTypes.default.bool
 };
 

package/lib/Divider/Divider.js

@@ -128,6 +128,10 @@ const Divider = /*#__PURE__*/(0, _react.forwardRef)((_ref, ref) => {
 Divider.displayName = 'Divider';
 Divider.propTypes = { ...selectedSystemPropTypes,
   tokens: (0, _utils.getTokensPropType)('Divider'),
+
+  /**
+   * A number referring to a position on the space scale to create space on either side of the divider
+   */
   space: _utils.spacingProps.types.spacingValue,
   variant: _utils.variantProp.propType,
 

package/lib/IconButton/IconButton.js

@@ -145,9 +145,25 @@ IconButton.displayName = 'IconButton';
 IconButton.propTypes = { ...selectedSystemPropTypes,
   variant: _utils.variantProp.propType,
   tokens: (0, _utils.getTokensPropType)('IconButton'),
+
+  /**
+   * Defines the icon to be rendered
+   */
   icon: _propTypes.default.elementType.isRequired,
+
+  /**
+   * URL to navigate to when the `Iconbutton` is pressed
+   */
   href: _propTypes.default.string,
+
+  /**
+   * URL options to navigate to when the `Iconbutton` is pressed
+   */
   hrefAttrs: _propTypes.default.shape(_utils.hrefAttrsProp.types),
+
+  /**
+   * Function to execute when the `Iconbutton` is pressed
+   */
   onPress: _propTypes.default.func
 };
 

package/lib/Link/ChevronLink.js

@@ -70,6 +70,10 @@ const ChevronLink = /*#__PURE__*/(0, _react.forwardRef)((_ref, ref) => {
 ChevronLink.displayName = 'ChevronLink';
 ChevronLink.propTypes = { ..._LinkBase.default.propTypes,
   tokens: (0, _utils.getTokensPropType)('ChevronLink', 'Link'),
+
+  /**
+   * Changes direction of chevron icon
+   */
   direction: _propTypes.default.oneOf(['left', 'right'])
 };
 var _default = ChevronLink;

package/lib/Modal/Modal.js

@@ -200,9 +200,25 @@ const Modal = /*#__PURE__*/(0, _react.forwardRef)((_ref5, ref) => {
 Modal.displayName = 'Modal';
 Modal.propTypes = { ...selectedSystemPropTypes,
   children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.arrayOf(_propTypes.default.node)]),
+
+  /**
+   * To define the locale of the copy
+   */
   copy: _utils.copyPropTypes,
+
+  /**
+   * Setting this to `true` will open the `Modal`
+   */
   isOpen: _propTypes.default.bool,
+
+  /**
+   * This function is triggered when the `Modal` is closed
+   */
   onClose: _propTypes.default.func,
+
+  /**
+   * `max-width` is applied to the `Modal` container
+   */
   maxWidth: _propTypes.default.bool,
   tokens: (0, _utils.getTokensPropType)('Modal'),
   variant: _utils.variantProp.propType,

package/lib/Pagination/PageButton.js

@@ -80,8 +80,20 @@ const PageButton = /*#__PURE__*/(0, _react.forwardRef)((_ref, ref) => {
 });
 PageButton.displayName = 'PageButton';
 PageButton.propTypes = { ..._utils.linkProps.types,
+
+  /**
+   * To set custom label for the button
+   */
   label: _propTypes.default.string,
+
+  /**
+   * To set `PageButton` to active state
+   */
   isActive: _propTypes.default.bool,
+
+  /**
+   * To change the language for labels
+   */
   copy: _utils.copyPropTypes,
   variant: _utils.variantProp.propType,
   tokens: (0, _utils.getTokensPropType)('PaginationPageButton')

package/lib/Pagination/Pagination.js

@@ -210,10 +210,22 @@ Pagination.PageButton = _PageButton.default;
 Pagination.propTypes = { ...selectedSystemPropTypes,
   ..._utils.withLinkRouter.propTypes,
   children: (0, _utils.componentPropType)('PageButton'),
+
+  /**
+   * To change the language for labels
+   */
   copy: _utils.copyPropTypes,
   variant: _utils.variantProp.propType,
   tokens: (0, _utils.getTokensPropType)('Pagination'),
+
+  /**
+   * When passed as `{{ compact: true }}`, `Pagination` does not render labels along side buttons
+   */
   sideButtonVariant: _utils.variantProp.propType,
+
+  /**
+   * Custom tokens for `PaginationSideButton`
+   */
   sideButtonTokens: (0, _utils.getTokensPropType)('PaginationSideButton')
 };
 

package/lib/QuickLinks/QuickLinks.js

@@ -81,8 +81,20 @@ const QuickLinks = /*#__PURE__*/(0, _react.forwardRef)((_ref, ref) => {
 QuickLinks.displayName = 'QuickLinks';
 QuickLinks.propTypes = {
   tokens: (0, _utils.getTokensPropType)('QuickLinks'),
+
+  /**
+   * Custom tokens override for `Card`
+   */
   cardTokens: (0, _utils.getTokensPropType)('Card'),
+
+  /**
+   * Custom tokens override for `QuickLinksList`
+   */
   listTokens: (0, _utils.getTokensPropType)('QuickLinksList'),
+
+  /**
+   * The HTML tag to render the list as
+   */
   tag: _propTypes.default.string,
   variant: _utils.variantProp.propType,
   children: _propTypes.default.node

package/lib/Responsive/Responsive.js

@@ -50,7 +50,14 @@ const Responsive = _ref => {
 };
 
 Responsive.propTypes = {
+  /**
+   * To hide children of `Responsive` if the current viewport is smaller than `min`
+   */
   min: _propTypes.default.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
+
+  /**
+   * To hide children of `Responsive` if the current viewport is larger than `max`
+   */
   max: _propTypes.default.oneOf(['sm', 'md', 'lg', 'xl']),
   children: _propTypes.default.node.isRequired
 };

package/lib/Select/Group.js

@@ -30,5 +30,9 @@ var _default = Group;
 exports.default = _default;
 Group.propTypes = {
   children: (0, _utils.componentPropType)('Item'),
+
+  /**
+   * The label for the group.
+   */
   label: _propTypes.default.string.isRequired
 };

package/lib/Select/Group.native.js

@@ -22,5 +22,9 @@ var _default = Group;
 exports.default = _default;
 Group.propTypes = {
   children: (0, _utils.componentPropType)('Item'),
+
+  /**
+   * The label for the group.
+   */
   label: _propTypes.default.string.isRequired
 };

package/lib/Select/Item.js

@@ -28,5 +28,9 @@ var _default = Item;
 exports.default = _default;
 Item.propTypes = {
   children: _propTypes.default.string.isRequired,
+
+  /**
+   * The value of the option
+   */
   value: _propTypes.default.string.isRequired
 };

package/lib/SideNav/ItemsGroup.js

@@ -141,6 +141,10 @@ ItemsGroup.propTypes = {
   isActive: _propTypes.default.bool,
   variant: _utils.variantProp.propType,
   tokens: (0, _utils.getTokensPropType)('SideNavItemsGroup'),
+
+  /**
+   * Custom tokens for `SideNav.Item`
+   */
   itemTokens: (0, _utils.getTokensPropType)('SideNavItem')
 };
 var _default = ItemsGroup;

package/lib/SideNav/SideNav.js

@@ -147,7 +147,15 @@ SideNav.propTypes = { ...selectedSystemPropTypes,
   accordion: _propTypes.default.bool,
   variant: _utils.variantProp.propType,
   tokens: (0, _utils.getTokensPropType)('SideNav'),
+
+  /**
+   * Custom tokens for `SideNav.Item`
+   */
   itemTokens: (0, _utils.getTokensPropType)('SideNavItem'),
+
+  /**
+   * Custom tokens for `SideNavItemsGroup`
+   */
   groupTokens: (0, _utils.getTokensPropType)('SideNavItemsGroup')
 };
 SideNav.Item = _Item.default;

package/lib/StepTracker/StepTracker.js

@@ -194,12 +194,28 @@ const dictionaryContentShape = _propTypes.default.shape({
 });
 
 StepTracker.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * The current step, 0-based number
+   */
   current: _propTypes.default.number,
+
+  /**
+   * The language to use for the labels
+   */
   copy: _propTypes.default.oneOfType([_propTypes.default.oneOf(['en', 'fr']), dictionaryContentShape]),
+
+  /**
+   * Custom dictionary containing the labels to use for the steps
+   */
   dictionary: _propTypes.default.shape({
     en: dictionaryContentShape,
     fr: dictionaryContentShape
   }),
+
+  /**
+   * An array of strings defining the step titles
+   */
   steps: _propTypes.default.arrayOf(_propTypes.default.string),
   tokens: (0, _utils.getTokensPropType)('StepTracker'),
   variant: _utils.variantProp.propType