@cfpb/cfpb-design-system 4.2.4 → 4.3.1

package/src/elements/cfpb-expandable/cfpb-expandable.component.scss

@@ -0,0 +1,218 @@
+@use 'sass:math';
+@use '@cfpb/cfpb-design-system/src/elements/abstracts' as *;
+@use '@cfpb/cfpb-design-system/src/elements/base' as *;
+@use '@cfpb/cfpb-design-system/src/utilities' as *;
+@use '../cfpb-utilities/transition/transition.scss' as *;
+
+:host {
+  // Theme
+
+  --expandable-border: var(--gray-40);
+
+  .cf-icon-svg {
+    height: 1.1875em;
+    vertical-align: middle;
+    fill: currentcolor;
+  }
+
+  // Overide heading defaults.
+  ::slotted([slot='header']) {
+    margin-bottom: 0 !important;
+    color: var(--black) !important;
+    font-weight: 500 !important;
+
+    // h4 size.
+    font-size: math.div(18px, $base-font-size-px) + em !important;
+
+    // Mobile only.
+    @include respond-to-max($bp-xs-max) {
+      font-size: math.div(16px, $base-font-size-px) + em !important;
+    }
+
+    .o-expandable--padded {
+      // h2 size.
+      font-size: math.div(26px, $base-font-size-px) + em !important;
+
+      // Mobile only.
+      @include respond-to-max($bp-xs-max) {
+        font-size: math.div(22px, $base-font-size-px) + em !important;
+      }
+    }
+  }
+
+  //
+  // Recommended expandable pattern
+  //
+
+  .o-expandable {
+    position: relative;
+
+    //
+    // Header
+    //
+
+    &__header {
+      display: flex;
+      justify-content: space-between;
+      gap: 10px;
+      padding: math.div(10px, $base-font-size-px) + em
+        math.div(15px, $base-font-size-px) + em;
+      border: 0;
+      background-color: transparent;
+      cursor: pointer;
+
+      &:focus {
+        outline: 1px dotted var(--black);
+        outline-offset: 2px;
+      }
+
+      .o-expandable__cue-close,
+      .o-expandable__cue-open {
+        display: none;
+      }
+
+      &[aria-expanded='false'] .o-expandable__cue-open {
+        display: block;
+      }
+
+      &[aria-expanded='true'] .o-expandable__cue-close {
+        display: block;
+      }
+    }
+
+    // Using the button element with .o-expandable__header requires setting
+    // an explicit width.
+    button.o-expandable__header {
+      width: 100%;
+      text-align: left;
+    }
+
+    //
+    // Expandable text elements
+    //
+
+    &__label {
+      // Grow to available width.
+      flex-grow: 1;
+    }
+
+    &__icon,
+    &__label {
+      // h4 size.
+      font-size: math.div(18px, $base-font-size-px) + em !important;
+
+      // Mobile only.
+      @include respond-to-max($bp-xs-max) {
+        font-size: math.div(16px, $base-font-size-px) + em !important;
+      }
+    }
+
+    &__cues {
+      align-self: center;
+      color: var(--pacific);
+      font-size: math.div(16px, $base-font-size-px) + em;
+      line-height: math.div($base-line-height-px, $base-font-size-px);
+    }
+
+    &__content {
+      padding: math.div(15px, $base-font-size-px) + em;
+      padding-top: 0;
+
+      // The divider between __header and __content.
+      &::before {
+        content: '';
+        display: block;
+        border-top: 1px solid var(--expandable-border);
+        padding-top: math.div(15px, $base-font-size-px) + em;
+      }
+
+      &::after {
+        padding-bottom: math.div(15px, $base-font-size-px) + em;
+        width: 100%;
+      }
+    }
+
+    //
+    // Padded expandable modifier
+    //
+
+    &--padded {
+      .o-expandable {
+        &__header {
+          padding: math.div(25px, $base-font-size-px) + em
+            math.div(15px, $base-font-size-px) + em;
+        }
+
+        &__icon,
+        &__label {
+          // h2 size.
+          font-size: math.div(26px, $base-font-size-px) + em !important;
+
+          // Mobile only.
+          @include respond-to-max($bp-xs-max) {
+            font-size: math.div(22px, $base-font-size-px) + em !important;
+          }
+        }
+      }
+    }
+
+    //
+    // Expandable with a background color modifier
+    //
+
+    &--background {
+      background: var(--gray-5);
+    }
+
+    //
+    // Expandable with a border modifier
+    //
+
+    &--border {
+      border: 1px solid var(--expandable-border);
+    }
+
+    //
+    // Expandable groups
+    //
+
+    &-group {
+      .o-expandable {
+        border-bottom: 1px solid var(--expandable-border);
+
+        &:first-child {
+          border-top: 1px solid var(--expandable-border);
+        }
+      }
+    }
+
+    @media print {
+      // Hide the interactive expandable cues when printing
+      &__header[aria-expanded='true'] &__cue-close,
+      &__header[aria-expanded='false'] &__cue-open {
+        display: none;
+      } // Ensure all expandables are expanded when printing.
+      // To accommodate print stylesheets that display the raw URL after links,
+      // set an enormous max height to accommodate expandables that have a lot of links.
+      &__content[aria-expanded='false'] {
+        display: block;
+        max-height: 99999px !important;
+      }
+    }
+  }
+}
+
+// Used when the set language reads right-to-left
+html[lang='ar'] {
+  :host {
+    .o-expandable {
+      &__header {
+        text-align: right;
+      }
+
+      &__cues {
+        text-align: left;
+      }
+    }
+  }
+}

