Skip to content

chore: Add descriptions for style API #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkuelz merged 2 commits into from
Feb 16, 2026
Merged

chore: Add descriptions for style API #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4487df0
chore: Add descriptions for style API
jkuelz Feb 14, 2026
c3b886d
chore: Add sentence linking to style tab
jkuelz Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/__tests__/__snapshots__/documenter.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Use it to define initials that uniquely identify the avatar's owner.",
"type": "boolean",
},
{
"description": "An object containing CSS properties to customize the avatar's visual appearance.
Refer to the [style](/components/avatar/?tabId=style) tab for more details.",
"inlineType": {
"name": "AvatarProps.Style",
"properties": [
Expand Down Expand Up @@ -216,6 +218,8 @@ If avatar is being used, set its \`loading\` state to true.",
"type": "boolean",
},
{
"description": "An object containing CSS properties to customize the chat bubble's visual appearance.
Refer to the [style](/components/chat-bubble/?tabId=style) tab for more details.",
"inlineType": {
"name": "ChatBubbleProps.Style",
"properties": [
Expand Down
2 changes: 2 additions & 0 deletions src/avatar/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ export interface AvatarProps {
imgUrl?: string;

/**
* An object containing CSS properties to customize the avatar's visual appearance.
* Refer to the [style](/components/avatar/?tabId=style) tab for more details.
* @awsuiSystem core
*/
style?: AvatarProps.Style;
Expand Down
2 changes: 2 additions & 0 deletions src/chat-bubble/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface ChatBubbleProps {
hideAvatar?: boolean;

/**
* An object containing CSS properties to customize the chat bubble's visual appearance.
* Refer to the [style](/components/chat-bubble/?tabId=style) tab for more details.
* @awsuiSystem core
*/
style?: ChatBubbleProps.Style;
Expand Down
Loading