@workday/canvas-kit-docs 16.2.10 → 16.2.11

package/dist/es6/lib/docs.js

@@ -144438,14 +144438,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "boolean"
           },
-          "description": "If true, the Avatar won't forward the `name` prop to the `alt` attribute of the image. This is useful when the Avatar is purely decorative and is rendered next to a name or text.",
+          "description": "If true, hides the image and fallback initials from assistive technology. This is useful when\nthe Avatar is purely decorative and is rendered next to a name or text.",
           "declarations": [
             {
               "name": "isDecorative",
               "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
             }
           ],
-          "tags": {}
+          "tags": {
+            "default": "false"
+          },
+          "defaultValue": {
+            "kind": "boolean",
+            "value": false
+          }
         },
         {
           "kind": "property",
@@ -275737,14 +275743,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "boolean"
           },
-          "description": "If true, the Avatar won't forward the `name` prop to the `alt` attribute of the image. This is useful when the Avatar is purely decorative and is rendered next to a name or text.",
+          "description": "If true, hides the image and fallback initials from assistive technology. This is useful when\nthe Avatar is purely decorative and is rendered next to a name or text.",
           "declarations": [
             {
               "name": "isDecorative",
               "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
             }
           ],
-          "tags": {},
+          "tags": {
+            "default": "false"
+          },
           "defaultValue": {
             "kind": "boolean",
             "value": true
@@ -380320,14 +380328,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "boolean"
           },
-          "description": "If true, the Avatar won't forward the `name` prop to the `alt` attribute of the image. This is useful when the Avatar is purely decorative and is rendered next to a name or text.",
+          "description": "If true, hides the image and fallback initials from assistive technology. This is useful when\nthe Avatar is purely decorative and is rendered next to a name or text.",
           "declarations": [
             {
               "name": "isDecorative",
               "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
             }
           ],
