@bildvitta/quasar-ui-asteroid 3.0.0-beta.2 → 3.0.0-beta.20

package/dist/api/QasFormView.json

@@ -4,7 +4,23 @@
     "desc": "Componente para C.R.U.D. responsável pela pela criação (Create) e edição (Update)."
   },
   "props": {
-    "cancel-button": {
+    "before-fetch": {
+      "desc": "Callback para controlar como funciona o comportamento do fetch.",
+      "default": null,
+      "type": "Function",
+      "examples": [
+        "beforeFetch({ payload, resolve })"
+      ]
+    },
+    "before-submit": {
+      "desc": "Callback para controlar como funciona o comportamento do submit.",
+      "default": null,
+      "type": "Function",
+      "examples": [
+        "beforeSubmit({ payload, resolve })"
+      ]
+    },
+    "cancel-button-label": {
       "desc": "Rótulo do botão \"cancelar\".",
       "default": "Cancelar",
       "type": "String"
@@ -36,73 +52,28 @@
       "desc": "Desabilita o submit.",
       "type": "Boolean"
     },
-    "mode": {
-      "desc": "Existem 3 modos no QasFormView, para criação (create) (equivalente a um método POST no http), e edição que são 2 diferentes, replace (equivalente a um método PUT no http) e update (equivalente a um método PATCH no http).",
-      "default": "create",
-      "type": "String",
-      "examples": [
-        "create",
-        "replace",
-        "update"
-      ]
-    },
-    "read-only": {
-      "desc": "Controla o slot de actions.",
-      "type": "Boolean"
-    },
-    "route": {
-      "desc": "Você pode passar uma configuração de rota customizada.",
-      "default": {},
-      "type": "Object"
-    },
-    "show-dialog-on-unsaved-changes": {
-      "desc": "Vamos imaginar um cenário onde o usuário entra na nossa tela de editar/criar, faz tudo o que precisa e sem querer clica no menu para ir para outra tela, caso essa prop esteja \"true\", vai aparece um modal perguntando se ele quer continuar editando ou ir para a tela no qual foi inicialmente redirecionado.",
-      "default": true,
-      "type": "Boolean"
-    },
-    "ignore-keys-in-unsaved-changes": {
-      "desc": "Vamos imaginar um cenário onde você precisa alterar valores do v-model por qualquer motivo que seja, mas quando o usuário sair da tela, não pode aparecer o modal perguntando se ele quer sair ou continuar editando, por que o usuário de fato não fez nenhuma alteração nos dados, esta prop serve para você dizer quais keys dentro do v-model você quer ignorar.",
-      "default": [],
-      "type": "Array",
-      "examples": [
-        "['isActive']"
-      ]
-    },
-    "submit-button": {
-      "desc": "Rótulo do botão \"salvar\".",
-      "default": "Salvar",
+    "entity": {
+      "desc": "Entidade da store, por exemplo se tiver que trabalhar com modulo de usuários, teremos o model \"users\" na store, que vai ser nossa \"entity\".",
+      "required": true,
       "type": "String"
     },
-    "model-value": {
-      "desc": "Model do componente, controla o payload que será enviado para as actions dos modos create, replace e update.",
+    "errors": {
+      "desc": "Model de errors, utilizado para recuperar os errors fora do template.",
       "default": {},
       "type": "Object",
       "examples": [
-        "v-model=\"values\""
+        "v-model:errors=\"errors\""
       ],
       "model": true
     },
-    "submitting": {
-      "desc": "Model que que mostra quando o componente está fazendo um submitting ou não.",
+    "fetching": {
+      "desc": "Model de fetching, utilizado para saber se o componente está fazendo fetching de dados.",
       "type": "Boolean",
       "examples": [
-        "v-model:submitting=\"isSubmitting\""
+        "v-model:fetching=\"isFetching\""
       ],
       "model": true
     },
-    "entity": {
-      "desc": "Entidade da store, por exemplo se tiver que trabalhar com modulo de usuários, teremos o model \"users\" na store, que vai ser nossa \"entity\".",
-      "required": true,
-      "type": "String"
-    },
-    "dialog": {
-      "desc": "Este componente pode ser utilizado dentro de um dialog, neste caso o componente pai não pode ser um \"QPage\" e sim uma \"div\", esta prop cuida disto.",
-      "type": "Boolean"
-    },
-    "url": {
-      "desc": "Envia como parâmetro para a action \"fetchSingle\" do modulo correspondente a \"entity\".",
-      "type": "String"
-    },
     "fields": {
       "desc": "Model de fields, utilizado para recuperar os fields fora do template.",
       "default": {},
@@ -112,48 +83,123 @@
       ],
       "model": true
     },
-    "errors": {
-      "desc": "Model de errors, utilizado para recuperar os errors fora do template.",
+    "ignore-keys-in-unsaved-changes": {
+      "desc": "Vamos imaginar um cenário onde você precisa alterar valores do v-model por qualquer motivo que seja, mas quando o usuário sair da tela, não pode aparecer o modal perguntando se ele quer sair ou continuar editando, por que o usuário de fato não fez nenhuma alteração nos dados, esta prop serve para você dizer quais keys dentro do v-model você quer ignorar.",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "['isActive']"
+      ]
+    },
+    "metadata": {
+      "desc": "Model de metadata, utilizado para recuperar os metadata fora do template.",
       "default": {},
       "type": "Object",
       "examples": [
-        "v-model:errors=\"errors\""
+        "v-model:metadata=\"metadata\""
       ],
       "model": true
     },
-    "metadata": {
-      "desc": "Model de metadata, utilizado para recuperar os metadata fora do template.",
+    "mode": {
+      "desc": "Existem 3 modos no QasFormView, para criação (create) (equivalente a um método POST no http), e edição que são 2 diferentes, replace (equivalente a um método PUT no http) e update (equivalente a um método PATCH no http).",
+      "default": "create",
+      "type": "String",
+      "examples": [
+        "create",
+        "replace",
+        "update"
+      ]
+    },
+    "model-value": {
+      "desc": "Model do componente, controla o payload que será enviado para as actions dos modos create, replace e update.",
       "default": {},
       "type": "Object",
       "examples": [
-        "v-model:metadata=\"metadata\""
+        "v-model=\"values\""
       ],
       "model": true
     },
-    "fetching": {
-      "desc": "Model de fetching, utilizado para saber se o componente está fazendo fetching de dados.",
+    "route": {
+      "desc": "Você pode passar uma configuração de rota customizada.",
+      "default": {},
+      "type": "Object"
+    },
+    "submit-button-label": {
+      "desc": "Rótulo do botão \"salvar\".",
+      "default": "Salvar",
+      "type": "String"
+    },
+    "submitting": {
+      "desc": "Model que que mostra quando o componente está fazendo um submitting ou não.",
       "type": "Boolean",
       "examples": [
-        "v-model:fetching=\"isFetching\""
+        "v-model:submitting=\"isSubmitting\""
       ],
       "model": true
+    },
+    "url": {
+      "desc": "Envia como parâmetro para a action \"fetchSingle\" do modulo correspondente a \"entity\".",
+      "type": "String"
+    },
+    "use-actions": {
+      "desc": "Controla se vai ter ou não o slot de actions.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-boundary": {
+      "desc": "Controla o limite que o FormView terá, quando é \"false\", a tag pai deixa de ser um \"QPage\" para ser uma \"div\" e é removido as classes \"container\" e \"spaced\", comumente utilizando quando precisa usar o QasFormView dentro de um dialog.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-cancel-button": {
+      "desc": "Controla se vai ter ou não botão de \"cancelar\".",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-dialog-on-unsaved-changes": {
+      "desc": "Vamos imaginar um cenário onde o usuário entra na nossa tela de editar/criar, faz tudo o que precisa e sem querer clica no menu para ir para outra tela, caso essa prop esteja \"true\", vai aparece um modal perguntando se ele quer continuar editando ou ir para a tela no qual foi inicialmente redirecionado.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-submit-button": {
+      "desc": "Controla se vai ter ou não botão de submit.",
+      "default": true,
+      "type": "Boolean"
     }
   },
   "slots": {
-    "header": {
-      "desc": "Slot para acessar o header."
+    "actions": {
+      "desc": "Slot para acessar a seção onde ficam os botões de ações (salvar e cancelar)."
     },
     "default": {
       "desc": "Slot para ter o conteúdo principal (dentro do main)."
     },
-    "actions": {
-      "desc": "Slot para acessar a seção onde ficam os botões de ações (salvar e cancelar)."
-    },
     "footer": {
       "desc": "Slot para acessar o footer."
+    },
+    "header": {
+      "desc": "Slot para acessar o header."
     }
   },
   "events": {
+    "@fetch-success -> function(value)": {
+      "desc": "Dispara quando a action \"fetchSingle\" é executada com sucesso.",
+      "params": {
+        "value": {
+          "desc": "Retorna todos os dados \"cru\" respondido pelo fetch.",
+          "type": "Object"
+        }
+      }
+    },
+    "@fetch-error -> function(value)": {
+      "desc": "Dispara quando a action \"fetchSingle\" cai em uma exceção.",
+      "params": {
+        "value": {
+          "desc": "Retorna todos os dados \"cru\" respondido na exceção do fetch.",
+          "type": "Object"
+        }
+      }
+    },
     "@update:model-value -> function(value)": {
       "desc": "Dispara toda vez que o model atualiza.",
       "params": {
@@ -207,24 +253,6 @@
           "type": "Boolean"
         }
       }
-    },
-    "@fetch-success -> function(value)": {
-      "desc": "Dispara quando a action \"fetchSingle\" é executada com sucesso.",
-      "params": {
-        "value": {
-          "desc": "Retorna todos os dados \"cru\" respondido pelo fetch.",
-          "type": "Object"
-        }
-      }
-    },
-    "@fetch-error -> function(value)": {
-      "desc": "Dispara quando a action \"fetchSingle\" cai em uma exceção.",
-      "params": {
-        "value": {
-          "desc": "Retorna todos os dados \"cru\" respondido na exceção do fetch.",
-          "type": "Object"
-        }
-      }
     }
   }
 }

package/dist/api/QasGallery.json

@@ -21,13 +21,13 @@
       "desc": "Altura da imagem (fora do dialog).",
       "type": "String"
     },
-    "initial-size": {
-      "desc": "Quantidade de imagens iniciais.",
+    "images": {
+      "desc": "Imagens a serem exibidas.",
       "default": 6,
       "type": "Number"
     },
-    "images": {
-      "desc": "Imagens a serem exibidas.",
+    "initial-size": {
+      "desc": "Quantidade de imagens iniciais.",
       "default": 6,
       "type": "Number"
     },

package/dist/api/QasGridGenerator.json

@@ -4,41 +4,33 @@
     "desc": "Componente para criação de textos dinâmicos."
   },
   "props": {
-    "content-class": {
-      "desc": "Classe de cada \"div\" pai referente ao resultado.",
-      "default": "",
+    "columns": {
+      "desc": "Colunas do grid de cada campo.",
+      "default": "col-6",
       "type": [
         "Array",
-        "Object",
-        "String"
+        "String",
+        "Object"
+      ],
+      "examples": [
+        "{ name: { sm: 6, md: 12 } }",
+        "[{ sm: 6, md: 12 }]"
       ]
     },
-    "header-class": {
-      "desc": "Classe de cada \"header\" pai referente ao \"label\".",
-      "default": "text-bold",
+    "content-class": {
+      "desc": "Classe de cada \"div\" pai referente ao resultado.",
+      "default": "",
       "type": [
         "Array",
         "Object",
         "String"
       ]
     },
-    "hide-empty-result": {
-      "desc": "Se o resultado de algum campo for vazio, ele remove todo o campo.",
-      "type": "Boolean"
-    },
     "empty-result-text": {
       "desc": "Se o resultado de algum campo for vazio, esta prop define qual será o valor padrão.",
       "default": "-",
       "type": "String"
     },
-    "result": {
-      "desc": "Resultado contendo todas informações para serem exibidas na tela.",
-      "default": {},
-      "type": "Object",
-      "examples": [
-        "{ 'joah@examples.com' }"
-      ]
-    },
     "fields": {
       "desc": "Lista de field contendo informações necessárias para a criação do campo correspondente.",
       "default": {},
@@ -47,19 +39,6 @@
         "{ email: { name: 'email', type: 'email', label: 'E-mail' } }"
       ]
     },
-    "columns": {
-      "desc": "Colunas do grid de cada campo.",
-      "default": "col-6",
-      "type": [
-        "Array",
-        "String",
-        "Object"
-      ],
-      "examples": [
-        "{ name: { sm: 6, md: 12 } }",
-        "[{ sm: 6, md: 12 }]"
-      ]
-    },
     "gutter": {
       "desc": "Espaçamento entre colunas.",
       "default": "md",
@@ -71,11 +50,33 @@
         "lg",
         "xl"
       ]
+    },
+    "header-class": {
+      "desc": "Classe de cada \"header\" pai referente ao \"label\".",
+      "default": "text-bold",
+      "type": [
+        "Array",
+        "Object",
+        "String"
+      ]
+    },
+    "result": {
+      "desc": "Resultado contendo todas informações para serem exibidas na tela.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "{ 'joah@examples.com' }"
+      ]
+    },
+    "use-empty-result": {
+      "desc": "Se o resultado de algum campo for vazio e esta propriedade for \"false\", ele remove todo o campo.",
+      "default": true,
+      "type": "Boolean"
     }
   },
   "slots": {
-    "field-[nome-da-chave]": {
-      "desc": "Slot para todo o conteúdo dentro de cada grid (header e content).",
+    "content": {
+      "desc": "Slot para o conteúdo (content).",
       "scope": {
         "field": {
           "desc": "Conteúdo do field atual mais o resultado formatado.",
@@ -84,8 +85,8 @@
         }
       }
     },
-    "header": {
-      "desc": "Slot para o header.",
+    "field-[nome-da-chave]": {
+      "desc": "Slot para todo o conteúdo dentro de cada grid (header e content).",
       "scope": {
         "field": {
           "desc": "Conteúdo do field atual mais o resultado formatado.",
@@ -94,8 +95,8 @@
         }
       }
     },
-    "content": {
-      "desc": "Slot para o conteúdo (content).",
+    "header": {
+      "desc": "Slot para o header.",
       "scope": {
         "field": {
           "desc": "Conteúdo do field atual mais o resultado formatado.",

package/dist/api/QasInput.json

@@ -7,6 +7,14 @@
     "desc": "Componente para input que implementa o \"QInput\" repassando propriedades, slots e eventos."
   },
   "props": {
+    "error-message": {
+      "desc": "Controla mensagem de erro (apenas quando \"error\" for \"true\").",
+      "type": "String"
+    },
+    "error": {
+      "desc": "Controla cor da borda do input.",
+      "type": "Boolean"
+    },
     "model-value": {
       "desc": "Model do componente.",
       "type": [
@@ -18,26 +26,18 @@
       ],
       "model": true
     },
-    "unmasked-value": {
-      "desc": "Remove a mascara do v-model.",
-      "default": true,
-      "type": "Boolean"
-    },
     "outlined": {
       "desc": "Controla borda do input.",
       "default": true,
       "type": "Boolean"
     },
-    "error": {
-      "desc": "Controla cor da borda do input.",
+    "use-remove-error-on-type": {
+      "desc": "Limpa os erros do campo caso os mesmos existam toda vez que o model atualiza.",
       "type": "Boolean"
     },
-    "error-message": {
-      "desc": "Controla mensagem de erro (apenas quando \"error\" for \"true\").",
-      "type": "String"
-    },
-    "remove-error-on-type": {
-      "desc": "Limpa os erros do campo caso os mesmos existam toda vez que o model atualiza.",
+    "unmasked-value": {
+      "desc": "Remove a mascara do v-model.",
+      "default": true,
       "type": "Boolean"
     }
   },

package/dist/api/QasListItems.json

@@ -17,24 +17,10 @@
       "default": [],
       "type": "Array"
     },
-    "redirect-key": {
-      "desc": "Você pode enviar qualquer chave/valor dentro do array de objeto da prop \"list\", esta prop serve para você identificar qual vai ser a chave que vai redirecionar ao clicar no botão.",
-      "default": "uuid",
-      "type": "String"
-    },
-    "redirect-on-icon": {
-      "desc": "Controla se o redirecionamento vai acontecer quando clicar no item inteiro ou somente no icon.",
-      "default": true,
+    "use-clickable-item": {
+      "desc": "Controla se o item inteiro é clicável ou somente o button dentro do item.",
       "type": "Boolean"
     },
-    "to": {
-      "desc": "Configuração passada para o vue-router.",
-      "default": {},
-      "type": "Object",
-      "examples": [
-        "{ name: 'Root' }"
-      ]
-    },
     "use-section-actions": {
       "desc": "Controla se exibe ou não seção de actions, onde fica o Ícone de redirecionamento.",
       "default": true,
@@ -42,7 +28,7 @@
     }
   },
   "slots": {
-    "item-section-left": {
+    "item-section": {
       "desc": "Slot para acessar seção da esquerda.",
       "scope": {
         "item": {
@@ -68,5 +54,20 @@
         }
       }
     }
+  },
+  "events": {
+    "@click-item -> function ({ item, index })": {
+      "desc": "Dispara toda vez que o item ou button (dependendo da prop \"use-section-actions\") é clicado.",
+      "params": {
+        "item": {
+          "desc": "Item clicado",
+          "type": "Object"
+        },
+        "index": {
+          "desc": "Posição do item",
+          "type": "Number"
+        }
+      }
+    }
   }
 }