@cloudscape-design/chat-components 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,8 +15,6 @@ export interface AvatarProps {
15
15
  * The text content shown directly in the avatar's body.
16
16
  * Can be 1 or 2 symbols long, every subsequent symbol is ignored.
17
17
  * Use it to define initials that uniquely identify the avatar's owner.
18
- *
19
- * When you use this property, make sure to include it in the `ariaLabel`.
20
18
  */
21
19
  initials?: string;
22
20
  /**
@@ -26,9 +24,9 @@ export interface AvatarProps {
26
24
  /**
27
25
  * Text to describe the avatar for assistive technology.
28
26
  * When more than one avatar is used, provide a unique label for each.
29
- * For example, "User avatar" and "AI assistant avatar" or "Your avatar" and "User avatar for John Doe".
27
+ * For example, "Avatar of John Doe" or "Avatar of generative AI assistant".
30
28
  *
31
- * If `tooltipText` or `initials` are used make sure to include them in the `ariaLabel`.
29
+ * If `tooltipText` is used make sure to include it in the `ariaLabel`.
32
30
  */
33
31
  ariaLabel: string;
34
32
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/avatar/interfaces.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nexport interface AvatarProps {\n /**\n * Determines the color of the avatar.\n * Use `gen-ai` for AI assistants and `default` otherwise.\n */\n color?: AvatarProps.Color;\n\n /**\n * The text content shown in the avatar's tooltip.\n *\n * When you use this property, make sure to include it in the `ariaLabel`.\n */\n tooltipText?: string;\n\n /**\n * The text content shown directly in the avatar's body.\n * Can be 1 or 2 symbols long, every subsequent symbol is ignored.\n * Use it to define initials that uniquely identify the avatar's owner.\n *\n * When you use this property, make sure to include it in the `ariaLabel`.\n */\n initials?: string;\n\n /**\n * When set to true, a loading indicator is shown in avatar.\n */\n loading?: boolean;\n\n /**\n * Text to describe the avatar for assistive technology.\n * When more than one avatar is used, provide a unique label for each.\n * For example, \"User avatar\" and \"AI assistant avatar\" or \"Your avatar\" and \"User avatar for John Doe\".\n *\n * If `tooltipText` or `initials` are used make sure to include them in the `ariaLabel`.\n */\n ariaLabel: string;\n\n /**\n * Specifies the icon to be displayed as Avatar.\n * Use `gen-ai` icon for AI assistants. By default `user-profile` icon is used.\n *\n * If you set both `iconName` and `initials`, `initials` will take precedence.\n */\n iconName?: IconProps.Name;\n\n /**\n * Specifies the URL of a custom icon. Use this property if the icon you want isn't available, and your custom icon can't be an SVG.\n * For SVG icons, use the `iconSvg` slot instead.\n *\n * If you set both `iconUrl` and `iconSvg`, `iconSvg` will take precedence.\n */\n iconUrl?: string;\n\n /**\n * Specifies the SVG of a custom icon.\n *\n * Use this property if the icon you want isn't available.\n * If you set both `iconUrl` and `iconSvg`, `iconSvg` will take precedence.\n */\n iconSvg?: React.ReactNode;\n}\n\nexport namespace AvatarProps {\n export type Color = \"default\" | \"gen-ai\";\n}\n\n// This is added here because cross package reference doesn't work in documenter and icon names are not populated\n// It'll be replaced by documenter implementation once documenter is updated to handle cross package reference\nnamespace IconProps {\n // Why not enums? Explained there\n // https://stackoverflow.com/questions/52393730/typescript-string-literal-union-type-from-enum\n export type Name =\n | \"add-plus\"\n | \"anchor-link\"\n | \"angle-left-double\"\n | \"angle-left\"\n | \"angle-right-double\"\n | \"angle-right\"\n | \"angle-up\"\n | \"angle-down\"\n | \"arrow-left\"\n | \"arrow-right\"\n | \"audio-full\"\n | \"audio-half\"\n | \"audio-off\"\n | \"bug\"\n | \"call\"\n | \"calendar\"\n | \"caret-down-filled\"\n | \"caret-down\"\n | \"caret-left-filled\"\n | \"caret-right-filled\"\n | \"caret-up-filled\"\n | \"caret-up\"\n | \"check\"\n | \"contact\"\n | \"close\"\n | \"copy\"\n | \"delete-marker\"\n | \"download\"\n | \"drag-indicator\"\n | \"edit\"\n | \"ellipsis\"\n | \"envelope\"\n | \"expand\"\n | \"external\"\n | \"file-open\"\n | \"file\"\n | \"filter\"\n | \"flag\"\n | \"folder-open\"\n | \"folder\"\n | \"gen-ai\"\n | \"group-active\"\n | \"group\"\n | \"heart\"\n | \"heart-filled\"\n | \"insert-row\"\n | \"key\"\n | \"keyboard\"\n | \"lock-private\"\n | \"menu\"\n | \"microphone\"\n | \"microphone-off\"\n | \"multiscreen\"\n | \"notification\"\n | \"redo\"\n | \"refresh\"\n | \"remove\"\n | \"resize-area\"\n | \"script\"\n | \"search\"\n | \"security\"\n | \"settings\"\n | \"send\"\n | \"share\"\n | \"shrink\"\n | \"star-filled\"\n | \"star-half\"\n | \"star\"\n | \"status-in-progress\"\n | \"status-info\"\n | \"status-negative\"\n | \"status-pending\"\n | \"status-positive\"\n | \"status-stopped\"\n | \"status-warning\"\n | \"subtract-minus\"\n | \"suggestions\"\n | \"thumbs-down-filled\"\n | \"thumbs-down\"\n | \"thumbs-up-filled\"\n | \"thumbs-up\"\n | \"ticket\"\n | \"treeview-collapse\"\n | \"treeview-expand\"\n | \"undo\"\n | \"unlocked\"\n | \"upload-download\"\n | \"upload\"\n | \"user-profile-active\"\n | \"user-profile\"\n | \"video-off\"\n | \"video-on\"\n | \"video-unavailable\"\n | \"view-full\"\n | \"view-horizontal\"\n | \"view-vertical\"\n | \"zoom-in\"\n | \"zoom-out\"\n | \"zoom-to-fit\";\n}\n"]}
1
+ {"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/avatar/interfaces.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nexport interface AvatarProps {\n /**\n * Determines the color of the avatar.\n * Use `gen-ai` for AI assistants and `default` otherwise.\n */\n color?: AvatarProps.Color;\n\n /**\n * The text content shown in the avatar's tooltip.\n *\n * When you use this property, make sure to include it in the `ariaLabel`.\n */\n tooltipText?: string;\n\n /**\n * The text content shown directly in the avatar's body.\n * Can be 1 or 2 symbols long, every subsequent symbol is ignored.\n * Use it to define initials that uniquely identify the avatar's owner.\n */\n initials?: string;\n\n /**\n * When set to true, a loading indicator is shown in avatar.\n */\n loading?: boolean;\n\n /**\n * Text to describe the avatar for assistive technology.\n * When more than one avatar is used, provide a unique label for each.\n * For example, \"Avatar of John Doe\" or \"Avatar of generative AI assistant\".\n *\n * If `tooltipText` is used make sure to include it in the `ariaLabel`.\n */\n ariaLabel: string;\n\n /**\n * Specifies the icon to be displayed as Avatar.\n * Use `gen-ai` icon for AI assistants. By default `user-profile` icon is used.\n *\n * If you set both `iconName` and `initials`, `initials` will take precedence.\n */\n iconName?: IconProps.Name;\n\n /**\n * Specifies the URL of a custom icon. Use this property if the icon you want isn't available, and your custom icon can't be an SVG.\n * For SVG icons, use the `iconSvg` slot instead.\n *\n * If you set both `iconUrl` and `iconSvg`, `iconSvg` will take precedence.\n */\n iconUrl?: string;\n\n /**\n * Specifies the SVG of a custom icon.\n *\n * Use this property if the icon you want isn't available.\n * If you set both `iconUrl` and `iconSvg`, `iconSvg` will take precedence.\n */\n iconSvg?: React.ReactNode;\n}\n\nexport namespace AvatarProps {\n export type Color = \"default\" | \"gen-ai\";\n}\n\n// This is added here because cross package reference doesn't work in documenter and icon names are not populated\n// It'll be replaced by documenter implementation once documenter is updated to handle cross package reference\nnamespace IconProps {\n // Why not enums? Explained there\n // https://stackoverflow.com/questions/52393730/typescript-string-literal-union-type-from-enum\n export type Name =\n | \"add-plus\"\n | \"anchor-link\"\n | \"angle-left-double\"\n | \"angle-left\"\n | \"angle-right-double\"\n | \"angle-right\"\n | \"angle-up\"\n | \"angle-down\"\n | \"arrow-left\"\n | \"arrow-right\"\n | \"audio-full\"\n | \"audio-half\"\n | \"audio-off\"\n | \"bug\"\n | \"call\"\n | \"calendar\"\n | \"caret-down-filled\"\n | \"caret-down\"\n | \"caret-left-filled\"\n | \"caret-right-filled\"\n | \"caret-up-filled\"\n | \"caret-up\"\n | \"check\"\n | \"contact\"\n | \"close\"\n | \"copy\"\n | \"delete-marker\"\n | \"download\"\n | \"drag-indicator\"\n | \"edit\"\n | \"ellipsis\"\n | \"envelope\"\n | \"expand\"\n | \"external\"\n | \"file-open\"\n | \"file\"\n | \"filter\"\n | \"flag\"\n | \"folder-open\"\n | \"folder\"\n | \"gen-ai\"\n | \"group-active\"\n | \"group\"\n | \"heart\"\n | \"heart-filled\"\n | \"insert-row\"\n | \"key\"\n | \"keyboard\"\n | \"lock-private\"\n | \"menu\"\n | \"microphone\"\n | \"microphone-off\"\n | \"multiscreen\"\n | \"notification\"\n | \"redo\"\n | \"refresh\"\n | \"remove\"\n | \"resize-area\"\n | \"script\"\n | \"search\"\n | \"security\"\n | \"settings\"\n | \"send\"\n | \"share\"\n | \"shrink\"\n | \"star-filled\"\n | \"star-half\"\n | \"star\"\n | \"status-in-progress\"\n | \"status-info\"\n | \"status-negative\"\n | \"status-pending\"\n | \"status-positive\"\n | \"status-stopped\"\n | \"status-warning\"\n | \"subtract-minus\"\n | \"suggestions\"\n | \"thumbs-down-filled\"\n | \"thumbs-down\"\n | \"thumbs-up-filled\"\n | \"thumbs-up\"\n | \"ticket\"\n | \"treeview-collapse\"\n | \"treeview-expand\"\n | \"undo\"\n | \"unlocked\"\n | \"upload-download\"\n | \"upload\"\n | \"user-profile-active\"\n | \"user-profile\"\n | \"video-off\"\n | \"video-on\"\n | \"video-unavailable\"\n | \"view-full\"\n | \"view-horizontal\"\n | \"view-vertical\"\n | \"zoom-in\"\n | \"zoom-out\"\n | \"zoom-to-fit\";\n}\n"]}
@@ -14,7 +14,7 @@ module.exports = {
14
14
  "name": "ariaLabel",
15
15
  "type": "string",
16
16
  "optional": false,
17
- "description": "Text to describe the avatar for assistive technology.\nWhen more than one avatar is used, provide a unique label for each.\nFor example, \"User avatar\" and \"AI assistant avatar\" or \"Your avatar\" and \"User avatar for John Doe\".\nIf `tooltipText` or `initials` are used make sure to include them in the `ariaLabel`.\n"
17
+ "description": "Text to describe the avatar for assistive technology.\nWhen more than one avatar is used, provide a unique label for each.\nFor example, \"Avatar of John Doe\" or \"Avatar of generative AI assistant\".\nIf `tooltipText` is used make sure to include it in the `ariaLabel`.\n"
18
18
  },
