@telus-uds/components-web 2.9.0 → 2.10.0

package/component-docs.json

@@ -240,7 +240,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Whether to render BlockQuote as a heading size of `h3` or large text size"
         },
         "children": {
           "type": {
@@ -254,21 +254,21 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "External source's identifier (e.g. author's name)"
         },
         "linkHref": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "External source's URL"
         },
         "additionalInfo": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "To provide additional information about the source, rendered underneath `link`"
         }
       },
       "attributes": {}
@@ -400,7 +400,7 @@
             "name": "elementType"
           },
           "required": false,
-          "description": ""
+          "description": "Icon to display on the left side of the Callout"
         },
         "children": {
           "type": {
@@ -424,7 +424,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To change the horizontal alignment of the Callout's text"
         },
         "verticalAlign": {
           "type": {
@@ -445,7 +445,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To change the vertical alignment of the Callout's icon"
         }
       },
       "attributes": {}
@@ -813,7 +813,7 @@
             "name": "node"
           },
           "required": true,
-          "description": "The content"
+          "description": ""
         }
       },
       "attributes": {}
@@ -832,35 +832,35 @@
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "Function to call on pressing the panel's control, which should open or close the panel."
         },
         "onPress": {
           "type": {
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "Optional function to call on pressing the panel's control, in addition to opening or closing the panel"
         },
         "expandTitle": {
           "type": {
             "name": "string"
           },
           "required": true,
-          "description": ""
+          "description": "ExpandCollapseMiniControl title when expanded"
         },
         "collapseTitle": {
           "type": {
             "name": "string"
           },
           "required": true,
-          "description": ""
+          "description": "ExpandCollapseMiniControl title when collapsed"
         },
         "pressableState": {
           "type": {
             "name": "object"
           },
           "required": false,
-          "description": ""
+          "description": "React Native's `Pressable`'s state object"
         },
         "variant": {
           "type": {
@@ -1107,7 +1107,7 @@
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "To set a custom icon"
         },
         "action": {
           "type": {
@@ -1152,7 +1152,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To set the icon to a multi-brand compatabile icon"
         }
       },
       "attributes": {}
@@ -1349,7 +1349,7 @@
             "name": "array"
           },
           "required": false,
-          "description": ""
+          "description": "`Listbox` items"
         },
         "firstItemRef": {
           "defaultValue": {
@@ -1378,7 +1378,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "To select an item by default"
         }
       },
       "attributes": {}
@@ -1657,7 +1657,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Sets the `headingLevel` of the `heading`"
         },
         "onChange": {
           "defaultValue": {
@@ -1946,7 +1946,7 @@
               "name": "string"
             },
             "required": false,
-            "description": ""
+            "description": "Defines the title of the `OrderedList.Item`"
           },
           "tokens": {
             "defaultValue": {
@@ -2017,7 +2017,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Adds a `data-testid` attribute to the element for testing purposes"
         },
         "align": {
           "type": {
@@ -2199,14 +2199,14 @@
               "name": "string"
             },
             "required": true,
-            "description": ""
+            "description": "Name of the author"
           },
           "date": {
             "type": {
               "name": "string"
             },
             "required": true,
-            "description": ""
+            "description": "Date of the post"
           }
         },
         "attributes": {}
