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

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"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasInput.json

@@ -0,0 +1,40 @@
+{
+  "type": "component",
+  "mixins": [
+    "quasar/dist/api/QInput.json"
+  ],
+  "meta": {
+    "desc": "Componente para input que implementa o \"QInput\" repassando propriedades, slots e eventos."
+  },
+  "props": {
+    "model-value": {
+      "desc": "Model do componente.",
+      "type": "String",
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "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"
+    }
+  },
+  "events": {
+    "@update:model-value -> function (value)": {
+      "desc": "Dispara toda vez que o model é atualizado, também utilizado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do v-model",
+          "type": "String"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasLabel.json

@@ -0,0 +1,40 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para controlar textos que separam conteúdos, formatando com um sufixo quando existe um contador."
+  },
+  "props": {
+    "count": {
+      "desc": "Contador que vai ficar ao lado do texto.",
+      "default": 0,
+      "type": "Number"
+    },
+    "label": {
+      "desc": "Texto a ser exibido.",
+      "type": "String"
+    },
+    "margin": {
+      "desc": "Espaçamento entre o texto e o contador.",
+      "default": "sm",
+      "type": "String",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot para acessar elemento do texto.",
+      "scope": {
+        "label-with-suffix": {
+          "desc": "Objeto com texto formatado contendo ou não um sufixo",
+          "type": "String"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasLayout.json

@@ -0,0 +1,47 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente de layout que engloba o \"QasAppBar\" e \"QasAppMenu\"."
+  },
+  "props": {
+    "app-bar-props": {
+      "desc": "Propriedades do \"QasAppBar\".",
+      "default": {},
+      "type": "Object"
+    },
+    "app-menu-props": {
+      "desc": "Propriedades do \"QasAppMenu\".",
+      "default": {
+        "animation": 500
+      },
+      "type": "Object"
+    },
+    "model-value": {
+      "desc": "Model do componente, responsável por abrir/fechar menu lateral.",
+      "default": true,
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "app-bar": {
+      "desc": "Slot para substituir o \"QasAppBar\"."
+    },
+    "app-menu": {
+      "desc": "Slot para substituir o \"QasAppMenu\"."
+    },
+    "default": {
+      "desc": "Slot para substituir o \"QPageContainer\"."
+    }
+  },
+  "events": {
+    "@update:model-value -> function(value)": {
+      "desc": "Dispara quando o model-value altera, também usado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Valor do mode-value.",
+          "type": "Boolean"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasListItems.json

@@ -0,0 +1,72 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para listagem."
+  },
+  "props": {
+    "icon-props": {
+      "desc": "Props do [QIcon](https://quasar.dev/vue-components/icon#introduction)",
+      "default": {
+        "color": "primary",
+        "name": "o_chevron_right"
+      },
+      "type": "Object"
+    },
+    "list": {
+      "desc": "Lista para ser selecionada.",
+      "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,
+      "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,
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "item-section-left": {
+      "desc": "Slot para acessar seção da esquerda.",
+      "scope": {
+        "item": {
+          "desc": "Item dentro da listagem, vai depender do que foi passado.",
+          "type": "Object"
+        },
+        "index": {
+          "desc": "Posição do item na lista.",
+          "type": "Number"
+        }
+      }
+    },
+    "item-section-side": {
+      "desc": "Slot para acessar seção da direita, onde fica o Ícone.",
+      "scope": {
+        "item": {
+          "desc": "Item dentro da listagem, vai depender do que foi passado.",
+          "type": "Object"
+        },
+        "index": {
+          "desc": "Posição do item na lista.",
+          "type": "Number"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasListView.json

@@ -0,0 +1,161 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para C.R.U.D. responsável pela parte de listagem (Read)."
+  },
+  "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"
+    },
+    "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 \"fetchList\" do modulo correspondente a \"entity\".",
+      "type": "String"
+    },
+    "results": {
+      "model": true,
+      "desc": "Model de results, utilizado para recuperar a lista retornada pelo componente.",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "v-model:results=\"results\""
+      ]
+    },
+    "fields": {
+      "model": true,
+      "desc": "Model de fields, utilizado para recuperar os fields fora do template.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model:fields=\"fields\""
+      ]
+    },
+    "errors": {
+      "model": true,
+      "desc": "Model de errors, utilizado para recuperar os errors fora do template.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model:errors=\"errors\""
+      ]
+    },
+    "metadata": {
+      "model": true,
+      "desc": "Model de metadata, utilizado para recuperar os metadata fora do template.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "v-model:metadata=\"metadata\""
+      ]
+    },
+    "fetching": {
+      "model": true,
+      "desc": "Model de fetching, utilizado para saber se o componente está fazendo fetching de dados.",
+      "type": "Boolean",
+      "examples": [
+        "v-model:fetching=\"isFetching\""
+      ]
+    },
+    "disable-refresh": {
+      "desc": "Desabilita o [pull-to-refresh](https://quasar.dev/vue-components/pull-to-refresh#basic).",
+      "type": "Boolean"
+    },
+    "use-filter": {
+      "desc": "Controla se o componente vai usar ou não o componente \"QasFilters\".",
+      "default": true,
+      "type": "Boolean"
+    },
+    "filters-props": {
+      "desc": "Repassa as props para o componente \"QasFilters\".",
+      "default": {},
+      "type": "Object"
+    }
+  },
+  "slots": {
+    "header": {
+      "desc": "Slot para acessar o header."
+    },
+    "filter": {
+      "desc": "Slot para acessar o filtro."
+    },
+    "default": {
+      "desc": "Slot para ter o conteúdo principal (dentro do main)."
+    },
+    "empty-results": {
+      "desc": "Slot acessar quando a listagem está vazia."
+    },
+    "footer": {
+      "desc": "Slot para acessar o footer."
+    }
+  },
+  "events": {
+    "@update:results -> function(value)": {
+      "desc": "Dispara quando a action \"fetchList\" é executada com sucesso, é chamado antes do evento \"fetch-success\".",
+      "params": {
+        "value": {
+          "desc": "lista retornada no \"fetchList\".",
+          "type": "Array"
+        }
+      }
+    },
+    "@update:fields -> function(value)": {
+      "desc": "Dispara quando a action \"fetchList\" é executada com sucesso, é chamado antes do evento \"fetch-success\".",
+      "params": {
+        "value": {
+          "desc": "fields.",
+          "type": "Object"
+        }
+      }
+    },
+    "@update:errors -> function(value)": {
+      "desc": "Dispara quando a action \"fetchList\" é chamada.",
+      "params": {
+        "value": {
+          "desc": "Errors durante o fetch.",
+          "type": "Object"
+        }
+      }
+    },
+    "@update:metadata -> function(value)": {
+      "desc": "Dispara quando a action \"fetchList\" 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 \"fetchList\" 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 \"fetchList\" é 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 \"fetchList\" cai em uma exceção.",
+      "params": {
+        "value": {
+          "desc": "Retorna todos os dados \"cru\" respondido na exceção do fetch.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasMap.json

@@ -0,0 +1,41 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para gerar google maps."
+  },
+  "props": {
+    "center-position": {
+      "desc": "Opções de localização onde o mapa vai ser centralizado.",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "{ lat: -21.17663, lng: -47.820839 }"
+      ]
+    },
+    "markers": {
+      "desc": "Marcadores (pin) do mapa.",
+      "default": [],
+      "type": "Array"
+    },
+    "use-popup": {
+      "desc": "Controla se os markers vai ter popup ou não.",
+      "type": "Boolean"
+    },
+    "zoom": {
+      "desc": "Zoom do mapa.",
+      "default": 17,
+      "type": "Number"
+    }
+  },
+  "events": {
+    "@update-position -> function(value)": {
+      "desc": "Dispara muda a posição do marker.",
+      "params": {
+        "value": {
+          "desc": "Nova posição.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}