package/src/elements/cfpb-expandable/index.js

@@ -0,0 +1,127 @@
+import { html, LitElement, css, unsafeCSS } from 'lit';
+import { unsafeSVG } from 'lit/directives/unsafe-svg.js';
+import styles from './cfpb-expandable.component.scss';
+import expandIcon from '../../components/cfpb-icons/icons/plus-round.svg';
+import collapseIcon from '../../components/cfpb-icons/icons/minus-round.svg';
+import { MaxHeightTransition } from '../../utilities/transition/max-height-transition';
+import { FlyoutMenu } from '../../utilities/behavior/flyout-menu';
+
+/**
+ *
+ * @element cfpb-button
+ * @slot - The main content for the button.
+ */
+export class CfpbExpandable extends LitElement {
+  static styles = css`
+    ${unsafeCSS(styles)}
+  `;
+
+  #flyoutMenu;
+  #transition;
+
+  /**
+   * @property {boolean} isExpanded - Whether the expandable is expanded or not.
+   * @returns {object} The map of properties.
+   */
+  static get properties() {
+    return {
+      isExpanded: { type: Boolean, attribute: 'open', reflect: true },
+    };
+  }
+
+  constructor() {
+    super();
+  }
+
+  firstUpdated() {
+    const root = this.shadowRoot.querySelector('div');
+    const contentDom = root.querySelector('.o-expandable__content');
+
+    // If it's expanded we don't set an initial height,
+    // as it will be calculated internally.
+    const initialClass = this.isExpanded
+      ? MaxHeightTransition.CLASSES.MH_DEFAULT
+      : MaxHeightTransition.CLASSES.MH_ZERO;
+    this.#transition = new MaxHeightTransition(contentDom).init(initialClass);
+
+    this.#flyoutMenu = new FlyoutMenu(root);
+
+    this.#flyoutMenu.setTransition(
+      this.#transition,
+      this.#transition.maxHeightZero,
+      this.#transition.maxHeightDefault,
+    );
+
+    this.#flyoutMenu.init(this.isExpanded);
+
+    // Add events.
+    this.#flyoutMenu.addEventListener('expandbegin', () => {
+      this.isExpanded = true;
+      contentDom.classList.remove('u-hidden');
+      this.dispatchEvent(
+        new CustomEvent('expandbegin', {
+          detail: { target: this },
+          bubbles: true,
+          composed: true,
+        }),
+      );
+    });
+    this.#flyoutMenu.addEventListener('collapseend', () => {
+      this.isExpanded = false;
+      contentDom.classList.add('u-hidden');
+    });
+  }
+
+  updated(changedProps) {
+    if (changedProps.has('isExpanded')) {
+      const oldVal = changedProps.get('isExpanded');
+      const newVal = this.isExpanded;
+
+      if (newVal !== oldVal) {
+        if (newVal) {
+          this.#flyoutMenu.expand();
+        } else {
+          this.#flyoutMenu.collapse();
+        }
+      }
+    }
+  }
+
+  render() {
+    return html`
+      <div
+        class="o-expandable o-expandable--background o-expandable--border"
+        data-js-hook="behavior_flyout-menu"
+      >
+        <button
+          class="o-expandable__header"
+          title="Expand content"
+          data-js-hook="behavior_flyout-menu_trigger"
+        >
+          <slot name="header" class="o-expandable__label"></slot>
+          <span class="o-expandable__cues">
+            <span class="o-expandable__cue-open" role="img" aria-label="Show">
+              ${unsafeSVG(expandIcon)}
+              <span class="u-visually-hidden">Show</span>
+            </span>
+            <span class="o-expandable__cue-close" role="img" aria-label="Hide">
+              ${unsafeSVG(collapseIcon)}
+              <span class="u-visually-hidden">Hide</span>
+            </span>
+          </span>
+        </button>
+        <div
+          class="o-expandable__content"
+          data-js-hook="behavior_flyout-menu_content"
+        >
+          <slot name="content"></slot>
+        </div>
+      </div>
+    `;
+  }
+
+  static init() {
+    window.customElements.get('cfpb-expandable') ||
+      window.customElements.define('cfpb-expandable', CfpbExpandable);
+  }
+}

