@telus-uds/components-web 2.17.2 → 2.18.0

package/component-docs.json

@@ -141,6 +141,57 @@
           },
           "required": false,
           "description": "Input value for controlled usage"
+        },
+        "initialItems": {
+          "type": {
+            "name": "arrayOf",
+            "value": {
+              "name": "shape",
+              "value": {
+                "id": {
+                  "name": "string",
+                  "required": false
+                },
+                "label": {
+                  "name": "string",
+                  "required": false
+                }
+              }
+            }
+          },
+          "required": false,
+          "description": "Can be used to set the initial items of the component"
+        },
+        "initialValue": {
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "Initial value for the component"
+        },
+        "readOnly": {
+          "type": {
+            "name": "bool"
+          },
+          "required": false,
+          "description": "Boolean to set if it's readonly or not"
+        },
+        "validation": {
+          "type": {
+            "name": "enum",
+            "value": [
+              {
+                "value": "'error'",
+                "computed": false
+              },
+              {
+                "value": "'success'",
+                "computed": false
+              }
+            ]
+          },
+          "required": false,
+          "description": "Use to visually mark an input as valid or invalid."
         }
       },
       "attributes": {}
@@ -243,12 +294,58 @@
           "required": false,
           "description": "Whether to render BlockQuote as a heading size of `h3` or large text size"
         },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "color": "color",
+              "backgroundGradient": "gradient",
+              "paddingLeft": "size",
+              "paddingRight": "size",
+              "paddingTop": "size",
+              "paddingBottom": "size",
+              "marginBottom": "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"
+            }
+          },
+          "required": false,
+          "description": ""
+        },
+        "variant": {
+          "type": {
+            "name": "exact",
+            "value": {
+              "alternative": {
+                "name": "bool",
+                "required": false
+              },
+              "size": {
+                "name": "string",
+                "required": false
+              }
+            }
+          },
+          "required": false,
+          "description": ""
+        },
         "children": {
           "type": {
             "name": "node"
           },
           "required": true,
-          "description": ""
+          "description": "Children nodes that can be added"
         },
         "link": {
           "type": {
@@ -396,6 +493,23 @@
           },
           "required": false
         },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "background": "color",
+              "gap": "size",
+              "borderRadius": "size",
+              "paddingLeft": "size",
+              "paddingRight": "size",
+              "paddingTop": "size",
+              "paddingBottom": "size",
+              "color": "color"
+            }
+          },
+          "required": false,
+          "description": ""
+        },
         "icon": {
           "type": {
             "name": "elementType"
@@ -408,7 +522,7 @@
             "name": "node"
           },
           "required": true,
-          "description": ""
+          "description": "Children nodes that can be added"
         },
         "textAlignToFlex": {
           "type": {
@@ -806,6 +920,28 @@
           "required": false,
           "description": "Disable the input which will not open the calendar picker"
         },
+        "prevTestID": {
+          "defaultValue": {
+            "value": "''",
+            "computed": false
+          },
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "A unique identifier for the previous icon button located on the datepicker.\nThis is for automation testing purposes.\nWill be added as a `data-testid-prev` attribute for example."
+        },
+        "nextTestID": {
+          "defaultValue": {
+            "value": "''",
+            "computed": false
+          },
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "A unique identifier for the next icon button located on the datepicker.\nThis is for automation testing purposes.\nWill be added as a `data-testid-next` attribute for example."
+        },
         "id": {
           "type": {
             "name": "string"
@@ -826,7 +962,7 @@
             "name": "node"
           },
           "required": true,
-          "description": ""
+          "description": "Children nodes that can be added"
         }
       },
       "attributes": {}
@@ -847,6 +983,20 @@
           "required": false,
           "description": "Function to call on pressing the panel's control, which should open or close the panel."
         },
