@bildvitta/quasar-ui-asteroid 3.0.0-alpha.1 → 3.0.0-alpha.2

package/dist/api/QasDialogRouter.json

@@ -0,0 +1,31 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente que abre uma pagina dentro de um \"QasDialog\", porém se você recarregar a pagina, ela é iniciada na pagina que foi carregada inicialmente dentro do QasDialog."
+  },
+  "events": {
+    "error": {
+      "desc": "Dispara caso não consiga carregar o componente.",
+      "params": {
+        "error": {
+          "desc": "Erro retornado.",
+          "type": "Object"
+        }
+      }
+    },
+    "hide": {
+      "desc": "Dispara quando o QasDialog é fechado."
+    }
+  },
+  "methods": {
+    "@show (route) => undefined": {
+      "desc": "Função para abrir o a pagina dentro do dialog.",
+      "route": {
+        "value": {
+          "desc": "Objeto de roda, igual usado dentro do $router.push(route) por exemplo.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasField.json

@@ -0,0 +1,56 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para criação de campos dinâmicos."
+  },
+  "props": {
+    "error": {
+      "desc": "Array ou String contendo a mensagem de erro.",
+      "type": [
+        "Array",
+        "String"
+      ]
+    },
+    "field": {
+      "desc": "Field contendo informações necessárias para a criação do campo correspondente.",
+      "default": {},
+      "required": true,
+      "type": "Object",
+      "examples": [
+        "{ name: 'email', type: 'email', label: 'E-mail' }"
+      ]
+    },
+    "model-value": {
+      "desc": "Model do componente, usado para o v-model.",
+      "default": "undefined",
+      "type": [
+        "Object",
+        "Array",
+        "String",
+        "Number",
+        "Boolean"
+      ],
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "model": true
+    }
+  },
+  "events": {
+    "@update:model-value -> function(value)": {
+      "desc": "Dispara quando o model-value altera, também usado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do model.",
+          "type": [
+            "Object",
+            "Array",
+            "String",
+            "Number",
+            "Boolean"
+          ]
+        }
+      }
+    }
+  }
+}

package/dist/api/QasFilters.json

@@ -0,0 +1,111 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para criação de filtros dinâmicos."
+  },
+  "props": {
+    "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"
+    },
+    "use-badges": {
+      "desc": "Habilita ou não os \"chips\" mostrando os filtros ativos.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-filter-button": {
+      "desc": "Habilita ou não o botão com menu na lateral esquerda.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-search": {
+      "desc": "Habilita ou não o campo text de busca.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "use-search-on-type": {
+      "desc": "Habilita ou não o filtro de busca sempre que o usuário digita.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "search-placeholder": {
+      "desc": "Placeholder do campo de busca.",
+      "default": "Pesquisar...",
+      "type": "String"
+    },
+    "url": {
+      "desc": "Envia como parâmetro para a action \"fetchFilters\" do modulo correspondente a \"entity\".",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "search": {
+      "desc": "Slot para seção do campo de busca.",
+      "scope": {
+        "filter": {
+          "desc": "função usada para fazer o filtro",
+          "type": "Function"
+        }
+      }
+    },
+    "filter-button": {
+      "desc": "Slot para seção do botão do menu lateral.",
+      "scope": {
+        "filter": {
+          "desc": "função usada para fazer o filtro",
+          "type": "Function"
+        }
+      }
+    },
+    "default": {
+      "desc": "Slot para acessar o final do componente.",
+      "scope": {
+        "filter": {
+          "desc": "Função usada para fazer o filtro",
+          "type": "Function"
+        },
+        "filters": {
+          "desc": "Objeto que retorna os filtros ativos",
+          "default": {},
+          "type": "Object"
+        },
+        "remove-filter": {
+          "desc": "Função usada para remover os filtro",
+          "type": "Function",
+          "examples": [
+            "removeFilter({ name: '[nome-do-filtro]' })"
+          ]
+        },
+        "context": {
+          "desc": "Contexto referente a query da url.",
+          "default": {
+            "filters": {},
+            "page": 1
+          },
+          "type": "Object"
+        }
+      }
+    }
+  },
+  "events": {
+    "@fetch-success -> function(value)": {
+      "desc": "Dispara quando a action \"fetchFilters\" é 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 \"fetchFilters\" cai em uma exceção.",
+      "params": {
+        "value": {
+          "desc": "Retorna todos os dados \"cru\" respondido na exceção do fetch.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasFormGenerator.json

@@ -0,0 +1,92 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para criação de múltiplos campos dinâmicos a partir do componente `QasField`."
+  },
+  "props": {
+    "error": {
+      "desc": "Objeto contendo propriedades contendo a mensagem de erro.",
+      "default": {},
+      "type": "Object"
+    },
+    "fields": {
+      "desc": "Lista de field contendo informações necessárias para a criação do campo correspondente.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "{ email: { name: 'email', type: 'email', label: 'E-mail' } }"
+      ]
+    },
+    "fields-props": {
+      "desc": "Propriedade para repassar propriedades para cada campo individualmente.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "{ name: { dense: true, onClick: () => alert('Estou sendo clicado') } }"
+      ]
+    },
+    "order": {
+      "desc": "Altera ordem dos campos.",
+      "default": [],
+      "type": "Array"
+    },
+    "model-value": {
+      "desc": "Model do componente, usado para o v-model.",
+      "required": true,
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "model": true
+    },
+    "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",
+      "type": "String",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    }
+  },
+  "slots": {
+    "field-[nome-da-chave]": {
+      "desc": "Acessa o slot de um campo especifico.",
+      "scope": {
+        "field": {
+          "desc": "Payload do campo atual.",
+          "default": {},
+          "type": "Object"
+        }
+      }
+    }
+  },
+  "events": {
+    "@update:model-value -> function(value)": {
+      "desc": "Dispara quando o model-value altera, também usado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do model.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasFormView.json

@@ -0,0 +1,228 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para C.R.U.D. responsável pela pela criação (Create) e edição (Update)."
+  },
+  "props": {
+    "cancel-button": {
+      "desc": "Rótulo do botão \"cancelar\".",
+      "default": "Cancelar",
+      "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, e se precisar passar uma configuração como \"name\" ou \"params\" passe como objeto.",
+      "default": "''",
+      "type": [
+        "Boolean",
+        "Object",
+        "String"
+      ],
+      "examples": [
+        "/users",
+        "false",
+        "{ name: 'UsersForm', params: { id: 'uuid-1' } }"
+      ]
+    },
+    "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"
+    },
+    "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",
+      "type": "String"
+    },
+    "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
+    },
+    "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
+    },
+    "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": {},
+      "type": "Object",
+      "examples": [
+        "v-model:fields=\"fields\""
+      ],
+      "model": true
+    },
+    "errors": {
+      "desc": "Model de errors, utilizado para recuperar os errors fora do template.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model:errors=\"errors\""
+      ],
+      "model": true
+    },
+    "metadata": {
+      "desc": "Model de metadata, utilizado para recuperar os metadata fora do template.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model:metadata=\"metadata\""
+      ],
+      "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
+    }
+  },
+  "slots": {
+    "header": {
+      "desc": "Slot para acessar o header."
+    },
+    "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."
+    }
+  },
+  "events": {
+    "@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"
+        }
+      }
+    },
+    "@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