@@ -2240,7 +2240,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Size of the component\n\nSmall for pricing in product catalogue pages, medium for pricing in product comparison cards and large for pricing in banners and promo cards"
         },
         "signDirection": {
           "defaultValue": {
@@ -2261,7 +2261,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Displays which side the currency should apperar (left, right)"
         },
         "footnoteLinks": {
           "defaultValue": {
@@ -2283,7 +2283,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Shows additional link for context"
         },
         "currencySymbol": {
           "defaultValue": {
@@ -2294,7 +2294,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "If currency symbol other than `$` to be used"
         },
         "variant": {
           "defaultValue": {
@@ -2308,49 +2308,49 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Shows additional info above the price"
         },
         "price": {
           "type": {
             "name": "string"
           },
           "required": true,
-          "description": ""
+          "description": "Monetary value (including decimals separated by \".\")"
         },
         "rateText": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Shows month/year unit"
         },
         "bottomText": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Shows additional info below the price with a `Divider`"
         },
         "onClickFootnote": {
           "type": {
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "Function to be called when a footnote link is clicked"
         },
         "strikeThrough": {
           "type": {
             "name": "bool"
           },
           "required": false,
-          "description": ""
+          "description": "To show price savings comparison"
         },
         "a11yText": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "To provide a11y text for `PriceLockup` component\n\n**Note:** a11yText will override strikethrough price, so it must include price (ie. \"was 50 dollars per month\")"
         }
       },
       "attributes": {}
@@ -2470,7 +2470,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "The dictionary object containing the content for the input field"
         },
         "id": {
           "defaultValue": {
@@ -2481,7 +2481,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The id of the input field"
         },
         "hintPosition": {
           "defaultValue": {
@@ -2502,7 +2502,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "The position of the hint. Could be shown along side the label or below it"
         },
         "copy": {
           "defaultValue": {
@@ -2528,7 +2528,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "The language to use for the copy."
         },
         "variant": {
           "defaultValue": {
@@ -2556,63 +2556,63 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Sets `data-testid` attribute on the input field for testing purposes."
         },
         "minNumber": {
           "type": {
             "name": "number"
           },
           "required": false,
-          "description": ""
+          "description": "The minimum number allowed"
         },
         "maxNumber": {
           "type": {
             "name": "number"
           },
           "required": false,
-          "description": ""
+          "description": "The maximum number allowed"
         },
         "onChange": {
           "type": {
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "The callback function that is called when the value of the input field changes"
         },
         "defaultValue": {
           "type": {
             "name": "number"
           },
           "required": false,
-          "description": ""
+          "description": "The default value of the input field"
         },
         "label": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The label of the input field"
         },
         "hint": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The hint of the input field"
         },
         "tooltip": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Adds a question mark which will display a tooltip when clicked"
         },
         "accessibilityLabel": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The accessibility label of the input field"
         },
         "tokens": {
           "type": {
@@ -2809,7 +2809,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "Adds `data-testid` attribute for testing"
         },
         "flex": {
           "type": {
@@ -3124,7 +3124,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Sets text style"
         },
         "children": {
           "type": {
@@ -3474,21 +3474,21 @@
             "name": "bool"
           },
           "required": false,
-          "description": ""
+          "description": "If true, the toast will be displayed"
         },
         "copy": {
           "type": {
             "name": "string"
           },
           "required": true,
-          "description": ""
+          "description": "The copy to display in the toast"
         },
         "headline": {
           "type": {
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The headline to display in the toast (before copy)"
         },
         "link": {
           "type": {
@@ -3515,7 +3515,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "The link to display in the toast (after copy)"
         }
       },
       "attributes": {}
@@ -3988,14 +3988,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": {
@@ -6629,7 +6629,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "Changes direction of chevron icon"
         },
         "tokens": {
           "defaultValue": {
@@ -6713,7 +6713,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": {
@@ -8768,7 +8768,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To change the language for labels"
         },
         "LinkRouter": {
           "type": {
@@ -8859,7 +8859,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "When passed as `{{ compact: true }}`, `Pagination` does not render labels along side buttons"
         },
         "sideButtonTokens": {
           "type": {
@@ -8894,7 +8894,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens for `PaginationSideButton`"
         }
       },
       "attributes": {
@@ -8984,14 +8984,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": {
@@ -9008,7 +9008,7 @@
               ]
             },
             "required": false,
-            "description": ""
+            "description": "To change the language for labels"
           },
           "variant": {
             "type": {
@@ -9083,7 +9083,7 @@
             "name": "string"
           },
           "required": false,
-          "description": ""
+          "description": "The HTML tag to render the list as"
         },
         "tokens": {
           "type": {
@@ -9122,7 +9122,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens override for `Card`"
         },
         "listTokens": {
           "type": {
@@ -9154,7 +9154,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens override for `QuickLinksList`"
         },
         "variant": {
           "type": {
@@ -10329,7 +10329,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To hide children of `Responsive` if the current viewport is smaller than `min`"
         },
         "max": {
           "type": {
@@ -10354,7 +10354,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "To hide children of `Responsive` if the current viewport is larger than `max`"
         },
         "children": {
           "type": {
@@ -10665,7 +10665,7 @@
               "name": "string"
             },
             "required": true,
-            "description": ""
+            "description": "The label for the group."
           }
         },
         "attributes": {
@@ -10689,7 +10689,7 @@
               "name": "string"
             },
             "required": true,
-            "description": ""
+            "description": "The value of the option"
           }
         },
         "attributes": {
@@ -10783,7 +10783,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens for `SideNav.Item`"
         },
         "groupTokens": {
           "type": {
@@ -10805,7 +10805,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens for `SideNavItemsGroup`"
         }
       },
       "attributes": {
@@ -11024,7 +11024,7 @@
               }
             },
             "required": false,
-            "description": ""
+            "description": "Custom tokens for `SideNav.Item`"
           }
         },
         "attributes": {
@@ -11371,6 +11371,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": {
@@ -11658,7 +11659,7 @@
             "name": "number"
           },
           "required": false,
-          "description": ""
+          "description": "The current step, 0-based number"
         },
         "copy": {
           "defaultValue": {
@@ -11688,7 +11689,7 @@
             ]
           },
           "required": false,
-          "description": ""
+          "description": "The language to use for the labels"
         },
         "dictionary": {
           "defaultValue": {
@@ -11711,7 +11712,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom dictionary containing the labels to use for the steps"
         },
         "steps": {
           "defaultValue": {
@@ -11725,7 +11726,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "An array of strings defining the step titles"
         },
         "tokens": {
           "type": {
@@ -11847,14 +11848,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": {
@@ -11868,7 +11869,7 @@
             "name": "func"
           },
           "required": false,
-          "description": ""
+          "description": "Callback for when the selected tab changes"
         },
         "tokens": {
           "type": {
@@ -11915,7 +11916,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens for `TabsItem`"
         },
         "scrollButtonTokens": {
           "type": {
@@ -11938,7 +11939,7 @@
             }
           },
           "required": false,
-          "description": ""
+          "description": "Custom tokens for `HorizontalScrollButton`"
         },
         "variant": {
           "type": {