19
19
  {
20
20
  "name": "color",
@@ -153,7 +153,7 @@ module.exports = {
153
153
  "name": "initials",
154
154
  "type": "string",
155
155
  "optional": true,
156
- "description": "The text content shown directly in the avatar's body.\nCan be 1 or 2 symbols long, every subsequent symbol is ignored.\nUse it to define initials that uniquely identify the avatar's owner.\nWhen you use this property, make sure to include it in the `ariaLabel`.\n"
156
+ "description": "The text content shown directly in the avatar's body.\nCan be 1 or 2 symbols long, every subsequent symbol is ignored.\nUse it to define initials that uniquely identify the avatar's owner."
157
157
  },
158
158
  {
159
159
  "name": "loading",
@@ -1,4 +1,4 @@
1
1
  export var PACKAGE_SOURCE = "chat-components";
2
- export var PACKAGE_VERSION = "1.0.0 (2ebe8163)";
2
+ export var PACKAGE_VERSION = "1.0.0 (9a058bc4)";
3
3
  export var THEME = "open-source-visual-refresh";
4
4
  export var ALWAYS_VISUAL_REFRESH = true;
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "PACKAGE_SOURCE": "chat-components",
3
- "PACKAGE_VERSION": "1.0.0 (2ebe8163)",
3
+ "PACKAGE_VERSION": "1.0.0 (9a058bc4)",
4
4
  "THEME": "open-source-visual-refresh",
5
5
  "ALWAYS_VISUAL_REFRESH": true
6
6
  }
@@ -1,3 +1,3 @@
1
1
  {
2
- "commit": "2ebe8163ceaa3bbce65fe1f9e183d2ef9bfc1f1e"
2
+ "commit": "9a058bc4a1122922c965e2a3bf23fe5f662ef3c7"
3
3
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudscape-design/chat-components",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/cloudscape-design/chat-components.git"