@@ -0,0 +1,54 @@
+{
+  "type": "component",
+  "mixins": [
+    "@bildvitta/quasar-ui-asteroid/dist/api/QasBox.json"
+  ],
+  "meta": {
+    "desc": "Componente para galeria, mostrando images dentro de um \"QasDialog\" ao clicar nelas."
+  },
+  "props": {
+    "carousel-next-icon": {
+      "desc": "Ícone dentro do carousel para passar para próxima imagem.",
+      "default": "o_chevron_right",
+      "type": "String"
+    },
+    "carousel-previous-icon": {
+      "desc": "Ícone dentro do carousel para passar para a imagem anterior.",
+      "default": "o_chevron_left",
+      "type": "String"
+    },
+    "height": {
+      "desc": "Altura da imagem (fora do dialog).",
+      "type": "String"
+    },
+    "initial-size": {
+      "desc": "Quantidade de imagens iniciais.",
+      "default": 6,
+      "type": "Number"
+    },
+    "images": {
+      "desc": "Imagens a serem exibidas.",
+      "default": 6,
+      "type": "Number"
+    },
+    "load-size": {
+      "desc": "Quantidade de fotos carregadas por vez.",
+      "default": 6,
+      "type": "Number"
+    },
+    "show-more-label": {
+      "desc": "Rótulo do botão de \"mostrar mais\".",
+      "default": "Ver mais",
+      "type": "String"
+    },
+    "use-load-all": {
+      "desc": "Carrega todas imagens de uma única vez.",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot para todo conteúdo onde fica o botão \"mostrar mais\"."
+    }
+  }
+}

package/dist/api/QasGridGenerator.json

@@ -0,0 +1,108 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para criação de textos dinâmicos."
+  },
+  "props": {
+    "content-class": {
+      "desc": "Classe de cada \"div\" pai referente ao resultado.",
+      "default": "",
+      "type": [
+        "Array",
+        "Object",
+        "String"
+      ]
+    },
+    "header-class": {
+      "desc": "Classe de cada \"header\" pai referente ao \"label\".",
+      "default": "text-bold",
+      "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": {},
+      "type": "Object",
+      "examples": [
+        "{ 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",
+      "type": "String",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    }
+  },
+  "slots": {
+    "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.",
+          "default": {},
+          "type": "Object"
+        }
+      }
+    },
+    "header": {
+      "desc": "Slot para o header.",
+      "scope": {
+        "field": {
+          "desc": "Conteúdo do field atual mais o resultado formatado.",
+          "default": {},
+          "type": "Object"
+        }
+      }
+    },
+    "content": {
+      "desc": "Slot para o conteúdo (content).",
+      "scope": {
+        "field": {
+          "desc": "Conteúdo do field atual mais o resultado formatado.",
+          "default": {},
+          "type": "Object"
+        }
+      }
+    }
+  }
+}