Skip to content

refactor(ui5-avatar): rename backgroundColor property to colorScheme #3222

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
merged 6 commits into from
May 18, 2021
Merged

refactor(ui5-avatar): rename backgroundColor property to colorScheme #3222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
92b003d
chore(ui5-avatar): rename backgroundColor property to backgroundDesign
fifoosid May 11, 2021
0e00a74
fix typo
fifoosid May 11, 2021
a80e9a4
fix build
fifoosid May 11, 2021
102b482
fix comments
fifoosid May 13, 2021
7512f36
Merge branch 'master' into avatar-background-design
fifoosid May 17, 2021
efb9222
fix failing tests
fifoosid May 17, 2021
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
18 changes: 9 additions & 9 deletions packages/main/src/Avatar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import Icon from "./Icon.js";
import AvatarSize from "./types/AvatarSize.js";
import AvatarShape from "./types/AvatarShape.js";
import AvatarFitType from "./types/AvatarFitType.js";
import AvatarBackgroundColor from "./types/AvatarBackgroundColor.js";
import AvatarColorScheme from "./types/AvatarColorScheme.js";

/**
* @public
Expand Down Expand Up @@ -150,7 +150,7 @@ const metadata = {
},

/**
* Defines the background color of the desired image.
* Defines the background color of the content.
* <br><br>
* Available options are:
* <ul>
Expand All @@ -166,21 +166,21 @@ const metadata = {
* <li><code>Accent10</code></li>
* <li><code>Placeholder</code></li>
* </ul>
* @type {AvatarBackgroundColor}
* @type {AvatarColorScheme}
* @defaultvalue "Accent6"
* @public
*/
backgroundColor: {
type: AvatarBackgroundColor,
defaultValue: AvatarBackgroundColor.Accent6,
colorScheme: {
type: AvatarColorScheme,
defaultValue: AvatarColorScheme.Accent6,
},

/**
* @private
*/
_backgroundColor: {
_colorScheme: {
type: String,
defaultValue: AvatarBackgroundColor.Accent6,
defaultValue: AvatarColorScheme.Accent6,
},

/**
Expand Down Expand Up @@ -314,7 +314,7 @@ class Avatar extends UI5Element {
*/
get _effectiveBackgroundColor() {
// we read the attribute, because the "background-color" property will always have a default value
return this.getAttribute("background-color") || this._backgroundColor;
return this.getAttribute("_color-scheme") || this._colorScheme;
}

get _role() {
Expand Down
8 changes: 4 additions & 4 deletions packages/main/src/AvatarGroup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import AvatarGroupCss from "./generated/themes/AvatarGroup.css.js";
import Button from "./Button.js";
import AvatarSize from "./types/AvatarSize.js";
import AvatarGroupType from "./types/AvatarGroupType.js";
import AvatarBackgroundColor from "./types/AvatarBackgroundColor.js";
import AvatarColorScheme from "./types/AvatarColorScheme.js";

const OVERFLOW_BTN_CLASS = "ui5-avatar-group-overflow-btn";
const AVATAR_GROUP_OVERFLOW_BTN_SELECTOR = `.${OVERFLOW_BTN_CLASS}`;
Expand Down Expand Up @@ -309,7 +309,7 @@ class AvatarGroup extends UI5Element {
}

/**
* Returns an array containing the <code>AvatarBackgroundColor</code> values that correspond to the avatars in the <code>ui5-avatar-group</code>.
* Returns an array containing the <code>AvatarColorScheme</code> values that correspond to the avatars in the <code>ui5-avatar-group</code>.
* @readonly
* @type { Array }
* @defaultValue []
Expand Down Expand Up @@ -498,9 +498,9 @@ class AvatarGroup extends UI5Element {
const colorIndex = this._getNextBackgroundColor();
avatar.interactive = !this._isGroup;

if (!avatar.getAttribute("background-color")) {
if (!avatar.getAttribute("_color-scheme")) {
// AvatarGroup respects colors set to ui5-avatar
avatar.setAttribute("_background-color", AvatarBackgroundColor[`Accent${colorIndex}`]);
avatar.setAttribute("_color-scheme", AvatarColorScheme[`Accent${colorIndex}`]);
}

if (!avatar.getAttribute("size")) {
Expand Down
44 changes: 22 additions & 22 deletions packages/main/src/themes/Avatar.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,58 +119,58 @@
background-color: var(--ui5-avatar-accent6);
}

:host([_background-color="Accent1"]),
:host([background-color="Accent1"]) {
:host([_color-scheme="Accent1"]),
:host([color-scheme="Accent1"]) {
background-color: var(--ui5-avatar-accent1);
}

:host([_background-color="Accent2"]),
:host([background-color="Accent2"]) {
:host([_color-scheme="Accent2"]),
:host([color-scheme="Accent2"]) {
background-color: var(--ui5-avatar-accent2);
}

:host([_background-color="Accent3"]),
:host([background-color="Accent3"]) {
:host([_color-scheme="Accent3"]),
:host([color-scheme="Accent3"]) {
background-color: var(--ui5-avatar-accent3);
}

:host([_background-color="Accent4"]),
:host([background-color="Accent4"]) {
:host([_color-scheme="Accent4"]),
:host([color-scheme="Accent4"]) {
background-color: var(--ui5-avatar-accent4);
}

:host([_background-color="Accent5"]),
:host([background-color="Accent5"]) {
:host([_color-scheme="Accent5"]),
:host([color-scheme="Accent5"]) {
background-color: var(--ui5-avatar-accent5);
}

:host([_background-color="Accent6"]),
:host([background-color="Accent6"]) {
:host([_color-scheme="Accent6"]),
:host([color-scheme="Accent6"]) {
background-color: var(--ui5-avatar-accent6);
}

:host([_background-color="Accent7"]),
:host([background-color="Accent7"]) {
:host([_color-scheme="Accent7"]),
:host([color-scheme="Accent7"]) {
background-color: var(--ui5-avatar-accent7);
}

:host([_background-color="Accent8"]),
:host([background-color="Accent8"]) {
:host([_color-scheme="Accent8"]),
:host([color-scheme="Accent8"]) {
background-color: var(--ui5-avatar-accent8);
}

:host([_background-color="Accent9"]),
:host([background-color="Accent9"]) {
:host([_color-scheme="Accent9"]),
:host([color-scheme="Accent9"]) {
background-color: var(--ui5-avatar-accent9);
}

:host([_background-color="Accent10"]),
:host([background-color="Accent10"]) {
:host([_color-scheme="Accent10"]),
:host([color-scheme="Accent10"]) {
background-color: var(--ui5-avatar-accent10);
}

:host([_background-color="Placeholder"]),
:host([background-color="Placeholder"]) {
:host([_color-scheme="Placeholder"]),
:host([color-scheme="Placeholder"]) {
background-color: var(--ui5-avatar-placeholder);
}

Expand Down
18 changes: 9 additions & 9 deletions ...s/main/src/types/AvatarBackgroundColor.js → packages/main/src/types/AvatarColorScheme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import DataType from "@ui5/webcomponents-base/dist/types/DataType.js";

/**
* Different types of AvatarBackgroundColor.
* @lends sap.ui.webcomponents.main.types.AvatarBackgroundColor.prototype
* Different types of AvatarColorSchemes.
* @lends sap.ui.webcomponents.main.types.AvatarColorScheme.prototype
* @public
*/
const AvatarBackGroundColors = {
const AvatarColorSchemes = {
/**
*
* @public
Expand Down Expand Up @@ -86,19 +86,19 @@ const AvatarBackGroundColors = {

/**
* @class
* Different types of AvatarBackgroundColor.
* Different types of AvatarColorScheme.
* @constructor
* @author SAP SE
* @alias sap.ui.webcomponents.main.types.AvatarBackgroundColor
* @alias sap.ui.webcomponents.main.types.AvatarColorScheme
* @public
* @enum {string}
*/
class AvatarBackgroundColor extends DataType {
class AvatarColorScheme extends DataType {
static isValid(value) {
return !!AvatarBackGroundColors[value];
return !!AvatarColorSchemes[value];
}
}

AvatarBackgroundColor.generateTypeAccessors(AvatarBackGroundColors);
AvatarColorScheme.generateTypeAccessors(AvatarColorSchemes);

export default AvatarBackgroundColor;
export default AvatarColorScheme;
38 changes: 19 additions & 19 deletions packages/main/test/pages/Avatar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,31 @@ <h3>Avatar - UI5 Icons</h3>

<section>
<h3>Avatar - Background colors [ Accent1, Accent2, Accent3, Accent4, Accent5, Accent6, Accent7, Accent8, Accent9, Accent10, Placeholder ]</h3>
<ui5-avatar background-color="Accent1" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent2" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent3" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent4" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent5" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent1" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent2" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent3" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent4" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent5" size="L"></ui5-avatar>
<ui5-avatar size="L"></ui5-avatar>
<ui5-avatar background-color="Accent7" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent8" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent9" size="L"></ui5-avatar>
<ui5-avatar background-color="Accent10" size="L"></ui5-avatar>
<ui5-avatar background-color="Placeholder" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent7" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent8" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent9" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Accent10" size="L"></ui5-avatar>
<ui5-avatar color-scheme="Placeholder" size="L"></ui5-avatar>
</section>

<section>
<h3>Avatar - Initials</h3>
<ui5-avatar initials="XS" background-color="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" background-color="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" background-color="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" background-color="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" background-color="Accent5" size="XL"></ui5-avatar>
<ui5-avatar initials="XS" color-scheme="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" color-scheme="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" color-scheme="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" color-scheme="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" color-scheme="Accent5" size="XL"></ui5-avatar>
<ui5-avatar initials="XS" shape="Square" size="XS"></ui5-avatar>
<ui5-avatar initials="S" background-color="Accent7" shape="Square" size="S"></ui5-avatar>
<ui5-avatar initials="M" background-color="Accent8" shape="Square" size="M"></ui5-avatar>
<ui5-avatar initials="L" background-color="Accent9" shape="Square" size="L"></ui5-avatar>
<ui5-avatar initials="XL" background-color="Accent10" shape="Square" size="XL"></ui5-avatar>
<ui5-avatar initials="S" color-scheme="Accent7" shape="Square" size="S"></ui5-avatar>
<ui5-avatar initials="M" color-scheme="Accent8" shape="Square" size="M"></ui5-avatar>
<ui5-avatar initials="L" color-scheme="Accent9" shape="Square" size="L"></ui5-avatar>
<ui5-avatar initials="XL" color-scheme="Accent10" shape="Square" size="XL"></ui5-avatar>
</section>

<section>
Expand Down
6 changes: 3 additions & 3 deletions packages/main/test/pages/AvatarGroup.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,15 +294,15 @@ <h3>AvatarGroup with user defined overflow button</h3>
hiddenItems.forEach(function (avatar, index) {
var color = avatarGroup.colorScheme[firstHiddenIndex + index]
html += '<div class="avatar-slot" style="padding: 5px">' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" background-color="' + color + '"></ui5-avatar>' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" color-scheme="' + color + '"></ui5-avatar>' +
'</div>';
});

for (var index = 0; index < hiddenItems; index++) {
var avatarRef = items[index];

html += '<div class="avatar-slot">' +
'<ui5-avatar interactive image="' + avatarRef.image + '" initials="' + avatarRef.initials + '" background-color="' + avatarRef._effectiveBackgroundColor + '"></ui5-avatar>' +
'<ui5-avatar interactive image="' + avatarRef.image + '" initials="' + avatarRef.initials + '" color-scheme="' + avatarRef._effectiveBackgroundColor + '"></ui5-avatar>' +
'</div>';
}
placeholder.innerHTML = html;
Expand All @@ -314,7 +314,7 @@ <h3>AvatarGroup with user defined overflow button</h3>
function onAvatarClicked(avatarGroup, avatarRef) {
popAvatar.image = avatarRef.image;
popAvatar.initials = avatarRef.initials;
popAvatar.backgroundColor = avatarGroup.colorScheme[avatarGroup.items.indexOf(avatarRef)];
popAvatar.colorScheme = avatarGroup.colorScheme[avatarGroup.items.indexOf(avatarRef)];

individualPop.close();
individualPop.openBy(avatarRef);
Expand Down
20 changes: 10 additions & 10 deletions packages/main/test/samples/Avatar.sample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,18 @@ <h4>Avatar with UI5 Icons</h4>
<section>
<h4>Avatar with Initials</h4>
<div class="snippet">
<ui5-avatar initials="XS" background-color="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" background-color="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" background-color="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" background-color="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" background-color="Accent5" size="XL"></ui5-avatar>
<ui5-avatar initials="XS" color-scheme="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" color-scheme="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" color-scheme="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" color-scheme="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" color-scheme="Accent5" size="XL"></ui5-avatar>
</div>
<pre class="prettyprint lang-html"><xmp>
<ui5-avatar initials="XS" background-color="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" background-color="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" background-color="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" background-color="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" background-color="Accent5" size="XL"></ui5-avatar>
<ui5-avatar initials="XS" color-scheme="Accent1" size="XS"></ui5-avatar>
<ui5-avatar initials="S" color-scheme="Accent2" size="S"></ui5-avatar>
<ui5-avatar initials="M" color-scheme="Accent3" size="M"></ui5-avatar>
<ui5-avatar initials="L" color-scheme="Accent4" size="L"></ui5-avatar>
<ui5-avatar initials="XL" color-scheme="Accent5" size="XL"></ui5-avatar>
</xmp></pre>
</section>

Expand Down
8 changes: 4 additions & 4 deletions packages/main/test/samples/AvatarGroup.sample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ <h4>Avatar Group - type "Individual"</h4>
function onAvatarClicked(avatarRef) {
const avatarIndex = avatarGroup.items.indexOf(avatarRef);

popAvatar.backgroundColor = avatarGroup.colorScheme[avatarIndex];
popAvatar.colorScheme = avatarGroup.colorScheme[avatarIndex];
popAvatar.initials = avatarRef.initials;
popAvatar.image = avatarRef.image;
popAvatar.icon = avatarRef.icon;
Expand All @@ -81,7 +81,7 @@ <h4>Avatar Group - type "Individual"</h4>
const color = avatarGroup.colorScheme[firstHiddenIndex + index];

html += '<div class="avatar-slot" style="padding: 5px">' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" background-color="' + color + '"></ui5-avatar>' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" color-scheme="' + color + '"></ui5-avatar>' +
'</div>';
});

Expand Down Expand Up @@ -143,7 +143,7 @@ <h4>Avatar Group - type "Individual"</h4>
avatarGroup.hiddenItems.forEach((avatar, index) => {
html += `<ui5-avatar
...
background-color="${avatarGroup.colorScheme[firstHiddenIndex + index]}"
color-scheme="${avatarGroup.colorScheme[firstHiddenIndex + index]}"
</ui5-avatar>`;
});

Expand Down Expand Up @@ -206,7 +206,7 @@ <h4>Avatar Group - type "Group"</h4>
const avatarColor = avatarGroup.colorScheme[index];

html += '<div class="avatar-slot" style="padding: 3px">' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" background-color="' + avatarColor + '"></ui5-avatar>' +
'<ui5-avatar interactive icon="' + avatar.icon + '" image="' + avatar.image + '" initials="' + avatar.initials + '" color-scheme="' + avatarColor + '"></ui5-avatar>' +
'</div>';
});

Expand Down
6 changes: 3 additions & 3 deletions packages/main/test/specs/AvatarGroup.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,19 @@ describe("avatar-group rendering", () => {
});
});

it("tests if _background-color attribute is automatically set to avatars", () => {
it("tests if _background-design attribute is automatically set to avatars", () => {
const avatars = browser.$$("#avatar-group-group ui5-avatar");

let index = 0;

avatars.forEach(avatar => {
const avatarBackgroundColor = avatar.getAttribute("_background-color");
const avatarBackgroundColor = avatar.getAttribute("_color-scheme");

if (++index > 10) {
index = 1;
}

assert.strictEqual(avatarBackgroundColor, `Accent${index}`, "AvatarGroup avatar-size property is assigned to avatars _size property");
assert.strictEqual(avatarBackgroundColor, `Accent${index}`, "AvatarGroup _color-scheme property is assigned to avatars _size property");
});
});

Expand Down