+        "tokens": {
+          "defaultValue": {
+            "value": "{}",
+            "computed": false
+          },
+          "type": {
+            "name": "custom",
+            "raw": {
+              "borderWidth": "border"
+            }
+          },
+          "required": false,
+          "description": ""
+        },
         "nativeID": {
           "defaultValue": {
             "value": "''",
@@ -898,7 +1048,7 @@
             "name": "node"
           },
           "required": true,
-          "description": ""
+          "description": "Children nodes that can be added"
         }
       },
       "attributes": {}
@@ -1399,6 +1549,63 @@
           },
           "required": false,
           "description": "To select an item by default"
+        },
+        "onClose": {
+          "type": {
+            "name": "func"
+          },
+          "required": false,
+          "description": "onClose event"
+        },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "groupBorderRadius": "radius",
+              "groupBorderWidth": "border",
+              "groupFontSize": "size",
+              "groupFontName": "fontName",
+              "groupFontWeight": "fontWeight",
+              "groupColor": "color",
+              "groupBorderColor": "color",
+              "groupBackgroundColor": "color",
+              "groupPaddingTop": "size",
+              "groupPaddingBottom": "size",
+              "groupPaddingLeft": "size",
+              "groupPaddingRight": "size",
+              "groupIcon": "icon",
+              "itemDisplay": "show",
+              "itemFontName": "fontName",
+              "itemFontWeight": "fontWeight",
+              "itemFontSize": "size",
+              "itemPaddingTop": "size",
+              "itemPaddingBottom": "size",
+              "itemPaddingLeft": "size",
+              "itemPaddingRight": "size",
+              "itemColor": "color",
+              "itemBackgroundColor": "color",
+              "itemBorderLeftColor": "color",
+              "itemBorderLeftWidth": "border",
+              "itemBorderWidth": "border",
+              "itemTextDecoration": "textLine",
+              "itemOutline": "border",
+              "shadow": "shadow",
+              "itemBorderRightColor": "color",
+              "itemBorderBottomColor": "color",
+              "itemBorderTopColor": "color",
+              "itemBorderRightWidth": "border",
+              "itemBorderBottomWidth": "border",
+              "itemBorderTopWidth": "border",
+              "itemBorderRadius": "radius",
+              "minWidth": "size",
+              "minHeight": "size",
+              "itemHeight": "size",
+              "groupHeight": "size",
+              "lineHeight": "lineHeight"
+            }
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {}
@@ -1637,10 +1844,14 @@
       "props": {
         "accessibilityRole": {
           "defaultValue": {
-            "value": "'navigation'",
+            "value": "''",
             "computed": false
           },
-          "required": false
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "Accesibility role for stackview"
         },
         "headingLevel": {
           "defaultValue": {
@@ -1943,6 +2154,18 @@
           "required": false,
           "description": "The position to start the list with."
         },
+        "variant": {
+          "defaultValue": {
+            "value": "{}",
+            "computed": false
+          },
+          "type": {
+            "name": "custom",
+            "raw": "variantProp.propType"
+          },
+          "required": false,
+          "description": ""
+        },
         "children": {
           "type": {
             "name": "node"
@@ -2836,6 +3059,42 @@
           },
           "required": false,
           "description": "sets the top offset (triggers absolute positioning)"
+        },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "paddingLeft": "size",
+              "paddingRight": "size",
+              "paddingTop": "size",
+              "paddingBottom": "size",
+              "borderRadius": "size",
+              "backgroundColor": "color",
+              "boxShadowPaddingLeft": "size",
+              "boxShadowPaddingTop": "size",
+              "boxShadowPaddingRight": "size",
+              "boxShadowPaddingBottom": "size",
+              "boxShadowColor": "color",
+              "curveAfterWidth": "size",
+              "curveMarginTop": "size",
+              "curveAfterRadius": "size",
+              "curveBackgroundColor": "color",
+              "curveHeight": "size",
+              "curveWidth": "size",
+              "curveAfterBackgroundColor": "color",
+              "curveAfterHeight": "size",
+              "gradient": "gradient",
+              "fontColor": "color",
+              "borderRadiusBottomLeft": "size",
+              "borderRadiusBottomRight": "size",
+              "fontName": "fontName",
+              "fontWeight": "fontWeight",
+              "fontSize": "fontSize",
+              "lineHeight": "lineHeight"
+            }
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {}
@@ -3641,6 +3900,32 @@
           },
           "required": false,
           "description": "The link to display in the toast (after copy)"
