@cfpb/cfpb-design-system 4.2.3 → 4.3.0

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

@@ -24,41 +24,40 @@ export class CfpbButton extends LitElement {
    * @property {string} type - The button type: button, submit, or reset.
    * @property {string} href - The URL to link to (makes the button a link).
    * @property {boolean} disabled - Whether the button is disabled or not.
-   * @property {string} variant - The button variant: secondary and warning.
+   * @property {string} variant
+   *   The button variant: primary, secondary, or warning.
    * @property {boolean} fullOnMobile - Whether to be width 100% on mobile.
    * @property {boolean} flushLeft - Whether button is not rounded on left.
    * @property {boolean} flushRight - Whether button is not rounded on right.
    * @property {boolean} styleAsLink - Style the button as a link.
    * @returns {object} The map of properties.
    */
-  static get properties() {
-    return {
-      type: { type: String },
-      href: { type: String },
-      disabled: { type: Boolean, reflect: true },
-      variant: { type: String },
-      fullOnMobile: {
-        type: Boolean,
-        attribute: 'full-on-mobile',
-        reflect: true,
-      },
-      flushLeft: {
-        type: Boolean,
-        attribute: 'flush-left',
-        reflect: true,
-      },
-      flushRight: {
-        type: Boolean,
-        attribute: 'flush-right',
-        reflect: true,
-      },
-      styleAsLink: {
-        type: Boolean,
-        attribute: 'style-as-link',
-        reflect: true,
-      },
-    };
-  }
+  static properties = {
+    type: { type: String },
+    href: { type: String },
+    disabled: { type: Boolean, reflect: true },
+    variant: { type: String },
+    fullOnMobile: {
+      type: Boolean,
+      attribute: 'full-on-mobile',
+      reflect: true,
+    },
+    flushLeft: {
+      type: Boolean,
+      attribute: 'flush-left',
+      reflect: true,
+    },
+    flushRight: {
+      type: Boolean,
+      attribute: 'flush-right',
+      reflect: true,
+    },
+    styleAsLink: {
+      type: Boolean,
+      attribute: 'style-as-link',
+      reflect: true,
+    },
+  };
 
   // DOM references.
   #iconTextDom = createRef();

package/src/elements/cfpb-button/vars.css

@@ -0,0 +1,30 @@
+/**
+ * Do not edit directly, this file was auto-generated.
+ */
+
+:host {
+  --btn-bg: var(--pacific);
+  --btn-bg-active: var(--navy);
+  --btn-bg-hover: var(--pacific-dark);
+  --btn-disabled-bg: var(--gray-20);
+  --btn-disabled-divider: var(--gray-60);
+  --btn-disabled-outline: var(--gray-20);
+  --btn-disabled-text: var(--gray-dark);
+  --btn-divider: var(--pacific-60);
+  --btn-secondary-bg: var(--white);
+  --btn-secondary-bg-active: var(--pacific-20);
+  --btn-secondary-bg-hover: var(--pacific-10);
+  --btn-secondary-border: var(--pacific);
+  --btn-secondary-border-active: var(--navy);
+  --btn-secondary-border-hover: var(--pacific-dark);
+  --btn-secondary-divider: var(--pacific-60);
+  --btn-secondary-text: var(--pacific);
+  --btn-secondary-text-active: var(--navy);
+  --btn-secondary-text-hover: var(--pacific-dark);
+  --btn-text: var(--white);
+  --btn-warning-bg: var(--red-mid-dark);
+  --btn-warning-bg-active: var(--gray-dark);
+  --btn-warning-bg-hover: var(--red-dark);
+  --btn-warning-divider: var(--red-60);
+  --btn-warning-text: var(--white);
+}

package/src/elements/cfpb-checkbox-icon/cfpb-checkbox-icon.component.scss

@@ -0,0 +1,88 @@
+@use 'sass:math';
+@use '@cfpb/cfpb-design-system/src/elements/abstracts' as *;
+@use '@cfpb/cfpb-design-system/src/utilities' as *;
+
+:host {
+  // Theme variables.
+  --choice-border: var(--choice-border-default);
+  --choice-border-hover: var(--choice-border-hover-default);
+  --choice-bg: var(--choice-bg-default);
+  --choice-bg-selected: var(--choice-bg-selected-default);
+
+  // Private variables.
+  --choice-border-width-addendum: 0;
+
+  .cfpb-checkbox-icon::before {
+    display: inline-block;
+    grid-row-start: 1;
+    grid-row-end: 3;
+    border: 1px solid var(--choice-border);
+    outline: var(--choice-border-width-addendum) solid var(--choice-border);
+    height: math.div(18px, $base-font-size-px) + em;
+    width: math.div(18px, $base-font-size-px) + em;
+    margin-right: 10px;
+    background-color: var(--choice-bg);
+    content: '';
+    vertical-align: top;
+
+    // Offset so that the checkbox/radio fits within focused area.
+    position: relative;
+    top: 1px;
+    left: 1px;
+  }
+
+  .checked::before {
+    --cfpb-background-icon-svg: 'approved';
+    background-size: auto $cf-icon-height;
+    background-repeat: no-repeat;
+    background-position: center 0;
+  }
+
+  .disabled::before {
+    cursor: not-allowed;
+
+    --choice-border: var(--choice-border-disabled);
+    --choice-bg: var(--choice-bg-disabled);
+    --choice-bg-selected: var(--choice-bg-selected-disabled);
+  }
+
+  .checked.disabled::before {
+    // RGB values are CFPB gray (#5a5d61).
+    // For some reason SVG isn't accepting hex values for the fill.
+    --cfpb-background-icon-svg: 'approved rgb(90,93,97)';
+  }
+
+  .cfpb-checkbox-icon:not(.disabled, .borderless).focus::before,
+  .cfpb-checkbox-icon:not(.disabled, .borderless):focus::before,
+  .cfpb-checkbox-icon:not(.disabled, .borderless).hover::before,
+  .cfpb-checkbox-icon:not(.disabled, .borderless):hover::before {
+    cursor: pointer;
+    border-color: var(--choice-border-hover);
+    box-shadow: 0 0 0 1px var(--choice-border-hover);
+    outline-color: var(--choice-border-hover);
+  }
+
+  .validation-error,
+  .validation-warning,
+  .validation-success {
+    --choice-border-width-addendum: 1px;
+  }
+
+  .validation-error {
+    --choice-border: var(--choice-border-error);
+  }
+
+  .validation-warning {
+    --choice-border: var(--choice-border-warning);
+  }
+
+  .validation-success {
+    --choice-border: var(--choice-border-success);
+  }
+
+  .borderless::before {
+    border-color: transparent;
+    outline-color: transparent;
+    background-color: transparent;
+  }
+}

package/src/elements/cfpb-checkbox-icon/index.js

@@ -0,0 +1,104 @@
+import { html, LitElement, css, unsafeCSS } from 'lit';
+import styles from './cfpb-checkbox-icon.component.scss';
+
+// The validation states are error, warning, or success.
+const VALID_VALIDATION = ['error', 'warning', 'success'];
+
+/**
+ * @element cfpb-checkbox-icon
+ */
+export class CfpbCheckboxIcon extends LitElement {
+  static styles = css`
+    ${unsafeCSS(styles)}
+  `;
+
+  #hover;
+  #focus;
+
+  /**
+   * @property {boolean} borderless - Whether the checkbox has a border or not.
+   * @property {boolean} checked - Whether the checkbox is checked or not.
+   * @property {boolean} disabled - Whether the checkbox is disabled or not.
+   * @property {string} validation - Validation style: error, warning, success.
+   * @returns {object} The map of properties.
+   */
+  static properties = {
+    borderless: { type: Boolean, reflect: true },
+    checked: { type: Boolean, reflect: true },
+    disabled: { type: Boolean, reflect: true },
+    validation: { type: String, reflect: true },
+  };
+
+  constructor() {
+    super();
+    this.borderless = false;
+    this.checked = false;
+    this.disabled = false;
+    this.validation = '';
+    this.#hover = false;
+    this.#focus = false;
+  }
+
+  /**
+   * Ensure the validation value is valid, and fall back to a default if not.
+   * @returns {string|undefined} A valid validation value string, or undefined.
+   */
+  get #validValidation() {
+    return VALID_VALIDATION.includes(this.validation)
+      ? this.validation
+      : undefined;
+  }
+
+  mouseover() {
+    if (!this.disabled) {
+      this.#hover = true;
+      this.requestUpdate();
+    }
+  }
+
+  mouseleave() {
+    this.#hover = false;
+    this.requestUpdate();
+  }
+
+  focus() {
+    if (!this.disabled) {
+      this.#focus = true;
+      this.requestUpdate();
+    }
+  }
+
+  blur() {
+    this.#focus = false;
+    this.requestUpdate();
+  }
+
+  #computeClassString() {
+    return [
+      'cfpb-checkbox-icon',
+      this.checked && 'checked',
+      this.disabled && 'disabled',
+      this.borderless && 'borderless',
+      this.#validValidation && `validation-${this.#validValidation}`,
+      this.#hover && 'hover',
+      this.#focus && 'focus',
+    ]
+      .filter(Boolean)
+      .join(' ');
+  }
+
+  render() {
+    return html`
+      <div
+        class=${this.#computeClassString()}
+        ?disabled=${this.disabled}
+        aria-hidden="true"
+      ></div>
+    `;
+  }
+
+  static init() {
+    window.customElements.get('cfpb-checkbox-icon') ||
+      window.customElements.define('cfpb-checkbox-icon', CfpbCheckboxIcon);
+  }
+}

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

@@ -0,0 +1,218 @@
+@use 'sass:math';
+@use '@cfpb/cfpb-design-system/src/abstracts' as *;
+@use '@cfpb/cfpb-design-system/src/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.