Skip to content

Commit ab83ac9

Browse files
authored
docs(ui5-avatar-group): comment on the avatars' shape (#2798)
Make clear that the avatars with "Circle" shape is the one Fiori 3 suggests and meant to be used. FIXES: #2612
1 parent 6f82e42 commit ab83ac9

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

packages/main/src/AvatarGroup.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,11 @@ const metadata = {
100100
},
101101
slots: /** @lends sap.ui.webcomponents.main.AvatarGroup.prototype */ {
102102
/**
103-
* Defines the items of the <code>ui5-avatar-group</code>.
103+
* Defines the items of the <code>ui5-avatar-group</code>. Use the <code>ui5-avatar</code> component as an item.
104+
* <br><br>
105+
* <b>Note:</b> The UX guidelines recommends using avatars with "Circle" shape.
106+
* Moreover, if you use avatars with "Square" shape, there will be visual inconsistency
107+
* as the built-in overflow action has "Circle" shape.
104108
* @type {HTMLElement[]}
105109
* @slot
106110
* @public
@@ -120,7 +124,7 @@ const metadata = {
120124
* @public
121125
* @since 1.0.0-rc.11
122126
*/
123-
click: {
127+
click: {
124128
detail: {
125129
targetRef: { type: HTMLElement },
126130
overflowButtonClicked: { type: Boolean },

packages/main/test/pages/Avatar.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ <h3>Avatar - Basic sample</h3>
2323
<ui5-avatar image="./img/John_Miller.png"></ui5-avatar>
2424
</section>
2525

26-
<section>
27-
<h3>Avatar - special characters in image path</h3>
28-
<ui5-avatar image="./img/John$$$ ' (_)Miller 100%25 &=.png" style="border: 1px dashed red;"></ui5-avatar>
29-
<ui5-avatar image="./img/John Miller.png" style="border: 1px dashed red;"></ui5-avatar>
30-
<ui5-avatar image="./img/John%20Miller.png" style="border: 1px dashed red;"></ui5-avatar>
31-
<ui5-avatar image="https://upload.wikimedia.org/wikipedia/commons/5/59/SAP_2011_logo.svg" style="border: 1px dashed red;"></ui5-avatar>
32-
</section>
26+
<section>
27+
<h3>Avatar - special characters in image path</h3>
28+
<ui5-avatar image="./img/John$$$ ' (_)Miller 100%25 &=.png" style="border: 1px dashed red;"></ui5-avatar>
29+
<ui5-avatar image="./img/John Miller.png" style="border: 1px dashed red;"></ui5-avatar>
30+
<ui5-avatar image="./img/John%20Miller.png" style="border: 1px dashed red;"></ui5-avatar>
31+
<ui5-avatar image="https://upload.wikimedia.org/wikipedia/commons/5/59/SAP_2011_logo.svg" style="border: 1px dashed red;"></ui5-avatar>
32+
</section>
3333

3434
<section>
3535
<h3>Avatar - Square [ XS, S, M, L, XL ]</h3>

0 commit comments

Comments
 (0)