+        },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "containerBackgroundColor": "color",
+              "containerGap": "size",
+              "animationHeightBefore": "size",
+              "animationHeightAfter": "size",
+              "animationPaddingBottomBefore": "size",
+              "animationPaddingBottomAfter": "size",
+              "animationPaddingTopBefore": "size",
+              "padding": "size",
+              "animationPaddingTopAfter": "size",
+              "animationBackgroundColorBefore": "color",
+              "animationBackgroundColorAfter": "color",
+              "animationColorBefore": "color",
+              "animationColorAfter": "color",
+              "animationDivColorBefore": "color",
+              "animationDivColorAfter": "color",
+              "chevronlinkFontWeight": "fontWeight",
+              "chevronlinkFontName": "fontName"
+            }
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {}
@@ -3855,6 +4140,27 @@
           },
           "required": true,
           "description": "The video player UI's language as an ISO language code. It currently supports English and French."
+        },
+        "tokens": {
+          "type": {
+            "name": "custom",
+            "raw": {
+              "borderColor": "color",
+              "pauseIcon": "icon",
+              "replayIcon": "icon",
+              "playIcon": "icon"
+            }
+          },
+          "required": false,
+          "description": ""
+        },
+        "variant": {
+          "type": {
+            "name": "custom",
+            "raw": "variantProp.propType"
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {}
@@ -3929,7 +4235,7 @@
       "props": {
         "rowSize": {
           "defaultValue": {
-            "value": "{ sm: 2, lg: 3, xl: 6 }",
+            "value": "null",
             "computed": false
           },
           "type": {
@@ -5374,6 +5680,13 @@
           },
           "required": false,
           "description": ""
+        },
+        "dataSet": {
+          "type": {
+            "name": "object"
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {
@@ -6783,10 +7096,126 @@
           },
           "required": false,
           "description": ""
+        },
+        "children": {
+          "type": {
+            "name": "node"
+          },
+          "required": false,
+          "description": ""
+        },
+        "variant": {
+          "type": {
+            "name": "exact",
+            "value": {
+              "size": {
+                "name": "enum",
+                "value": [
+                  {
+                    "value": "'large'",
+                    "computed": false
+                  },
+                  {
+                    "value": "'small'",
+                    "computed": false
+                  },
+                  {
+                    "value": "'micro'",
+                    "computed": false
+                  }
+                ],
+                "required": false
+              },
+              "alternative": {
+                "name": "bool",
+                "required": false
+              },
+              "inverse": {
+                "name": "bool",
+                "required": false
+              }
+            }
+          },
+          "required": false,
+          "description": ""
+        },
+        "onPress": {
+          "type": {
+            "name": "func"
+          },
+          "required": false,
+          "description": ""
+        },
+        "onPressIn": {
+          "type": {
+            "name": "func"
+          },
+          "required": false,
+          "description": ""
+        },
+        "onPressOut": {
+          "type": {
+            "name": "func"
+          },
+          "required": false,
+          "description": ""
+        },
+        "disabled": {
+          "type": {
+            "name": "bool"
+          },
+          "required": false,
+          "description": ""
+        },
+        "href": {
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": ""
+        },
+        "hrefAttrs": {
+          "type": {
+            "name": "shape",
+            "value": {
+              "download": {
+                "name": "string",
+                "required": false
+              },
+              "rel": {
+                "name": "string",
+                "required": false
+              },
+              "target": {
+                "name": "enum",
+                "value": [
+                  {
+                    "value": "'_self'",
+                    "computed": false
+                  },
+                  {
+                    "value": "'_blank'",
+                    "computed": false
+                  },
+                  {
+                    "value": "'_parent'",
+                    "computed": false
+                  },
+                  {
+                    "value": "'_top'",
+                    "computed": false
+                  }
+                ],
+                "required": false
+              }
+            }
+          },
+          "required": false,
+          "description": ""
         }
       },
       "attributes": {
-        "acceptsRNA11yProps": false
+        "acceptsRNA11yProps": true
       }
     }
   },
@@ -11008,12 +11437,38 @@
       "docs": {
         "description": "`SideNav.Item` is a navigational element that is used within `SideNav` or `SideNav.ItemsGroup`.\n\n This component can only be accessed as a name-spaced component: `SideNav.Item`.",
         "props": {
+          "isActive": {
+            "defaultValue": {
+              "value": "false",
+              "computed": false
+            },
+            "type": {
+              "name": "bool"
+            },
+            "required": false,
+            "description": "Set internally in `SideNav` render function."
+          },
+          "isExpanded": {
+            "defaultValue": {
+              "value": "false",
+              "computed": false
+            },
+            "type": {
+              "name": "bool"
+            },
+            "required": false,
+            "description": "Set internally in `SideNav.ItemsGroup` render function. Used to mark expanded `ItemsGroup` parent."
+          },
           "accessibilityRole": {
             "defaultValue": {
               "value": "'link'",
               "computed": false
             },
-            "required": false
+            "type": {
+              "name": "string"
+            },
+            "required": false,
+            "description": "Accesibility Role"
           },
           "children": {
             "type": {
@@ -11022,6 +11477,20 @@
             "required": true,
             "description": "Text content of the `Item`."
           },
+          "itemId": {
+            "type": {
+              "name": "string"
+            },
+            "required": false,
+            "description": "Set internally in `SideNav` render function - used to keep track of active item."
+          },
+          "groupId": {
+            "type": {
+              "name": "string"
+            },
+            "required": false,
+            "description": "Set internally in `SideNav` render function - used to keep track of expanded items groups."
+          },
           "onPress": {
             "type": {
               "name": "func"
@@ -11122,6 +11591,13 @@
             },
             "required": false,
             "description": ""
+          },
+          "testID": {
+            "type": {
+              "name": "number"
+            },
+            "required": false,
+            "description": "test ID"
           }
         },
         "attributes": {
@@ -12225,7 +12701,11 @@
             "value": "Platform.select({ web: 'group', default: 'none' })",
             "computed": true
           },
-          "required": false
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "AccesibilityRole for the Tags"
         },
         "tokens": {
           "type": {
@@ -12418,13 +12898,45 @@
             "value": "'button'",
             "computed": false
           },
-          "required": false
+          "type": {
+            "name": "string"
+          },
+          "required": false,
+          "description": "Accesibility role for TextButton"
         },
         "onPress": {
           "type": {
             "name": "func"
           },
           "required": true,
+          "description": "onPress function"
+        },
+        "children": {
+          "type": {
+            "name": "node"
+          },
+          "required": true,
+          "description": "Children node that can be added"
+        },
+        "variant": {
+          "type": {
+            "name": "objectOf",
+            "value": {
+              "name": "union",
+              "value": [
+                {
+                  "name": "string"
+                },
+                {
+                  "name": "number"
+                },
+                {
+                  "name": "bool"
+                }
+              ]
+            }
+          },
+          "required": false,
           "description": ""
         }
       },
@@ -13365,6 +13877,17 @@
           "required": false,
           "description": "Select English or French copy for the accessible label."
         },
+        "inline": {
+          "defaultValue": {
+            "value": "false",
+            "computed": false
+          },
+          "type": {
+            "name": "bool"
+          },
+          "required": false,
+          "description": "Display tooltip icon button as an inline element."
+        },
         "children": {
           "type": {
             "name": "union",