@bildvitta/quasar-ui-asteroid 3.17.0-beta.2 → 3.17.0-beta.21

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bildvitta/quasar-ui-asteroid",
   "description": "Asteroid",
-  "version": "3.17.0-beta.2",
+  "version": "3.17.0-beta.21",
   "author": "Bild & Vitta <systemteam@bild.com.br>",
   "license": "MIT",
   "main": "dist/asteroid.cjs.min.js",
@@ -54,7 +54,7 @@
     "lodash-es": "^4.17.21",
     "pica": "^9.0.1",
     "signature_pad": "^4.1.5",
-    "sortablejs": "^1.15.0"
+    "sortablejs": "^1.15.3"
   },
   "browserslist": [
     "defaults"

package/src/components/actions/QasActions.vue

@@ -72,7 +72,7 @@ const classes = computed(() => {
 const columnClasses = computed(() => {
   if (props.useEqualWidth) return 'col-12 col-sm-6'
 
-  return props.useFullWidth ? 'col-12' : 'col-12 col-sm-auto'
+  return props.useFullWidth ? 'full-width' : 'col-12 col-sm-auto'
 })
 
 const hasPrimarySlot = computed(() => !!slots.primary)

package/src/components/app-menu/QasAppMenu.vue

@@ -58,7 +58,9 @@
                 </div>
               </div>
 
-              <q-item v-else :key="index" :active="isActive(menuItem)" active-class="q-router-link--active" class="qas-app-menu__item" :to="getRouterRedirect(menuItem)">
+              <!-- quando tem children vazio, não deve mostrar label do item, e a label do item
+              não tem "to", então validar se tem "to" para mostrar o item -->
+              <q-item v-else-if="menuItem.to" :key="index" :active="isActive(menuItem)" active-class="q-router-link--active" class="qas-app-menu__item" :to="getRouterRedirect(menuItem)">
                 <q-item-section v-if="menuItem.icon" avatar>
                   <q-icon :name="menuItem.icon" />
                 </q-item-section>
@@ -276,6 +278,9 @@ function hasSeparator (index) {
 }
 
 function isActive ({ to }) {
+  // quando o children vem vazio, "to" é "undefined", então precisa ser feito esta trativa.
+  if (!to) return false
+
   const currentPath = getNormalizedPath(router.currentRoute.value.path)
   const itemPath = typeof to === 'string' ? getNormalizedPath(to) : getPathFromObject(to)
 

package/src/components/avatar/QasAvatar.vue

@@ -19,12 +19,7 @@ defineOptions({
 const props = defineProps({
   color: {
     type: String,
-    default: AvatarColors.Primary,
-    validator: value => {
-      const availableColors = Object.values(AvatarColors)
-
-      return availableColors.includes(value)
-    }
+    default: AvatarColors.Primary
   },
 
   size: {
@@ -42,6 +37,11 @@ const props = defineProps({
     type: String
   },
 
+  textColor: {
+    default: '',
+    type: String
+  },
+
   title: {
     default: '',
     type: String
@@ -62,7 +62,6 @@ const attributes = computed(() => {
     rounded,
     square,
     fontSize,
-    textColor,
     ...attributes
   } = attrs
 
@@ -76,7 +75,7 @@ const attributes = computed(() => {
   return {
     size: props.size,
     color: props.color,
-    textColor: colors[props.color],
+    textColor: colors[props.color] || props.textColor,
     ...attributes
   }
 })

package/src/components/board-generator/QasBoardGenerator.vue

@@ -1,39 +1,40 @@
 <template>
-  <qas-grabbable class="qas-board-generator" use-scroll-bar>
+  <qas-grabbable class="qas-board-generator" v-bind="grabbableProps">
     <div class="no-wrap q-col-gutter-sm q-px-xl row">
       <div v-for="(header, index) in headers" :key="index" class="q-mr-sm">
-        <qas-box class="q-mb-md">
-          <slot :fields="getFieldsByHeader(header)" :header="header" name="header-column" />
+        <qas-box class="q-mb-md" v-bind="headerBoxProps">
+          <slot :fields="getFieldsByHeader(header)" :header="header" :index="index" name="header-column" />
         </qas-box>
 
-        <div ref="columnContainer" class="qas-board-generator__column secondary-scroll" :style="containerStyle">
-          <slot v-for="item in getItemsByHeader(header)" :fields="getFieldsByHeader(header)" :item="item" name="column-item" />
+        <div ref="columnContainer" class="qas-board-generator__column secondary-scroll" :data-header-key="getKeyByHeader(header)" :style="containerStyle">
+          <div v-for="item in getItemsByHeader(header)" :id="item[props.itemIdKey]" :key="item[props.itemIdKey]" class="qas-board-generator__item">
+            <slot :column-index="index" :fields="getFieldsByHeader(header)" :item="item" name="column-item" />
+          </div>
 
-          <div class="full-width justify-center q-mb-md q-mt-sm row">
+          <div class="full-width justify-center row">
             <qas-btn v-if="hasSeeMore(header)" icon="sym_r_add" label="Ver mais" :use-label-on-small-screen="false" variant="tertiary" @click="fetchColumn(header)" />
 
-            <q-spinner v-if="columnsLoading[getKeyByHeader(header)]" color="grey-4" size="3em" />
-
-            <qas-empty-result-text v-if="hasEmptyResultText(header)" />
+            <q-spinner v-if="columnsLoading[getKeyByHeader(header)]" class="q-mb-md" color="grey-4" size="3em" />
           </div>
+
+          <qas-empty-result-text v-if="hasEmptyResultText(header)" />
         </div>
       </div>
     </div>
+
+    <qas-dialog v-model="showConfirmDialog" v-bind="defaultConfirmDialogProps" />
   </qas-grabbable>
 </template>
 
 <script setup>
-import { ref, watch, computed, onMounted, markRaw, inject } from 'vue'
-import promiseHandler from '../../helpers/promise-handler'
+import QasDialog from '../dialog/QasDialog.vue'
 
-defineOptions({ name: 'QasBoardGenerator' })
+import { ref, watch, computed, onUnmounted, markRaw, inject, onMounted } from 'vue'
+import promiseHandler from '../../helpers/promise-handler'
 
-const columnContainer = ref(null)
-const columnsPagination = ref({})
-const columnsLoading = ref({})
-const columnsFieldsModel = ref({})
+import Sortable from 'sortablejs'
 
-const axios = inject('axios')
+defineOptions({ name: 'QasBoardGenerator' })
 
 const props = defineProps({
   headers: {
@@ -46,6 +47,11 @@ const props = defineProps({
     default: () => ({})
   },
 
+  headerBoxProps: {
+    type: Object,
+    default: () => ({})
+  },
+
   columnIdKey: {
     type: String,
     required: true
@@ -61,11 +67,21 @@ const props = defineProps({
     required: true
   },
 
+  confirmDialogProps: {
+    type: Object,
+    default: () => ({})
+  },
+
   height: {
     type: String,
     default: ''
   },
 
+  itemIdKey: {
+    type: String,
+    default: ''
+  },
+
   limitPerColumn: {
     type: Number,
     default: 12
@@ -76,11 +92,34 @@ const props = defineProps({
     default: '300px'
   },
 
+  sortableConfig: {
+    type: Object,
+    default: () => ({})
+  },
+
   useMarkRaw: {
     type: Boolean,
     default: true
   },
 
+  useDragAndDropX: {
+    type: Boolean
+  },
+
+  useDragAndDropY: {
+    type: Boolean
+  },
+
+  updatePositionUrl: {
+    type: String,
+    default: ''
+  },
+
+  updatePositionParams: {
+    type: Object,
+    default: () => ({})
+  },
+
   lazyLoadingFieldsKeys: {
     type: Array,
     default: () => []
@@ -92,28 +131,93 @@ const emit = defineEmits([
   'fetch-column-success',
   'fetch-column-error',
   'fetch-columns-success',
-  'fetch-columns-error'
+  'fetch-columns-error',
+  'update-success'
 ])
 
+defineExpose({ fetchColumns, fetchColumn, reset })
+
+// Inject
+const axios = inject('axios')
+
+const isFetchSuccessHeader = inject('isFetchListSucceeded', false)
+
+const isInsideListView = inject('isListView', false)
+
+// Refs
+const columnContainer = ref(null)
+const columnsPagination = ref({})
+const columnsLoading = ref({})
+const columnsFieldsModel = ref({})
+const showConfirmDialog = ref(false)
+const isDragging = ref(false)
+const isLoadingUpdatePosition = ref(false)
+
+/**
+ * Instâncias do sortable, que são utilizadas para realizar o destroy ao sair da página
+ */
+const sortableInstances = ref([])
+
+/**
+ * Callbacks que recebe o event de movimentação
+ */
+const onCancelDrop = ref(() => {})
+const onConfirmDrop = ref(() => {})
+
+/**
+ * Variável auxiliar que controla quando estou atualizando o header em caso de drag and drop
+ */
+const isUpdatingPosition = ref(false)
+
+// Consts
+const hasDragAndDrop = !!props.useDragAndDropX || !!props.useDragAndDropY
+
+const grabbableProps = {
+  useScrollBar: true,
+
+  ...(hasDragAndDrop && {
+    cancelMouseDownTarget: 'qas-board-generator__item'
+  })
+}
+
+// Watchers
+watch(
+  () => isFetchSuccessHeader.value,
+  value => {
+    /**
+     * isFetchSuccessHeader é uma variavel que pego do listView por inject/provide, no qual caso eu faça request do header e dê sucesso, eu chamo as demais funções.
+     * Valido se não houve sucesso na requisição do header ou se não é uma atualização de posição, para assim não bater novamente nas colunas apenas no header.
+     */
+    if (!value || isUpdatingPosition.value) return
+
+    fetchColumnsValues()
+  }
+)
+
 watch(
   () => props.headers,
   () => {
-    reset()
-    setColumnHeightContainer()
-    setColumnsPagination()
-    fetchColumns()
+    if (isUpdatingPosition.value) return
+
+    isUpdatingPosition.value = false
   }
 )
 
 watch(columnContainer, setColumnHeightContainer)
 
+// Lifecycles
 onMounted(() => {
-  setColumnsPagination()
-  fetchColumns()
+  /**
+   * Caso eu use o listView (valor pego por provide), a request é feito pelo watch quando se ocorre o sucesso do `fetchList`
+   */
+  if (isInsideListView) return
+
+  fetchColumnsValues()
 })
 
-defineExpose({ fetchColumns, fetchColumn, reset })
+onUnmounted(destroySortable)
 
+// Computeds
 const columnsResultsModel = computed({
   get () {
     return props.results
@@ -124,10 +228,32 @@ const columnsResultsModel = computed({
   }
 })
 
-const hasColumnsLength = computed(() => Object.keys(columnsResultsModel.value).length)
+const hasColumnsLength = computed(() => !!Object.keys(columnsResultsModel.value).length)
 
 const containerStyle = computed(() => `width: ${props.columnWidth};`)
 
+const hasConfirmDialogProps = computed(() => !!Object.keys(props.confirmDialogProps).length)
+
+const defaultConfirmDialogProps = computed(() => {
+  const defaultProps = {
+    ok: {
+      label: 'Confirmar',
+      onClick: onConfirmDrop.value,
+      loading: isLoadingUpdatePosition.value
+    },
+
+    cancel: {
+      onClick: onCancelDrop.value
+    }
+  }
+
+  return {
+    ...props.confirmDialogProps,
+    ...defaultProps
+  }
+})
+
+// functions
 /*
 * Setar o tamanho do container do board, onde deverá ser a altura passada via prop, ou o default será ocupar o maximo
 * de espaço que ele conseguir considerando a altura do container em relação ao topo.
@@ -157,6 +283,8 @@ async function fetchColumns () {
   }
 
   emit('fetch-columns-success')
+
+  if (hasDragAndDrop) handleElementsList()
 }
 
 /*
@@ -189,22 +317,25 @@ async function fetchColumn (header) {
     throw error
   }
 
-  /*
-  * exemplo de como columnsResultsModel irá ficar:
-  *
-  * {
-  *  '2024-02-15': [...],
-  *  '2024-02-16': [...]
-  * }
-  *
-  * onde cada item do objeto é uma coluna no board. O mesmo vale para "columnsFieldsModel", "columnsLoading" e
-  * "columnPagination", organizando os fields, loadings e o controle de paginação por chave identificadora do header.
-  */
+  const newValues = response.data?.results || []
+  const resultsModel = columnsResultsModel.value[headerKey] || []
+
   const newColumnValues = [
-    ...columnsResultsModel.value[headerKey] || [],
-    ...response.data?.results || []
+    ...resultsModel,
+    ...newValues
   ]
 
+  /**
+   * exemplo de como columnsResultsModel irá ficar:
+   *
+   * {
+   *  '2024-02-15': [...],
+   *  '2024-02-16': [...]
+   * }
+   *
+   * onde cada item do objeto é uma coluna no board. O mesmo vale para "columnsFieldsModel", "columnsLoading" e
+   * "columnPagination", organizando os fields, loadings e o controle de paginação por chave identificadora do header.
+   */
   columnsResultsModel.value[headerKey] = props.useMarkRaw ? markRaw(newColumnValues) : newColumnValues
 
   /*
@@ -293,8 +424,24 @@ function setColumnsPagination () {
   })
 }
 
+function fetchColumnsValues () {
+  reset()
+  setColumnHeightContainer()
+  setColumnsPagination()
+  fetchColumns()
+}
+
+/**
+ * Descricao:
+ * Exibe o texto quando:
+ * - Nao esta carregando a coluna
+ * - Nao tem itens na coluna
+ * - Nao estou fazendo o drag and drop
+ *
+ * @param {Object} header
+ */
 function hasEmptyResultText (header) {
-  return !columnsLoading.value[getKeyByHeader(header)] && !getItemsByHeader(header)?.length
+  return !columnsLoading.value[getKeyByHeader(header)] && !getItemsByHeader(header)?.length && !isDragging.value
 }
 
 /*
@@ -319,6 +466,221 @@ function getFieldsByHeader (header) {
 
   return columnsFieldsModel.value[headerKey] || {}
 }
+
+/**
+ * Loopa todos os itens da coluna com base no ref para pegar o elemento HTML e setar e instaciar o sortable.
+ */
+function handleElementsList () {
+  columnContainer.value.forEach((element, index) => {
+    const sortable = setSortable(element, index)
+
+    sortableInstances.value.push(sortable)
+  })
+}
+
+/**
+ * Descricao:
+ * Seta a instancia do sortable, no qual varia de acordo com as props passadas.
+ *
+ * @param {HTMLElement} element
+ * @param {Number} index
+ */
+function setSortable (element, index) {
+  const defaultSortableConfig = {
+    animation: 500,
+    swapThreshold: 1,
+    delay: 50,
+    delayOnTouchOnly: true,
+    emptyInsertThreshold: 0
+  }
+
+  /**
+   * Caso seja apenas drag and drop no eixo Y
+   */
+  const useOnlyDragAndDropY = !!props.useDragAndDropY && !props.useDragAndDropX
+
+  const sortable = new Sortable(element, {
+    sort: props.useDragAndDropY,
+
+    ...defaultSortableConfig,
+
+    ...props.sortableConfig,
+
+    group: useOnlyDragAndDropY ? `column-${index}` : 'shared',
+
+    direction: useOnlyDragAndDropY ? 'vertical' : 'horizontal',
+
+    onStart: toggleIsDragging,
+
+    onAdd: event => onDropCard(event),
+
+    ...(props.useDragAndDropY && {
+      onSort: event => onDropCard(event)
+    })
+  })
+
+  return sortable
+}
+
+function toggleIsDragging () {
+  isDragging.value = !isDragging.value
+}
+
+function onDropCard (event) {
+  onCancelDrop.value = () => cancelDrop(event)
+
+  onConfirmDrop.value = () => confirmDrop(event)
+
+  hasConfirmDialogProps.value
+    ? openConfirmDialog()
+    : confirmDrop(event)
+}
+
+function openConfirmDialog () {
+  showConfirmDialog.value = true
+}
+
+function closeConfirmDialog () {
+  showConfirmDialog.value = false
+}
+
+/**
+ * @param {event} event
+ */
+function cancelDrop (event) {
+  /**
+   * Insere na posição antiga que pertencia (event.oldIndex) dentro do seu antigo pai (event.from)
+   */
+  if (props.useDragAndDropX) event.from.insertBefore(event.item, event.from.children[event.oldIndex])
+
+  if (props.useDragAndDropY) {
+    const oldIndex = event.oldIndex
+
+    /**
+     * Se oldIndex for 0, o targetIndex deverá ser 0, pois isso indica que se o item é o primeiro da lista, ele não será movido para outra posição.
+     *
+     * Caso o oldIndex for diferente, devo incrementar 1 para adicionar, pois isso permite que o item seja inserido logo após sua posição original.
+     */
+    const targetIndex = oldIndex === 0 ? oldIndex : oldIndex + 1
+
+    /**
+     * Verifica se o índice alvo é válido, caso contrário, define como o final
+     */
+    const insertBeforeElement = targetIndex < event.from.children.length
+      ? event.from.children[targetIndex]
+      : null
+
+    event.from.insertBefore(event.item, insertBeforeElement)
+  }
+
+  if (hasConfirmDialogProps.value) closeConfirmDialog()
+
+  toggleIsDragging()
+}
+
+function confirmDrop (event) {
+  const { from, to, item: { id: itemId } } = event
+
+  const { headerKey: newHeaderKey } = to.dataset
+  const { headerKey: oldHeaderKey } = from.dataset
+
+  updatePosition({ newHeaderKey, oldHeaderKey, itemId, event })
+}
+
+/**
+ *
+ * @param {{
+ *  headerKey: string,
+ *  itemId: string
+ * }}
+ */
+function removeItemFromList ({ headerKey, itemId }) {
+  /**
+   * Coluna referente ao model de resultado
+   */
+  const columnItemList = columnsResultsModel.value[headerKey]
+
+  /**
+   * Busca o item com base em seu ID na lista de itens da coluna
+   */
+  const itemIndex = columnItemList.findIndex(itemContent => itemContent[props.itemIdKey] === itemId)
+
+  /**
+   * Remove o item da listagem com base no index, sendo que preciso subtrair 1 para pegar o index correto
+   */
+  columnItemList.splice(itemIndex, 1)
+
+  /**
+   * Remove o item do count da coluna para não mostrar o botão de "Ver mais¨.
+   */
+  columnsPagination.value[headerKey].count -= 1
+}
+
+/**
+ * Descricao:
+ * Metodo que realiza a request de update
+ *
+ * @param {{
+ *  newHeaderKey: string - ID da coluna de destino,
+ *  oldHeaderKey: string - ID da antiga coluna,
+ *  itemId: string - ID do meu item a ser movimento,
+ *  event: event
+ * }}
+ */
+async function updatePosition ({ newHeaderKey, oldHeaderKey, itemId, event }) {
+  const params = {
+    [props.columnIdKey]: newHeaderKey,
+    ...(props.useDragAndDropY && { newIndex: event.newIndex }),
+    ...props.updatePositionParams
+  }
+
+  const { data, error } = await promiseHandler(
+    axios.patch(`${props.updatePositionUrl}/${itemId}/update-position`, params),
+    {
+      errorMessage: 'Ocorreu um erro ao atualizar a posição de seu item.',
+      useLoading: false,
+      onLoading: value => {
+        isLoadingUpdatePosition.value = value
+
+        columnsLoading.value[newHeaderKey] = value
+      }
+    }
+  )
+
+  if (error) {
+    onCancelDrop.value()
+
+    return
+  }
+
+  removeItemFromList({ headerKey: oldHeaderKey, itemId })
+
+  setItemList({ headerKey: newHeaderKey, data: data.data, index: event.newIndex })
+
+  isUpdatingPosition.value = true
+
+  toggleIsDragging()
+
+  closeConfirmDialog()
+
+  emit('update-success')
+}
+
+function setItemList ({ headerKey, data, index }) {
+  /**
+   * Coluna referente ao model de resultado
+   */
+  const columnItemList = columnsResultsModel.value[headerKey]
+
+  /**
+   * Adiciona o item na posição do event escolhido.
+   */
+  columnItemList.splice(index, 0, data.result)
+}
+
+function destroySortable () {
+  sortableInstances.value.forEach(sortable => sortable.destroy())
+}
 </script>
 
 <style lang="scss">
@@ -341,5 +703,10 @@ function getFieldsByHeader (header) {
       display: none;
     }
   }
+
+  // 60px é o valor do padding definido no container da column.
+  &__column-items {
+    height: calc(100% - 60px);
+  }
 }
 </style>