lightning-base-components 1.18.1-alpha → 1.18.2-alpha

package/src/lightning/avatar/avatar.js

@@ -1,6 +1,7 @@
-import { LightningElement, api, track } from 'lwc';
+import { api, track } from 'lwc';
+import LightningShadowBaseClass from 'lightning/shadowBaseClassPrivate';
 import { classSet } from 'lightning/utils';
-import { classListMutation, normalizeString } from 'lightning/utilsPrivate';
+import { normalizeString, reflectAttribute } from 'lightning/utilsPrivate';
 import { computeSldsClass } from 'lightning/iconUtils';
 
 const DEFAULT_SIZE = 'medium';
@@ -9,7 +10,7 @@ const DEFAULT_VARIANT = 'square';
 /**
  * A visual representation of an object.
  */
-export default class LightningAvatar extends LightningElement {
+export default class LightningAvatar extends LightningShadowBaseClass {
     /**
      * The alternative text used to describe the avatar, which is displayed as
      * hover text on the image.
@@ -29,7 +30,14 @@ export default class LightningAvatar extends LightningElement {
      *
      * @type {string}
      */
-    @api fallbackIconName;
+    @api
+    set fallbackIconName(value) {
+        this._fallbackIconName = value;
+        reflectAttribute(this, 'icon-name', this._fallbackIconName);
+    }
+    get fallbackIconName() {
+        return this._fallbackIconName;
+    }
 
     /**
      * If the record name contains two words, like first and last name, use the
@@ -43,6 +51,7 @@ export default class LightningAvatar extends LightningElement {
 
     @track _size = DEFAULT_SIZE;
     @track _src = '';
+    @track _fallbackIconName = '';
     @track _variant = DEFAULT_VARIANT;
 
     /**
@@ -60,7 +69,7 @@ export default class LightningAvatar extends LightningElement {
             fallbackValue: DEFAULT_SIZE,
             validValues: ['x-small', 'small', 'medium', 'large'],
         });
-        this.updateClassList();
+        reflectAttribute(this, 'size', this._size);
     }
 
     /**
@@ -93,18 +102,13 @@ export default class LightningAvatar extends LightningElement {
             fallbackValue: DEFAULT_VARIANT,
             validValues: ['circle', 'square'],
         });
-        this.updateClassList();
+        reflectAttribute(this, 'variant', this._variant);
     }
 
-    connectedCallback() {
-        this.updateClassList();
-    }
-
-    // update custom element's classList
-    updateClassList() {
-        const size = this._size;
+    get computedClass() {
         const variant = this._variant;
-        const classes = classSet('slds-avatar')
+        const size = this._size;
+        return classSet('slds-avatar')
             .add({
                 'slds-avatar_x-small': size === 'x-small',
                 'slds-avatar_small': size === 'small',
@@ -114,7 +118,6 @@ export default class LightningAvatar extends LightningElement {
             .add({
                 'slds-avatar_circle': variant === 'circle',
             });
-        classListMutation(this.classList, classes);
     }
 
     get computedInitialsClass() {

package/src/lightning/avatar/avatar.slds.css

@@ -0,0 +1,272 @@
+/**
+ * @Note: Static fallbacks are in place until SLDS adopts SDS. Without static
+ *        fallbacks, styles will regress due to invalid CSS variables from
+ *        missing SLDS shared and globals.
+ *
+ *        Additionally, LBC are currently relying on 'part' attributes to
+ *        receive styling. Authoring styles that rely on slots is not recommended.
+ */
+
+@supports (--styling-hooks: '') {
+  :host([data-render-mode="shadow"][size~='xxx-small']) {
+    --slds-c-icon-sizing: var(--sds-g-sizing-3, 0.5rem);
+  }
+
+  :host([data-render-mode="shadow"][size~='xx-small']) {
+    --slds-c-icon-sizing: calc(var(--sds-g-sizing-1, 0.125rem) + var(--sds-g-sizing-4, 0.75rem));
+  }
+
+  :host([data-render-mode="shadow"][size~='x-small']) {
+    --slds-c-icon-sizing: var(--sds-g-sizing-5, 1rem);
+  }
+
+  :host([data-render-mode="shadow"][size~='small']) {
+    --slds-c-icon-sizing: var(--sds-g-sizing-7, 1.5rem);
+  }
+
+  :host([data-render-mode="shadow"][size~='large']) {
+    --slds-c-icon-sizing: var(--sds-g-sizing-10, 3rem);
+  }
+
+  :host([data-render-mode="shadow"][variant~='warning']) {
+    --slds-c-icon-color-foreground: var(--sds-g-color-warning-base-70, #fe9339);
+  }
+
+  :host([data-render-mode="shadow"][variant~='success']) {
+    --slds-c-icon-color-foreground: var(--sds-g-color-success-base-50, #2e844a);
+  }
+
+  :host([data-render-mode="shadow"][variant~='error']) {
+    --slds-c-icon-color-foreground: var(--sds-g-color-error-base-50, #ea001e);
+  }
+
+  :host([data-render-mode="shadow"][variant~='light']) {
+    --slds-c-icon-color-foreground: var(--sds-g-color-neutral-base-70, #aeaeae);
+  }
+
+  :host([data-render-mode="shadow"]) [part~='boundary'] {
+    /* --sds-c-icon-color-background: var(--slds-c-icon-color-background); */
+    --sds-c-icon-radius-border: var(--slds-c-icon-radius-border, var(--sds-g-radius-border-2, 0.25rem));
+    --sds-c-icon-sizing-border: var(--slds-c-icon-sizing-border);
+    --sds-c-icon-color-border: var(--slds-c-icon-color-border);
+    --sds-c-icon-spacing-block-start: var(
+      --slds-c-icon-spacing-block-start,
+      var(--slds-c-icon-spacing-block)
+    );
+    --sds-c-icon-spacing-block-end: var(--slds-c-icon-spacing-block-end, var(--slds-c-icon-spacing-block));
+    --sds-c-icon-spacing-inline-start: var(
+      --slds-c-icon-spacing-inline-start,
+      var(--slds-c-icon-spacing-inline)
+    );
+    --sds-c-icon-spacing-inline-end: var(--slds-c-icon-spacing-inline-end, var(--slds-c-icon-spacing-inline));
+
+    /**
+     * There's a divergence in LBC that we have to support here: LBC splits their
+     * icon implementation into two components: lightning-icon and lightning-primitive-icon.
+     * slds-icon is consumed within both with no issues except that the presence of an
+     * additional custom element (primitive-icon) creates an unexpected inline-level
+     * element and breaks our formatting context. tl;dr, we have to reset the formatting
+     * context of the boundary or else we'll inherit line-height from an ancestor and
+     * get visual regressions.
+     *
+     * If lightning-icon is refactored into a single component, this line can be removed.
+     */
+    display: inline-flex;
+  }
+
+  :host([data-render-mode="shadow"]) [part~='icon'] {
+    --sds-c-icon-color-foreground: var(--slds-c-icon-color-foreground, var(--sds-g-color-neutral-base-100, #ffffff));
+    --sds-c-icon-sizing-height: var(--slds-c-icon-sizing-height, var(--slds-c-icon-sizing, var(--sds-g-sizing-9, 2rem)));
+    --sds-c-icon-sizing-width: var(--slds-c-icon-sizing-width, var(--slds-c-icon-sizing, var(--sds-g-sizing-9, 2rem)));
+  }
+
+  :host([data-render-mode="shadow"][icon-name*='action']) {
+    --slds-c-icon-spacing-block: var(--sds-g-sizing-3, 0.5rem);
+    --slds-c-icon-spacing-inline: var(--sds-g-sizing-3, 0.5rem);
+    --slds-c-icon-radius-border: calc(var(--sds-g-radius-border-circle, 100%) / 2);
+  }
+}
+
+/**
+ * P R I V A T E
+ *
+ * The following styling is implemented by classes within the shadow DOM.
+ * They're expected to be private to the component and not for external use.
+ *
+ * See notes for each class for the rationale behind their inclusion.
+ */
+
+/**
+ * Utility icons traditionally added a class to change the default foreground
+ * color (white) to a grey. This was done implicitly whereas other color changes
+ * were done explicitly through the 'variant' attribute. So this is an outlier
+ * to the overall pattern. Leaving it as-is since an update would require an
+ * API change or more investigating.
+ *
+ * This is a hybrid patch between synthetic and native shadow. The ideal final
+ * outcome is the removal of this class and the default utility styling would
+ * be implemented through an attribute or some other class-less solution.
+ */
+
+:host([data-render-mode="shadow"]) .slds-icon-text-default {
+  /*! @css-var-fallback fill */
+  --slds-c-icon-color-foreground: var(
+    --slds-c-icon-color-foreground-default,
+    var(--sds-c-icon-color-foreground-default, var(
+      --sds-g-color-neutral-base-50, #747474))
+  );
+}
+
+:host([data-render-mode="shadow"]) .slds-icon-text-default.slds-is-disabled {
+  fill: var(--sds-g-color-neutral-base-80, #c9c9c9);
+}
+
+/**
+ * A temporarily baked-in utility class until SLDS gets a proper utility package.
+ *
+ * This is a hybrid patch between synthetic and native shadow. The ideal final
+ * outcome is the removal of this class and replacing the class with the SLDS
+ * utility package solution.
+ */
+
+:host([data-render-mode="shadow"]) .slds-assistive-text {
+  position: absolute !important;
+  margin: -1px !important;
+  border: 0 !important;
+  padding: 0 !important;
+  width: 1px !important;
+  height: 1px !important;
+  overflow: hidden !important;
+  clip: rect(0 0 0 0) !important;
+  text-transform: none !important;
+  white-space: nowrap !important;
+}
+
+/**
+ * For the initial alpha version, we're hardcoding in the various unique icon styles.
+ *
+ * Next version, we want to dynamically generate these from legacy SLDS with the
+ * following design pattern:
+ *
+ * [type="action"][icon-name="approval"] {
+ *   --sds-c-icon-color-background: var(--slds-c-icon-color-background, #111);
+ * }
+ */
+
+:host([data-render-mode="shadow"]) .slds-icon_disabled {
+  background-color: currentColor;
+}
+
+:host([data-render-mode="shadow"]) .slds-input__icon {
+  --slds-c-icon-sizing: calc(var(--sds-g-sizing-1, 0.125rem) + var(--sds-g-sizing-4, 0.75rem));
+  
+  position: absolute;
+  top: 50%;
+  margin-block-start: -0.4375rem;
+  line-height: var(--sds-g-font-lineheight-1, 1);
+  border: 0;
+  z-index: 2;
+}
+
+/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved
+  Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */
+
+@supports (--styling-hooks: '') {
+  :host([data-render-mode="shadow"]) .slds-assistive-text {
+    position: absolute !important;
+    margin: -1px !important;
+    border: 0 !important;
+    padding: 0 !important;
+    width: 1px !important;
+    height: 1px !important;
+    overflow: hidden !important;
+    clip: rect(0 0 0 0) !important;
+    text-transform: none !important;
+    white-space: nowrap !important;
+  }
+
+  :host([data-render-mode="shadow"]) [part~='avatar'] {
+    width: var(--slds-c-avatar-sizing, var(--sds-g-sizing-9, 2rem));
+    height: var(--slds-c-avatar-sizing, var(--sds-g-sizing-9, 2rem));
+    overflow: hidden;
+    display: inline-block;
+    vertical-align: middle;
+    border-radius: var(--slds-c-avatar-radius-border, var(--sds-g-radius-border-2, 0.25rem));
+    line-height: var(--sds-g-font-lineheight-1, 1);
+    font-size: var(--sds-g-font-scale-neg-1, 0.875rem);
+    color: var(--slds-c-avatar-text-color, var(--sds-g-color-neutral-base-100, #ffffff));
+  }
+
+  :host([data-render-mode="shadow"][size='x-small']) [part~='avatar'] {
+    width: var(--sds-g-sizing-6, 1.25rem);
+    height: var(--sds-g-sizing-6, 1.25rem);
+    font-size: var(--sds-g-font-scale-neg-4, 0.625rem);
+    --slds-c-icon-sizing: var(--sds-g-sizing-6, 1.25rem);
+  }
+
+  :host([data-render-mode="shadow"][size='small']) [part~='avatar'] {
+    width: var(--sds-g-sizing-7, 1.5rem);
+    height: var(--sds-g-sizing-7, 1.5rem);
+    font-size: var(--sds-g-font-scale-neg-4, 0.625rem);
+    --slds-c-icon-sizing: var(--sds-g-sizing-7, 1.5rem);
+  }
+
+  :host([data-render-mode="shadow"][size='medium']) [part~='avatar'] {
+    width: var(--sds-g-sizing-9, 2rem);
+    height: var(--sds-g-sizing-9, 2rem);
+    font-size: var(--sds-g-font-scale-neg-1, 0.875rem);
+    --slds-c-icon-sizing: var(--sds-g-sizing-9, 2rem);
+  }
+
+  :host([data-render-mode="shadow"][size='large']) [part~='avatar'] {
+    width: var(--sds-g-sizing-10, 3rem);
+    height: var(--sds-g-sizing-10, 3rem);
+    font-size: var(--sds-g-font-scale-1, 1.125rem);
+    line-height: var(--sds-g-font-lineheight-2, 1.25);
+    --slds-c-icon-sizing: var(--sds-g-sizing-10, 3rem);
+  }
+
+  :host([data-render-mode="shadow"][variant='circle']) [part~='avatar'] {
+    border-radius: calc(var(--sds-g-radius-border-circle, 100%) / 2);
+  }
+
+  :host([data-render-mode="shadow"].slds-avatar_empty) [part~='avatar'] {
+    border: var(--sds-g-sizing-border-1, 1px) dashed var(--sds-g-color-neutral-base-90, #e5e5e5);
+  }
+
+  :host([data-render-mode="shadow"]) lightning-icon {
+    display: flex;
+    justify-content: center;
+  }
+
+  :host([data-render-mode="shadow"]) .slds-avatar__initials {
+    display: flex;
+    justify-content: center;
+    -ms-flex-line-pack: center;
+    align-content: center;
+    align-items: center;
+    margin: auto;
+    color: var(--slds-c-avatar-text-color);
+    height: 100%;
+    text-shadow: 0 0 1px rgba(0, 0, 0, 0.8);
+    /* stylelint-disable sds-stylelint-plugin/styling-hooks-pattern */
+    background-color: var(
+      --slds-c-avatar-color-background,
+      var(--sds-c-icon-color-background, var(--sds-g-color-brand-base-50, #0176d3))
+    );
+    /* stylelint-enable sds-stylelint-plugin/styling-hooks-pattern */
+  }
+
+  :host([data-render-mode="shadow"]) .slds-avatar__initials[title] {
+    cursor: default;
+    text-decoration: none;
+  }
+
+  /* inverse is not currently supported by LBC */
+  :host([data-render-mode="shadow"]) .slds-avatar__initials_inverse {
+    --slds-c-avatar-text-color: var(--slds-c-avatar-inverse-text-color, var(--sds-g-color-neutral-base-30, #444444));
+
+    background-color: var(--sds-g-color-neutral-base-95, #f3f3f3);
+    text-shadow: none;
+  }
+}