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

package/src/components/form-view/QasFormView.yml

@@ -1,253 +1,253 @@
-type: component
-
-meta:
-  desc: Componente para C.R.U.D. responsável pela pela criação (Create) e edição (Update).
-
-props:
-  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 "voltar".
-    default: Voltar
-    type: String
-
-  cancel-route:
-    desc: Configuração do botão de "cancelar", caso seja "false", não exibe o botão, caso precise passar uma path direto use como string, caso precisar passar uma configuração como "name" ou "params" passe como objeto, agora se precisar de uma logica especifica quando clicar no botão de cancelar, você pode passar uma função que ela será executado.
-    default: "''"
-    type: [Boolean, Object, String, Function]
-    examples: [
-      /users,
-      false,
-      "{ name: 'UsersForm', params: { id: 'uuid-1' } }",
-      () => alert('Lógica especifica.')
-    ]
-
-  custom-id:
-    desc: Por padrão, o componente vai pegar o "id" que vem como parâmetro na url, caso queira que o id seja diferente da url, use esta prop.
-    type: String
-    examples: ['my-custom-id']
-
-  disable:
-    desc: Desabilita o submit.
-    type: Boolean
-
-  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
-
-  errors:
-    desc: Model de errors, utilizado para recuperar os errors fora do template.
-    default: {}
-    type: Object
-    examples: [v-model:errors="errors"]
-    model: true
-
-  fetching:
-    desc: Model de fetching, utilizado para saber se o componente está fazendo fetching de dados.
-    type: Boolean
-    examples: [v-model:fetching="isFetching"]
-    model: true
-
-  fields:
-    desc: Model de fields, utilizado para recuperar os fields fora do template.
-    default: {}
-    type: Object
-    examples: [v-model:fields="fields"]
-    model: true
-
-  form-props:
-    desc: Repassa todas as props/eventos para o `QForm`.
-    default: {}
-    type: Object
-    examples: ['{ onValidationError: ref => validationErrorHandler(ref) }']
-
-  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:metadata="metadata"]
-    model: true
-
-  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="values"]
-    model: true
-
-  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: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-notify-success:
-    desc: Controla se vai ter ou não notificação de sucesso ao finalizar o submit.
-    default: true
-    type: Boolean
-
-  use-submit-button:
-    desc: Controla se vai ter ou não botão de submit.
-    default: true
-    type: Boolean
-
-slots:
-  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).
-
-  fetch-error:
-    desc: Slot disponibilizado em caso de fetchError.
-
-  footer:
-    desc: Slot para acessar o footer.
-
-  header:
-    desc: Slot para acessar o header.
-
-events:
-  '@fetch-success -> function(response, modelValue)':
-    desc: Dispara quando a action "fetchSingle" é executada com sucesso.
-    params:
-      response:
-        desc: Retorna todos os dados "cru" respondido pelo fetch.
-        type: Object
-
-      modelValue:
-        desc: Retorna o model anterior ao fetch.
-        type: Object
-
-  '@fetch-error -> function(error)':
-    desc: Dispara quando a action "fetchSingle" cai em uma exceção.
-    params:
-      error:
-        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:
-      value:
-        desc: usado para v-model.
-        type: Object
-
-  '@update:submitting -> function(value)':
-    desc: Dispara logo antes da action do modo "replace" ou "update" e ao cair no bloco "finally", ou seja, quando começar o submeter e após terminar.
-    params:
-      value:
-        desc: Retorna se está ou não submetendo os dados.
-        type: Boolean
-
-  '@update:fields -> function(value)':
-    desc: Dispara quando a action "fetchSingle" é executada com sucesso, é chamado antes do evento "fetch-success".
-    params:
-      value:
-        desc: fields.
-        type: Object
-
-  '@update:errors -> function(value)':
-    desc: Dispara quando a action "fetchSingle" é chamada.
-    params:
-      value:
-        desc: Errors durante o fetch.
-        type: Object
-
-  '@update:metadata -> function(value)':
-    desc: Dispara quando a action "fetchSingle" acontece com sucesso, é chamado antes do evento "fetch-success".
-    params:
-      value:
-        desc: metadata.
-        type: Object
-
-  '@update:fetching -> function(value)':
-    desc: Dispara logo antes da action "fetchSingle" e ao cair no bloco "finally", ou seja, quando começar o fetching e após terminar.
-    params:
-      value:
-        desc: Retorna se está ou não fazendo fetching de dados.
-        type: Boolean
-
-  '@submit-success -> function(response, modelValue)':
-    desc: Dispara quando a action "submit" é executada com sucesso.
-    params:
-      response:
-        desc: Retorna todos os dados "cru" respondido pelo submit.
-        type: Object
-
-      modelValue:
-        desc: Retorna o model anterior ao submit.
-        type: Object
-
-  '@submit-error -> function(error)':
-    desc: Dispara quando a action "submit" cai em uma exceção.
-    params:
-      error:
-        desc: Retorna todos os dados "cru" respondido na exceção do submit.
-        type: Object
-
-selectors:
-  'form-view-cancel-btn-[entity]':
-    desc: Seletor do botão de cancelar.
-    examples: ['data-cy="form-view-cancel-btn-users"']
-
-  'form-view-submit-btn-[entity]':
-    desc: Seletor do botão de salvar.
-    examples: ['data-cy="form-view-submit-btn-users"']
+type: component
+
+meta:
+  desc: Componente para C.R.U.D. responsável pela pela criação (Create) e edição (Update).
+
+props:
+  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 "voltar".
+    default: Voltar
+    type: String
+
+  cancel-route:
+    desc: Configuração do botão de "cancelar", caso seja "false", não exibe o botão, caso precise passar uma path direto use como string, caso precisar passar uma configuração como "name" ou "params" passe como objeto, agora se precisar de uma logica especifica quando clicar no botão de cancelar, você pode passar uma função que ela será executado.
+    default: "''"
+    type: [Boolean, Object, String, Function]
+    examples: [
+      /users,
+      false,
+      "{ name: 'UsersForm', params: { id: 'uuid-1' } }",
+      () => alert('Lógica especifica.')
+    ]
+
+  custom-id:
+    desc: Por padrão, o componente vai pegar o "id" que vem como parâmetro na url, caso queira que o id seja diferente da url, use esta prop.
+    type: String
+    examples: ['my-custom-id']
+
+  disable:
+    desc: Desabilita o submit.
+    type: Boolean
+
+  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
+
+  errors:
+    desc: Model de errors, utilizado para recuperar os errors fora do template.
+    default: {}
+    type: Object
+    examples: [v-model:errors="errors"]
+    model: true
+
+  fetching:
+    desc: Model de fetching, utilizado para saber se o componente está fazendo fetching de dados.
+    type: Boolean
+    examples: [v-model:fetching="isFetching"]
+    model: true
+
+  fields:
+    desc: Model de fields, utilizado para recuperar os fields fora do template.
+    default: {}
+    type: Object
+    examples: [v-model:fields="fields"]
+    model: true
+
+  form-props:
+    desc: Repassa todas as props/eventos para o `QForm`.
+    default: {}
+    type: Object
+    examples: ['{ onValidationError: ref => validationErrorHandler(ref) }']
+
+  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:metadata="metadata"]
+    model: true
+
+  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="values"]
+    model: true
+
+  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: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-notify-success:
+    desc: Controla se vai ter ou não notificação de sucesso ao finalizar o submit.
+    default: true
+    type: Boolean
+
+  use-submit-button:
+    desc: Controla se vai ter ou não botão de submit.
+    default: true
+    type: Boolean
+
+slots:
+  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).
+
+  fetch-error:
+    desc: Slot disponibilizado em caso de fetchError.
+
+  footer:
+    desc: Slot para acessar o footer.
+
+  header:
+    desc: Slot para acessar o header.
+
+events:
+  '@fetch-success -> function(response, modelValue)':
+    desc: Dispara quando a action "fetchSingle" é executada com sucesso.
+    params:
+      response:
+        desc: Retorna todos os dados "cru" respondido pelo fetch.
+        type: Object
+
+      modelValue:
+        desc: Retorna o model anterior ao fetch.
+        type: Object
+
+  '@fetch-error -> function(error)':
+    desc: Dispara quando a action "fetchSingle" cai em uma exceção.
+    params:
+      error:
+        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:
+      value:
+        desc: usado para v-model.
+        type: Object
+
+  '@update:submitting -> function(value)':
+    desc: Dispara logo antes da action do modo "replace" ou "update" e ao cair no bloco "finally", ou seja, quando começar o submeter e após terminar.
+    params:
+      value:
+        desc: Retorna se está ou não submetendo os dados.
+        type: Boolean
+
+  '@update:fields -> function(value)':
+    desc: Dispara quando a action "fetchSingle" é executada com sucesso, é chamado antes do evento "fetch-success".
+    params:
+      value:
+        desc: fields.
+        type: Object
+
+  '@update:errors -> function(value)':
+    desc: Dispara quando a action "fetchSingle" é chamada.
+    params:
+      value:
+        desc: Errors durante o fetch.
+        type: Object
+
+  '@update:metadata -> function(value)':
+    desc: Dispara quando a action "fetchSingle" acontece com sucesso, é chamado antes do evento "fetch-success".
+    params:
+      value:
+        desc: metadata.
+        type: Object
+
+  '@update:fetching -> function(value)':
+    desc: Dispara logo antes da action "fetchSingle" e ao cair no bloco "finally", ou seja, quando começar o fetching e após terminar.
+    params:
+      value:
+        desc: Retorna se está ou não fazendo fetching de dados.
+        type: Boolean
+
+  '@submit-success -> function(response, modelValue)':
+    desc: Dispara quando a action "submit" é executada com sucesso.
+    params:
+      response:
+        desc: Retorna todos os dados "cru" respondido pelo submit.
+        type: Object
+
+      modelValue:
+        desc: Retorna o model anterior ao submit.
+        type: Object
+
+  '@submit-error -> function(error)':
+    desc: Dispara quando a action "submit" cai em uma exceção.
+    params:
+      error:
+        desc: Retorna todos os dados "cru" respondido na exceção do submit.
+        type: Object
+
+selectors:
+  'form-view-cancel-btn-[entity]':
+    desc: Seletor do botão de cancelar.
+    examples: ['data-cy="form-view-cancel-btn-users"']
+
+  'form-view-submit-btn-[entity]':
+    desc: Seletor do botão de salvar.
+    examples: ['data-cy="form-view-submit-btn-users"']