dashboard/shell/components/GrowlManager.vue

<script>
import { mapState } from 'vuex';

export default {
  data() {
    return { autoRemoveTimer: null };
  },

  computed: {
    ...mapState('growl', ['stack']),

    shouldRun() {
      return this.stack.length && this.stack.find((x) => x.timeout > 0);
    }
  },

  watch: {
    stack() {
      if ( this.shouldRun ) {
        this.startAutoRemove();
      } else {
        this.stopAutoRemove();
      }
    },
  },

  methods: {
    remove(growl) {
      this.$store.dispatch('growl/remove', growl.id);
    },

    close(growl) {
      this.$store.dispatch('growl/close', growl.id);

      // If a user closes a growl, we won't get the mouse leave event, so we won't start the auto removal
      // again, leaving to stuck growls that should timeout
      this.startAutoRemove();
    },

    closeAll() {
      this.$store.dispatch('growl/clear');
    },

    closeExpired() {
      const now = new Date().getTime();

      // Check that we should still be running the auto-close interval timer
      if (!this.shouldRun) {
        this.stopAutoRemove();
      }

      for ( const growl of this.stack ) {
        if ( !growl.timeout ) {
          continue;
        }

        if ( growl.started + growl.timeout < now ) {
          this.remove(growl);
        }
      }
    },

    startAutoRemove() {
      if ( this.autoRemoveTimer || !this.shouldRun ) {
        return false;
      }

      this.autoRemoveTimer = setInterval(() => {
        this.closeExpired();
      }, 1000);

      return true;
    },

    stopAutoRemove() {
      if ( this.autoRemoveTimer ) {
        clearInterval(this.autoRemoveTimer);
        this.autoRemoveTimer = null;
      }
    },

    mouseEnter() {
      this.stopAutoRemove();
    },

    mouseLeave() {
      this.startAutoRemove();
    },
  }
};

</script>

<template>
  <div
    class="growl-container"
    @mouseenter="mouseEnter"
    @mouseleave="mouseLeave"
  >
    <div class="growl-list">
      <div
        v-for="(growl, idx) in stack"
        :key="growl.id"
        role="alert"
        :aria-labelledby="`growl-title-${ growl.id }`"
        :aria-describedby="`growl-message-${ growl.id }`"
        :data-testid="`growl-list-item-${idx}`"
        :class="{'growl': true, ['bg-'+growl.color]: true}"
      >
        <div
          class="growl-message"
          :class="{'growl-center': !growl.message}"
        >
          <div class="icon-container">
            <i :class="{icon: true, ['icon-'+growl.icon]: true}" />
          </div>
          <div class="growl-text">
            <i
              class="close hand icon icon-close"
              @click="close(growl)"
            />
            <div
              v-if="growl.title"
              :id="`growl-title-${ growl.id }`"
              class="growl-text-title"
            >
              {{ growl.title }}
            </div>
            <p
              v-if="growl.message"
              :id="`growl-message-${ growl.id }`"
              :class="{ 'has-title': !!growl.title }"
            >
              {{ growl.message }}
            </p>
          </div>
        </div>
      </div>
    </div>
  </div>
</template>

<style lang="scss" scoped>
  .growl-container {
    z-index: 1000;
    position: absolute;
    top: var(--header-height);
    right: 0;
    width: 100%;

    @media only screen and (min-width: map-get($breakpoints, '--viewport-7')) {
      width: 420px;
    }
  }

  .growl-list {
    max-height: calc(100vh - 50px);
    overflow: hidden;
  }

  .growl {
    border-radius: var(--border-radius);
    margin: 10px;
    position: relative;
    word-break: break-all;
    box-shadow: 0 3px 5px 0px var(--shadow);

    $growl-icon-size: 20px;

    .icon-container {
      align-self: center;
      flex-basis: 10%;
      padding: 10px 20px 10px 10px;
      i {
        font-size: $growl-icon-size;
        width: $growl-icon-size;
        height: $growl-icon-size;
      }
    }

    .growl-message {
      display: flex;

      &.growl-center {
        align-items: center;
      }

      .growl-text {
        position: relative;
        flex-basis: 90%;
        padding: 10px 10px 10px 0;
        word-break: break-word;
        white-space: normal;

        .close {
          position: absolute;
          top: 12px;
          right: 10px;
        }
        .growl-text-title {
          font-size: 16px;
        }

        > P {
          padding-top: 2px;

          &.has-title {
            margin-top: 5px;
          }
        }
      }
    }
  }
</style>