package/src/elements/cfpb-file-upload/cfpb-file-upload.component.scss

@@ -1,5 +1,5 @@
-@use '@cfpb/cfpb-design-system/src/abstracts' as *;
-@use '@cfpb/cfpb-design-system/src/components/cfpb-buttons/vars' as *;
+@use '@cfpb/cfpb-design-system/src/elements/abstracts' as *;
+@use '@cfpb/cfpb-design-system/src/elements/cfpb-button/vars' as *;
 
 :host {
   // This prevents the child button from having an empty gap after the button.

package/src/elements/cfpb-file-upload/index.js

@@ -13,27 +13,25 @@ export class CfpbFileUpload extends LitElement {
     ${unsafeCSS(styles)}
   `;
 
-  static get properties() {
-    return {
-      isDetailHidden: {
-        type: Boolean,
-        attribute: 'hidden', // Maps 'hidden' to 'isDetailHidden' property.
-        reflect: true, // Reflects the property change back to the attribute.
-      },
-      fileName: { type: String }, // The file name.
-      accept: { type: String }, // The accepted file types.
-      value: { type: String }, // The raw file name.
-      files: { type: FileList }, // A FileList object.
-    };
-  }
+  static properties = {
+    isDetailHidden: {
+      type: Boolean,
+      attribute: 'hidden', // Maps 'hidden' to 'isDetailHidden' property.
+      reflect: true, // Reflects the property change back to the attribute.
+    },
+    fileName: { type: String }, // The file name.
+    accept: { type: String }, // The accepted file types.
+    value: { type: String }, // The raw file name.
+    files: { type: FileList }, // A FileList object.
+  };
 
   constructor() {
     super();
     this.#hideDetails();
   }
 
-  fileInput = createRef();
-  fileDetails = createRef();
+  #fileInput = createRef();
+  #fileDetails = createRef();
 
   #getUploadName(fileName) {
     let uploadName = fileName;
@@ -46,9 +44,9 @@ export class CfpbFileUpload extends LitElement {
   }
 
   #showDetails() {
-    this.fileName = this.#getUploadName(this.fileInput.value.value);
-    this.value = this.fileInput.value.value;
-    this.files = this.fileInput.value.files;
+    this.fileName = this.#getUploadName(this.#fileInput.value.value);
+    this.value = this.#fileInput.value.value;
+    this.files = this.#fileInput.value.files;
     this.isDetailHidden = false;
   }
 
@@ -60,7 +58,7 @@ export class CfpbFileUpload extends LitElement {
   }
 
   #checkStatus() {
-    if (this.fileInput.value.value == '') {
+    if (this.#fileInput.value.value == '') {
       this.#hideDetails();
     } else {
       this.#showDetails();
@@ -71,9 +69,9 @@ export class CfpbFileUpload extends LitElement {
     return html`
       <cfpb-button
         variant="secondary"
-        @click="${() => {
-          this.fileInput.value.click();
-        }}"
+        @click=${() => {
+          this.#fileInput.value.click();
+        }}
       >
         <slot></slot>
       </cfpb-button>
