Skip to content

docs(ui5-avatar): update Avatar component and documentation#13136

Merged
plamenivanov91 merged 2 commits intomainfrom
avatar-samples-update
Feb 27, 2026
Merged

docs(ui5-avatar): update Avatar component and documentation#13136
plamenivanov91 merged 2 commits intomainfrom
avatar-samples-update

Conversation

@plamenivanov91
Copy link
Contributor

Changes

Documentation Update

  • Updated Avatar badge slot JSDoc to recommend (not require) interactive mode
  • Added note: "Badges are recommended on interactive avatars for better UX and accessibility"
  • Maintains backwards compatibility - badges work on non-interactive avatars as fallback

Sample Updates

  • WithBadge sample: Updated all avatars to use mode="Interactive"
  • AvatarBadge samples: Updated Basic and ValueStates samples to use mode="Interactive"
  • Interactive sample: Uses mode="Interactive" API (deprecated interactive attr noted)

New Variant Sample

  • Created comprehensive "Variants" sample showcasing all Avatar use cases:
    • Non-interactive avatars (decorative)
    • Interactive avatars
    • Interactive avatars with badges (recommended)
    • Interactive avatars with popup menus
    • Decorative avatars (hidden from screen readers)
  • Includes accessibility annotations for each variant
  • Updated Avatar.mdx to include new Variants section after "With Badge"

Related Issue

Addresses BLI: [ui5-avatar] Samples update - reflects updated screen reader annotations and design specifications

Notes

  • All changes follow Conventional Commits specification
  • No breaking changes - fully backwards compatible
  • Samples now properly demonstrate recommended usage patterns

@ui5-webcomponents-bot
Copy link
Collaborator

ui5-webcomponents-bot commented Feb 24, 2026

🧹 Preview deployment cleaned up: https://pr-13136--ui5-webcomponents.netlify.app

@ui5-webcomponents-bot ui5-webcomponents-bot temporarily deployed to preview February 24, 2026 16:36 Inactive
@ui5-webcomponents-bot ui5-webcomponents-bot temporarily deployed to preview February 24, 2026 16:47 Inactive
@plamenivanov91 plamenivanov91 changed the title fix(ui5-avatar): update Avatar component and documentation docs(ui5-avatar): update Avatar component and documentation Feb 27, 2026
@plamenivanov91 plamenivanov91 merged commit 85c6c73 into main Feb 27, 2026
21 of 22 checks passed
@plamenivanov91 plamenivanov91 deleted the avatar-samples-update branch February 27, 2026 13:46
@ui5-webcomponents-bot ui5-webcomponents-bot temporarily deployed to preview February 27, 2026 13:47 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants