@vcmap/ui 5.0.0-rc.23 → 5.0.0-rc.24

package/src/components/buttons/VcsFormButton.vue

@@ -0,0 +1,176 @@
+<template>
+  <div class="vcs-button-wrap">
+    <v-btn
+      v-if="!tooltip"
+      :outlined="variant === 'outlined'"
+      :disabled="disabled"
+      :loading="loading"
+      :ripple="false"
+      elevation="0"
+      color="primary"
+      class="vcs-form-button"
+      :class="classes"
+      v-bind="{ ...$attrs }"
+      v-on="{ ...$listeners }"
+    >
+      <v-icon v-if="icon" :class="{ 'mr-2': hasDefaultSlot }">
+        {{ icon }}
+      </v-icon>
+      <slot />
+    </v-btn>
+    <VcsTooltip
+      v-else
+      :tooltip="tooltip"
+      :tooltip-position="tooltipPosition"
+      v-bind="{ ...tooltipProps }"
+    >
+      <template #activator="{ on, attrs }">
+        <v-btn
+          :outlined="variant === 'outlined'"
+          :disabled="disabled"
+          :loading="loading"
+          :ripple="false"
+          elevation="0"
+          color="primary"
+          class="vcs-form-button"
+          :class="classes"
+          v-bind="{ ...$attrs, ...attrs }"
+          v-on="{ ...$listeners, ...on }"
+        >
+          <v-icon v-if="icon" :class="{ 'mr-2': hasDefaultSlot }">
+            {{ icon }}
+          </v-icon>
+          <slot />
+        </v-btn>
+      </template>
+    </VcsTooltip>
+    <VcsBadge v-if="hasUpdate" :color="'warning'" class="position-absolute" />
+  </div>
+</template>
+
+<style lang="scss" scoped>
+  @import '../../styles/shades.scss';
+
+  .vcs-button-wrap {
+    position: relative;
+    display: inline-block;
+  }
+  .badge {
+    top: -3px;
+    right: -3px;
+  }
+  .v-btn {
+    &--outlined {
+      border: thin solid currentColor;
+    }
+    &--disabled {
+      // TODO text color primary
+      border-color: var(--v-primary-lighten1);
+      background-color: transparent !important;
+    }
+  }
+  .vcs-button-wrap {
+    .vcs-form-button {
+      min-width: 48px;
+      height: 32px;
+      font-size: 12px;
+      border: 1px solid transparent;
+
+      &--outlined {
+        border: thin solid currentColor;
+        &:hover {
+          border-color: var(--v-primary-lighten1) !important;
+          &::before {
+            background-color: var(--v-primary-lighten4) !important;
+            opacity: 1;
+          }
+        }
+      }
+
+      &--filled {
+        &:hover {
+          color: map-get($shades, 'white') !important;
+          border-color: var(--v-primary-lighten1) !important;
+          background-color: var(--v-primary-lighten1) !important;
+        }
+      }
+    }
+  }
+</style>
+
+<script>
+  import { VBtn, VIcon } from 'vuetify/lib';
+  import VcsBadge from '../notification/VcsBadge.vue';
+  import VcsTooltip from '../notification/VcsTooltip.vue';
+
+  /**
+   * @description a button with tooltip extending {@link https://vuetifyjs.com/en/api/v-btn/|vuetify v-btn} using {@link VcsTooltip}. Meant to be used in forms or window contents.
+   * @vue-prop {('filled' | 'outlined')}                [variant='outlined'] - Filled or outlined representation of the button.
+   * @vue-prop {boolean}                                disabled
+   * @vue-prop {boolean}                                loading
+   * @vue-prop {boolean}                                hasUpdate - Whether the button shows a badge in the top right.
+   * @vue-prop {string}                                 icon - When given, will display an icon in the button. Replaces vuetify icon property.
+   * @vue-prop {string}                                 tooltip - Text content of a tooltip which appears on hover with default delay.
+   * @vue-prop {('bottom' | 'left' | 'top' | 'right')}  tooltipPosition - Position of the tooltip.
+   * @vue-prop {Object<string, any>}                    tooltipProps - Properties to be passed to VcsTooltip {@link https://vuetifyjs.com/en/api/v-tooltip/#props|vuetify v-tooltip}
+   * @vue-computed {Object<string, string>}             classes - css classes applied to button, depending on variant
+   * @vue-computed {boolean}                            hasDefaultSlot
+   * @vue-event {MouseEvent}                            click - Emits click event when the button is clicked.
+   */
+  export default {
+    name: 'VcsFormButton',
+    components: {
+      VcsTooltip,
+      VcsBadge,
+      VBtn,
+      VIcon,
+    },
+    inheritAttrs: false,
+    props: {
+      variant: {
+        type: String,
+        default: 'outlined',
+        validator: (value) => ['outlined', 'filled'].includes(value),
+      },
+      disabled: {
+        type: Boolean,
+        default: false,
+      },
+      loading: {
+        type: Boolean,
+        default: false,
+      },
+      hasUpdate: {
+        type: Boolean,
+        default: false,
+      },
+      icon: {
+        type: String,
+        default: undefined,
+      },
+      tooltip: {
+        type: String,
+        default: undefined,
+      },
+      tooltipPosition: {
+        type: String,
+        default: 'bottom',
+      },
+      tooltipProps: {
+        type: Object,
+        default: () => ({}),
+      },
+    },
+    computed: {
+      classes() {
+        return {
+          'vcs-form-button--outlined': this.variant === 'outlined',
+          'vcs-form-button--filled': this.variant === 'filled',
+        };
+      },
+      hasDefaultSlot() {
+        return !!this.$slots?.default?.[0]?.text?.trim();
+      },
+    },
+  };
+</script>

package/src/components/form-inputs-controls/VcsCheckbox.vue

@@ -13,13 +13,13 @@
           on-icon="$vcsCheckboxChecked"
           off-icon="$vcsCheckbox"
           class="vcs-checkbox"
-          :class="{'pl-1': !isDense }"
+          :class="{ 'pl-1': !isDense }"
           hide-details
           indeterminate-icon="$vcsCheckboxIndeterminate"
           :dense="isDense"
           :ripple="false"
-          v-bind="{...$attrs, ...attrs}"
-          v-on="{...$listeners, ...on}"
+          v-bind="{ ...$attrs, ...attrs }"
+          v-on="{ ...$listeners, ...on }"
         >
           <template #label>
             <VcsLabel :html-for="$attrs.id" :dense="isDense">
@@ -33,7 +33,7 @@
   </VcsTooltip>
 </template>
 <style lang="scss" scoped>
-@import '../../styles/shades.scss';
+  @import '../../styles/shades.scss';
   .vcs-checkbox {
     ::v-deep {
       .v-input--selection-controls__input {
@@ -47,13 +47,13 @@
       .v-label {
         &.theme--light {
           color: map-get($shades, 'black') !important;
-          &.error--text{
+          &.error--text {
             color: var(--v-error-base) !important;
           }
         }
         &.theme--dark {
           color: map-get($shades, 'white') !important;
-          &.error--text{
+          &.error--text {
             color: var(--v-error-base) !important;
           }
         }
@@ -64,7 +64,6 @@
     margin: 0;
     padding: 0;
   }
-
 </style>
 <script>
   import { computed, ref } from 'vue';

package/src/components/form-inputs-controls/VcsDatePicker.vue

@@ -11,15 +11,21 @@
       <v-text-field
         v-model="formattedDate"
         :placeholder="formatDate(new Date().toISOString())"
-        v-bind="{...$attrs, ...attrs}"
-        v-on="{...$listeners, ...on}"
+        v-bind="{ ...$attrs, ...attrs }"
+        v-on="{ ...$listeners, ...on }"
         :prepend-icon="icon"
         readonly
         hide-details
         class="ma-0 py-1"
       />
     </template>
-    <v-date-picker v-model="date" no-title @input="menuOpen = false" :locale="locale" color="primary">
+    <v-date-picker
+      v-model="date"
+      no-title
+      @input="menuOpen = false"
+      :locale="locale"
+      color="primary"
+    >
       <v-btn color="primary" @click="goToToday">
         {{ $t('datePicker.today') }}
       </v-btn>
@@ -27,19 +33,22 @@
   </v-menu>
 </template>
 <style lang="scss" scoped>
-::v-deep {
-  .v-input__control{
-    padding: 0 8px;
+  ::v-deep {
+    .v-input__control {
+      padding: 0 8px;
+    }
   }
-}
 </style>
 <script>
   import {
-    computed, ref, watch, inject, onUnmounted, onBeforeMount,
+    computed,
+    ref,
+    watch,
+    inject,
+    onUnmounted,
+    onBeforeMount,
   } from 'vue';
-  import {
-    VMenu, VTextField, VDatePicker, VBtn,
-  } from 'vuetify/lib';
+  import { VMenu, VTextField, VDatePicker, VBtn } from 'vuetify/lib';
   /**
    * @description stylized wrapper around {@link https://v15.vuetifyjs.com/en/components/date-pickers/#month-pickers-in-dialog-and-menu}.
    * @vue-prop {string} value - value of the date picker in {@link https://tc39.es/ecma262/#sec-date-time-string-format | Date Time String Format}
@@ -68,12 +77,14 @@
       /**
        * @type {import("@vcmap/ui").VcsUiApp}
        */
-      const app = /** @type {import("@vcmap/ui").VcsUiApp} */ (inject('vcsApp'));
+      const app = /** @type {import("@vcmap/ui").VcsUiApp} */ (
+        inject('vcsApp')
+      );
       const localValue = ref(props.value);
       const menuOpen = ref(false);
       const locale = ref(app.locale);
 
-      const isValid = date => !Number.isNaN(Date.parse(date));
+      const isValid = (date) => !Number.isNaN(Date.parse(date));
       const setFromValue = () => {
         if (isValid(localValue.value)) {
           localValue.value = props.value;
@@ -83,12 +94,16 @@
         }
       };
       onBeforeMount(() => setFromValue());
-      const destroyLocaleChanged = app.localeChanged.addEventListener(() => { locale.value = app.locale; });
+      const destroyLocaleChanged = app.localeChanged.addEventListener(() => {
+        locale.value = app.locale;
+      });
       onUnmounted(() => destroyLocaleChanged());
 
       const formatDate = (date) => {
         if (date) {
-          return new Intl.DateTimeFormat(locale.value, { dateStyle: 'short' }).format(Date.parse(date));
+          return new Intl.DateTimeFormat(locale.value, {
+            dateStyle: 'short',
+          }).format(Date.parse(date));
         }
         return '';
       };
@@ -96,15 +111,31 @@
         localValue.value = new Date(Date.now()).toISOString().substring(0, 10);
         menuOpen.value = false;
       };
-      watch(() => props.value, () => setFromValue());
+      watch(
+        () => props.value,
+        () => setFromValue(),
+      );
       const formattedDate = computed({
-        get: () => { return formatDate(localValue.value); },
+        get: () => {
+          return formatDate(localValue.value);
+        },
         set: () => {},
       });
-      const date = computed({ get: () => localValue.value, set: (nv) => { localValue.value = nv; context.emit('input', localValue.value); } });
+      const date = computed({
+        get: () => localValue.value,
+        set: (nv) => {
+          localValue.value = nv;
+          context.emit('input', localValue.value);
+        },
+      });
 
       return {
-        formattedDate, date, menuOpen, formatDate, locale, goToToday,
+        formattedDate,
+        date,
+        menuOpen,
+        formatDate,
+        locale,
+        goToToday,
       };
     },
   };

package/src/components/form-inputs-controls/VcsFormSection.vue

@@ -2,8 +2,10 @@
   <section class="vcs-form-section">
     <slot name="header" :heading="heading" :actions="actions">
       <article class="pa-2 base lighten-3">
-        <div class="form-section-header d-flex justify-space-between align-center">
-          <strong class="caption">{{ $t(heading) }}</strong>
+        <div
+          class="form-section-header d-flex justify-space-between align-center"
+        >
+          <strong>{{ $t(heading) }}</strong>
           <VcsActionButtonList
             :actions="actions"
             :overflow-count="actionButtonListOverflowCount"
@@ -12,11 +14,7 @@
         </div>
       </article>
     </slot>
-    <VcsHelp
-      :text="helpText"
-      :show="showHelp"
-      class="base lighten-4"
-    >
+    <VcsHelp :text="helpText" :show="showHelp" class="base lighten-4">
       <slot name="help" />
     </VcsHelp>
     <article class="section-content">
@@ -25,7 +23,6 @@
   </section>
 </template>
 
-
 <script>
   import { computed, reactive } from 'vue';
   import VcsActionButtonList from '../buttons/VcsActionButtonList.vue';
@@ -56,7 +53,7 @@
       },
       headerActions: {
         type: Array,
-        default: () => ([]),
+        default: () => [],
       },
       actionButtonListOverflowCount: {
         type: Number,
@@ -74,11 +71,13 @@
         title: 'components.vcsFormSection.help',
         active: false,
         icon: 'mdi-help-circle',
-        callback() { this.active = !this.active; },
+        callback() {
+          this.active = !this.active;
+        },
       });
       const showHelp = computed(() => helpAction.active);
       /**
-       * @type {ComputedRef<VcsAction>}
+       * @type {import("vue").ComputedRef<VcsAction>}
        */
       const actions = computed(() => {
         if (props.helpText || (slots.help && slots.help().length > 0)) {
@@ -96,7 +95,7 @@
 </script>
 
 <style scoped>
-  .v-alert--text:before{
+  .v-alert--text:before {
     background-color: transparent;
   }
 </style>

package/src/components/form-inputs-controls/VcsLabel.vue

@@ -13,18 +13,17 @@
 </template>
 
 <style lang="scss" scoped>
-@import "../../styles/vcsGrid.scss";
-@import "../../styles/vcsFont";
-.vcs-label {
-  font-size: $base-font-size;
-  line-height: $line-height-base;
-}
-.vcs-label-dense {
-  line-height: $line-height-dense;
-}
+  @import '../../styles/vcsGrid.scss';
+  @import '../../styles/vcsFont';
+  .vcs-label {
+    font-size: $vcs-font-size;
+    line-height: $line-height-base;
+  }
+  .vcs-label-dense {
+    line-height: $line-height-dense;
+  }
 </style>
 <script>
-
   /**
    * @description Stylized wrapper around {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label |label label}.
    * pass the label text as innerHtml

package/src/components/form-inputs-controls/VcsRadio.vue

@@ -13,8 +13,8 @@
           class="w-full vcs-radio-group"
           :dense="isDense"
           :ripple="false"
-          v-bind="{...$attrs, ...attrs}"
-          v-on="{...$listeners, ...on}"
+          v-bind="{ ...$attrs, ...attrs }"
+          v-on="{ ...$listeners, ...on }"
         >
           <v-radio
             v-for="(item, idx) in items"
@@ -38,54 +38,54 @@
   </VcsTooltip>
 </template>
 <style lang="scss" scoped>
-@import "../../styles/vcsFont";
-@import '../../styles/shades.scss';
-.v-input--radio-group--column .v-radio:not(:last-child):not(:only-child) {
-  margin-bottom: 0;
-}
-.v-input {
-  &.vcs-radio-group {
-    ::v-deep {
-      margin-top: 0;
-      padding-top: 0;
-      label.v-label,
-      .v-icon.v-icon{
-        font-size: $base-font-size;
-        color: inherit;
-        &.theme--light{
-          color: map-get($shades, 'black') !important;
-          &.error--text{
-            color: var(--v-error-base) !important;
+  @import '../../styles/vcsFont.scss';
+  @import '../../styles/shades.scss';
+  .v-input--radio-group--column .v-radio:not(:last-child):not(:only-child) {
+    margin-bottom: 0;
+  }
+  .v-input {
+    &.vcs-radio-group {
+      ::v-deep {
+        margin-top: 0;
+        padding-top: 0;
+        label.v-label,
+        .v-icon.v-icon {
+          font-size: $vcs-font-size;
+          color: inherit;
+          &.theme--light {
+            color: map-get($shades, 'black') !important;
+            &.error--text {
+              color: var(--v-error-base) !important;
+            }
           }
-        }
-        &.theme--dark{
-          color: map-get($shades, 'white') !important;
-          &.error--text{
-            color: var(--v-error-base) !important;
+          &.theme--dark {
+            color: map-get($shades, 'white') !important;
+            &.error--text {
+              color: var(--v-error-base) !important;
+            }
           }
         }
-      }
-      .v-radio:not(:last-child):not(:only-child) {
-        margin-bottom: 0;
-      }
-      .v-input--selection-controls__input {
-        margin: 0;
-      }
-      label.v-label.error--text {
-        animation: none;
+        .v-radio:not(:last-child):not(:only-child) {
+          margin-bottom: 0;
+        }
+        .v-input--selection-controls__input {
+          margin: 0;
+        }
+        label.v-label.error--text {
+          animation: none;
+        }
       }
     }
   }
-}
-.vcs-radio {
-  height: 40px;
-  align-items: center;
-  padding-left: 4px;
-}
-.vcs-radio-dense {
-  height: 32px;
-  align-items: center;
-}
+  .vcs-radio {
+    height: 40px;
+    align-items: center;
+    padding-left: 4px;
+  }
+  .vcs-radio-dense {
+    height: 32px;
+    align-items: center;
+  }
 </style>
 <script>
   import { computed, ref } from 'vue';

package/src/components/form-inputs-controls/VcsSelect.vue

@@ -16,7 +16,7 @@
             outlined
             :dense="isDense"
             :height="isDense ? 24 : 32"
-            :item-text="item => $t(getText(item))"
+            :item-text="(item) => $t(getText(item))"
             class="py-1 primary--placeholder"
             :class="{
               'remove-outline': !isOutlined,
@@ -25,10 +25,10 @@
               'outline--current': focus,
               'outline--error': !!errorMessage,
             }"
-            v-bind="{...$attrs, ...attrs}"
-            v-on="{...$listeners, ...on}"
-            @focus="focus = true;"
-            @blur="focus = false;"
+            v-bind="{ ...$attrs, ...attrs }"
+            v-on="{ ...$listeners, ...on }"
+            @focus="focus = true"
+            @blur="focus = false"
             @mouseover="hover = true"
             @mouseleave="hover = false"
           >
@@ -56,10 +56,10 @@
       }
     }
   }
-  .v-select{
-    &.v-select--is-multi{
+  .v-select {
+    &.v-select--is-multi {
       ::v-deep {
-        .v-select__selections{
+        .v-select__selections {
           flex-wrap: nowrap;
         }
       }
@@ -75,7 +75,8 @@
   }
   .outline--current {
     ::v-deep {
-      .v-input__slot fieldset, .v-input__slot .v-select__slot {
+      .v-input__slot fieldset,
+      .v-input__slot .v-select__slot {
         border-color: currentColor;
         transition: border-color 0.5s ease;
       }
@@ -83,7 +84,8 @@
   }
   .outline--error {
     ::v-deep {
-      .v-input__slot fieldset, .v-input__slot .v-select__slot {
+      .v-input__slot fieldset,
+      .v-input__slot .v-select__slot {
         border-color: var(--v-error-base);
       }
     }
@@ -121,7 +123,6 @@
   }
 </style>
 <script>
-
   import { VSelect } from 'vuetify/lib';
   import { computed, ref } from 'vue';
   import VcsTooltip from '../notification/VcsTooltip.vue';
@@ -165,7 +166,10 @@
 
       const isDense = computed(() => attrs.dense !== false);
       const isOutlined = computed(() => {
-        return (hover.value || focus.value || !!errorMessage.value) && !(attrs.disabled || attrs.disabled === '');
+        return (
+          (hover.value || focus.value || !!errorMessage.value) &&
+          !(attrs.disabled || attrs.disabled === '')
+        );
       });
 
       function getText(item) {
@@ -188,4 +192,3 @@
     },
   };
 </script>
-