@@ -81,15 +79,15 @@ export class CfpbFileUpload extends LitElement {
         class="a-btn a-btn--secondary"
         type="file"
         hidden
-        accept="${this.accept}"
-        @input="${() => this.#checkStatus()}"
-        @cancel="${() => this.#checkStatus()}"
-        ${ref(this.fileInput)}
+        accept=${this.accept}
+        @input=${() => this.#checkStatus()}
+        @cancel=${() => this.#checkStatus()}
+        ${ref(this.#fileInput)}
       />
       <div
         part="upload-details"
         ?hidden=${this.isDetailHidden}
-        ${ref(this.fileDetails)}
+        ${ref(this.#fileDetails)}
       >
         <h4>File added</h4>
         <ul>

package/src/elements/cfpb-form-alert/cfpb-form-alert.component.scss

@@ -0,0 +1,36 @@
+@use 'sass:math';
+@use '@cfpb/cfpb-design-system/src/elements/abstracts' as *;
+@use '@cfpb/cfpb-design-system/src/components/cfpb-icons/icon' as *;
+
+:host {
+  .a-form-alert {
+    // Theme
+    --form-alert-icon-color: var(--form-alert-icon-color-default);
+
+    margin-top: math.div(15px, $base-font-size-px) + rem;
+    display: flex;
+    gap: math.div(5px, $base-font-size-px) + rem;
+
+    .cf-icon-svg {
+      color: var(--form-alert-icon-color);
+      flex: none;
+      margin-top: math.div(1px, $base-font-size-px) + rem;
+    }
+
+    &__text {
+      display: block;
+    }
+
+    &--success .cf-icon-svg {
+      --form-alert-icon-color: var(--form-alert-icon-color-success);
+    }
+
+    &--warning .cf-icon-svg {
+      --form-alert-icon-color: var(--form-alert-icon-color-warning);
+    }
+
+    &--error .cf-icon-svg {
+      --form-alert-icon-color: var(--form-alert-icon-color-error);
+    }
+  }
+}

package/src/elements/cfpb-form-alert/index.js

@@ -0,0 +1,55 @@
+import { html, LitElement, css, unsafeCSS } from 'lit';
+import { unsafeSVG } from 'lit/directives/unsafe-svg.js';
+import styles from './cfpb-form-alert.component.scss';
+import errorIcon from '../../components/cfpb-icons/icons/error-round.svg';
+import warningIcon from '../../components/cfpb-icons/icons/warning-round.svg';
+import successIcon from '../../components/cfpb-icons/icons/approved-round.svg';
+
+/**
+ * @element cfpb-form-search
+ * @slot - The label for the form input.
+ */
+export class CfpbFormAlert extends LitElement {
+  static styles = css`
+    ${unsafeCSS(styles)}
+  `;
+
+  /**
+   * @property {string} validation - Validation style: error, warning, success.
+   * @returns {object} The map of properties.
+   */
+  static properties = {
+    validation: { type: String },
+  };
+
+  constructor() {
+    super();
+    this.validation = 'error';
+  }
+
+  get icon() {
+    let icon = errorIcon;
+    if (this.validation === 'warning') {
+      icon = warningIcon;
+    } else if (this.validation === 'success') {
+      icon = successIcon;
+    }
+
+    return icon;
+  }
+
+  render() {
+    return html`<div
+      class="a-form-alert a-form-alert--${this.validation}"
+      role="alert"
+    >
+      ${unsafeSVG(this.icon)}
+      <div class="a-form-alert__text"><slot></slot></div>
+    </div>`;
+  }
+
+  static init() {
+    window.customElements.get('cfpb-form-alert') ||
+      window.customElements.define('cfpb-form-alert', CfpbFormAlert);
+  }
+}