Skip to content

Commit d77e3ef

Browse files
authored
chore: Add descriptions for style API (#111)
* chore: Add descriptions for style API * chore: Add sentence linking to style tab
1 parent f4e982f commit d77e3ef

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

src/__tests__/__snapshots__/documenter.test.ts.snap

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ Use it to define initials that uniquely identify the avatar's owner.",
7878
"type": "boolean",
7979
},
8080
{
81+
"description": "An object containing CSS properties to customize the avatar's visual appearance.
82+
Refer to the [style](/components/avatar/?tabId=style) tab for more details.",
8183
"inlineType": {
8284
"name": "AvatarProps.Style",
8385
"properties": [
@@ -216,6 +218,8 @@ If avatar is being used, set its \`loading\` state to true.",
216218
"type": "boolean",
217219
},
218220
{
221+
"description": "An object containing CSS properties to customize the chat bubble's visual appearance.
222+
Refer to the [style](/components/chat-bubble/?tabId=style) tab for more details.",
219223
"inlineType": {
220224
"name": "ChatBubbleProps.Style",
221225
"properties": [

src/avatar/interfaces.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ export interface AvatarProps {
6363
imgUrl?: string;
6464

6565
/**
66+
* An object containing CSS properties to customize the avatar's visual appearance.
67+
* Refer to the [style](/components/avatar/?tabId=style) tab for more details.
6668
* @awsuiSystem core
6769
*/
6870
style?: AvatarProps.Style;

src/chat-bubble/interfaces.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface ChatBubbleProps {
3333
hideAvatar?: boolean;
3434

3535
/**
36+
* An object containing CSS properties to customize the chat bubble's visual appearance.
37+
* Refer to the [style](/components/chat-bubble/?tabId=style) tab for more details.
3638
* @awsuiSystem core
3739
*/
3840
style?: ChatBubbleProps.Style;

0 commit comments

Comments
 (0)