-          "tags": {}
+          "tags": {
+            "default": "false"
+          },
+          "defaultValue": {
+            "kind": "boolean",
+            "value": false
+          }
         },
         {
           "kind": "property",

package/dist/es6/lib/specs.js

@@ -596,6 +596,20 @@ module.exports = {specifications: [
         "type": "describe",
         "name": "Avatar",
         "children": [
+          {
+            "type": "describe",
+            "name": "Decorative initials",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "it",
+                "name": "should keep the initials visible but hidden from assistive technology beside the name"
+              }
+            ]
+          },
           {
             "type": "describe",
             "name": "Image Example",

package/dist/es6/lib/stackblitzFiles/packageJSONFile.js

@@ -18,11 +18,11 @@ export const packageJSONFile = `{
     "@emotion/react": "11.11.4",
     "@types/react": "18.2.60",
     "@types/react-dom": "18.2.19",
-    "@workday/canvas-kit-labs-react": "16.2.10",
-    "@workday/canvas-kit-preview-react": "16.2.10",
-    "@workday/canvas-kit-react": "16.2.10",
-    "@workday/canvas-kit-react-fonts": "^16.2.10",
-    "@workday/canvas-kit-styling": "16.2.10",
+    "@workday/canvas-kit-labs-react": "16.2.11",
+    "@workday/canvas-kit-preview-react": "16.2.11",
+    "@workday/canvas-kit-react": "16.2.11",
+    "@workday/canvas-kit-react-fonts": "^16.2.11",
+    "@workday/canvas-kit-styling": "16.2.11",
     "@workday/canvas-system-icons-web": "^5.0.3",
     "@workday/canvas-expressive-icons-web": "1.0.1",
     "@workday/canvas-tokens-web": "4.4.0-beta.11"

package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts

@@ -19,11 +19,11 @@ export const packageJSONFile = `{
     "@emotion/react": "11.11.4",
     "@types/react": "18.2.60",
     "@types/react-dom": "18.2.19",
-    "@workday/canvas-kit-labs-react": "16.2.10",
-    "@workday/canvas-kit-preview-react": "16.2.10",
-    "@workday/canvas-kit-react": "16.2.10",
-    "@workday/canvas-kit-react-fonts": "^16.2.10",
-    "@workday/canvas-kit-styling": "16.2.10",
+    "@workday/canvas-kit-labs-react": "16.2.11",
+    "@workday/canvas-kit-preview-react": "16.2.11",
+    "@workday/canvas-kit-react": "16.2.11",
+    "@workday/canvas-kit-react-fonts": "^16.2.11",
+    "@workday/canvas-kit-styling": "16.2.11",
     "@workday/canvas-system-icons-web": "^5.0.3",
     "@workday/canvas-expressive-icons-web": "1.0.1",
     "@workday/canvas-tokens-web": "4.4.0-beta.11"

package/dist/mdx/react/avatar/Avatar.mdx

@@ -1,14 +1,11 @@
-import {
-  ExampleCodeBlock,
-  Specifications,
-  SymbolDoc,
-} from '@workday/canvas-kit-docs';
+import {ExampleCodeBlock, Specifications, SymbolDoc} from '@workday/canvas-kit-docs';
 
 import {Avatar} from '@workday/canvas-kit-react/avatar';
 
 import Basic from './examples/Basic';
 import Custom from './examples/Custom';
 import Decorative from './examples/Decorative';
+import DecorativeInitials from './examples/DecorativeInitials';
 import Image from './examples/Image';
 import Size from './examples/Size';
 import Variant from './examples/Variant';
@@ -77,11 +74,15 @@ For complete control over styling and behavior, use the `BaseAvatar` component:
 
 ### Accessibility
 
-If the Avatar is purely decorative, you can set the `isDecorative` prop to `true` to prevent the
-`name` prop from being forwarded to the `alt` attribute of the image.
+If the Avatar is rendered next to the user's name, set `isDecorative` to `true` to hide the image
+and fallback initials from assistive technology. This avoids announcing the same name twice.
 
 <ExampleCodeBlock code={Decorative} />
 
+The same applies when no image is provided:
+
+<ExampleCodeBlock code={DecorativeInitials} />
+
 ## Component API
 
 <SymbolDoc name="Avatar" fileName="/react/" hideDescription />

package/dist/mdx/react/avatar/examples/DecorativeInitials.tsx

@@ -0,0 +1,18 @@
+import {Avatar} from '@workday/canvas-kit-react/avatar';
+import {Text} from '@workday/canvas-kit-react/text';
+import {createStyles} from '@workday/canvas-kit-styling';
+import {system} from '@workday/canvas-tokens-web';
+
+const containerStyles = createStyles({
+  display: 'inline-flex',
+  gap: system.gap.sm,
+  alignItems: 'center',
+});
+export default () => {
+  return (
+    <div className={containerStyles}>
+      <Avatar name="Nicholas Smith" isDecorative size="small" />
+      <Text>Nicholas Smith</Text>
+    </div>
+  );
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "16.2.10",
+  "version": "16.2.11",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -47,10 +47,10 @@
     "@stackblitz/sdk": "^1.11.0",
     "@storybook/csf": "0.0.1",
     "@workday/canvas-expressive-icons-web": "1.0.2",
-    "@workday/canvas-kit-labs-react": "^16.2.10",
-    "@workday/canvas-kit-preview-react": "^16.2.10",
-    "@workday/canvas-kit-react": "^16.2.10",
-    "@workday/canvas-kit-styling": "^16.2.10",
+    "@workday/canvas-kit-labs-react": "^16.2.11",
+    "@workday/canvas-kit-preview-react": "^16.2.11",
+    "@workday/canvas-kit-react": "^16.2.11",
+    "@workday/canvas-kit-styling": "^16.2.11",
     "@workday/canvas-system-icons-web": "^5.0.3",
     "@workday/canvas-tokens-web": "^4.4.0",
     "markdown-to-jsx": "^7.2.0",
@@ -63,5 +63,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "5.0"
   },
-  "gitHead": "6a4d75f8471a067d25a6de34c9e387cf4cababd7"
+  "gitHead": "21b0c64e5227e1a6aa3208ad52495c8ae543aa55"
 }