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

package/dist/api/QasActions.json

@@ -0,0 +1,40 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Área de ações para páginas que lidam com botões primários e secundários, como um formulário ou caixa de diálogo."
+  },
+  "props": {
+    "align": {
+      "desc": "Alinhamento dos elementos.",
+      "default": "end",
+      "type": "String",
+      "examples": [
+        "start",
+        "end",
+        "between",
+        "around",
+        "center"
+      ]
+    },
+    "gutter": {
+      "desc": "Espaçamento entre os elementos.",
+      "default": "md",
+      "type": "String",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    }
+  },
+  "slots": {
+    "primary": {
+      "desc": "Slot para ação primaria (ex: botão de salvar), em telas menores que sm, se torna o primeiro elemento."
+    },
+    "secondary": {
+      "desc": "Slot para ação secundaria (ex: botão de cancelar), em telas menores que sm, se torna o segundo elemento."
+    }
+  }
+}

package/dist/api/QasActionsMenu.json

@@ -0,0 +1,64 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para abrir um menu de ação a partir de um botão, muito utilizado em tela de edição."
+  },
+  "props": {
+    "icon": {
+      "desc": "Ícone do botão.",
+      "default": "o_settings",
+      "type": "String",
+      "examples": [
+        "start",
+        "end",
+        "between",
+        "around",
+        "center"
+      ]
+    },
+    "label": {
+      "desc": "Rotulo do botão.",
+      "default": "Configurações",
+      "type": "String"
+    },
+    "list": {
+      "desc": "Lista de items que vão ser criados dentro do menu de ações.",
+      "default": "{}",
+      "type": "Object",
+      "examples": [
+        "{ delete: { icon: 'o_visibility', label: 'Visualizar', handler: () => alert('handler ativado') } }"
+      ]
+    },
+    "delete-label": {
+      "desc": "Rótulo do botão de deletar.",
+      "default": "Excluir",
+      "type": "String"
+    },
+    "delete-icon": {
+      "desc": "Ícone do botão de deletar.",
+      "default": "o_delete",
+      "type": "String"
+    },
+    "delete-props": {
+      "desc": "Props para repassar para o componente \"QasDelete\", caso seja um objeto vazio, o componente não vai adicionar a opção de deletar por padrão.",
+      "default": {},
+      "type": "Object"
+    }
+  },
+  "slots": {
+    "[nome-da-chave]": {
+      "desc": "Slot dinâmico gerado a partir das chaves dentro do objeto da prop \"list\"",
+      "tag": "Escopo",
+      "scope": {
+        "item": {
+          "desc": "Escopo que retorna o item atual, valor depende do que foi passado na prop list.",
+          "default": "{}",
+          "type": "Object",
+          "examples": [
+            " { icon: 'o_delete', label: 'Delete', } "
+          ]
+        }
+      }
+    }
+  }
+}

package/dist/api/QasAlert.json

@@ -0,0 +1,40 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Cria um seção para alertar sobre um conteúdo."
+  },
+  "props": {
+    "model-value": {
+      "desc": "Model do componente, controla se o componente aparece ou não.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "title": {
+      "desc": "Título do componente.",
+      "type": "String"
+    },
+    "text": {
+      "desc": "Texto do componente.",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot para acessar o conteúdo gerado pela prop \"text\""
+    },
+    "header": {
+      "desc": "Slot para acessar o conteúdo gerado pela prop \"title\""
+    }
+  },
+  "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": "Boolean"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasAppBar.json

@@ -0,0 +1,52 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Cria um seção para alertar sobre um conteúdo."
+  },
+  "props": {
+    "is-auth": {
+      "desc": "Controla se mostra ou não o menu de usuário.",
+      "type": "Boolean"
+    },
+    "title": {
+      "desc": "Título do header, normalmente usado como título da aplicação.",
+      "type": "String"
+    },
+    "notifications": {
+      "desc": "Ícone de notificação que fica ao lado do menu de usuário.",
+      "type": "Object",
+      "default": {}
+    },
+    "user": {
+      "desc": "Informações de usuário para ser usado no menu.",
+      "type": "Object",
+      "default": {},
+      "examples": [
+        " { photo: 'minha-img', name: 'Eduardo Lima', email: 'eduardolima@gmail.com' } "
+      ]
+    }
+  },
+  "slots": {
+    "user": {
+      "desc": "Slot para acessar o menu de usuário",
+      "scope": {
+        "user": {
+          "desc": "Informações de usuário para ser usado no menu, valor vai depender da prop \"user\".",
+          "type": "Object",
+          "default": {}
+        }
+      }
+    },
+    "tools": {
+      "desc": "Slot para acessar o header após o elemento de notificações."
+    }
+  },
+  "events": {
+    "@sign-out -> function()": {
+      "desc": "Dispara quando o botão de \"sair\" é clicado."
+    },
+    "@toggle-menu -> function()": {
+      "desc": "Dispara quando o botão de \"hambúrguer\" é clicado para abrir o menu lateral."
+    }
+  }
+}

package/dist/api/QasAppMenu.json

@@ -0,0 +1,38 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Menu lateral."
+  },
+  "props": {
+    "model-value": {
+      "desc": "Model do componente, controla quando o menu lateral é aberto e fechado.",
+      "default": true,
+      "type": "Boolean"
+    },
+    "items": {
+      "desc": "Itens do menu.",
+      "type": "Array",
+      "default": []
+    },
+    "title": {
+      "desc": "Título que vai ficar no label do select de módulos.",
+      "type": "String"
+    },
+    "modules": {
+      "desc": "Lista de módulos que o usuário tem acesso para navegar.",
+      "type": "Array",
+      "default": []
+    }
+  },
+  "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": "Boolean"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasAvatar.json

@@ -0,0 +1,44 @@
+{
+  "type": "component",
+  "mixins": [
+    "quasar/dist/api/QAvatar.json"
+  ],
+  "meta": {
+    "desc": "Cria um elemento escalável e colorido que pode ter texto, ícone ou imagem em sua forma. Usa como base o componente [QAvatar](https://quasar.dev/vue-components/avatar#introduction)."
+  },
+  "props": {
+    "color": {
+      "desc": "Cor de fundo (background-color).",
+      "type": "String",
+      "examples": [
+        "primary",
+        "positive"
+      ]
+    },
+    "dark": {
+      "desc": "Habilita o modo escuro.",
+      "type": "Boolean"
+    },
+    "icon": {
+      "desc": "Ícone de fundo do avatar que vai aparecer caso não tenha imagem nem título.",
+      "default": "o_error",
+      "type": "String"
+    },
+    "image": {
+      "desc": "Imagem de fundo (maior prioridade).",
+      "type": "String"
+    },
+    "text-color": {
+      "desc": "Cor de texto (caso não tenha imagem).",
+      "default": "primary",
+      "type": "String"
+    },
+    "title": {
+      "desc": "Caso não tenha imagem, o avatar vai aparecer com a inicial do titulo.",
+      "type": "String",
+      "examples": [
+        "John Doe"
+      ]
+    }
+  }
+}

package/dist/api/QasBreakline.json

@@ -6,7 +6,7 @@
   "props": {
     "split": {
       "default": "\\n",
-      "desc": "Caracter ou conjunto de caracteres que serão utilizados para dividir o texto.",
+      "desc": "Carácter ou conjunto de caracteres que serão utilizados para dividir o texto.",
       "type": "String"
     },
     "tag": {

package/dist/api/QasBtn.json

@@ -4,12 +4,13 @@
     "quasar/dist/api/QBtn.json"
   ],
   "meta": {
-    "desc": "O mesmo botão do Quasar (QBtn), mas com o nosso estilo."
+    "desc": "O mesmo botão do Quasar (QBtn), mas com o nosso estilo, tem acesso a todas propriedades do componente do quasar. Tem a função de criar gatilhos para ações. Eles podem ser utilizados isoladamente ou ​​como parte de outros componentes de padrões maiores, como formulários, caixas de diálogo e feedbacks."
   },
   "props": {
     "hide-label-on-small-screen": {
-      "desc": "Esconde o rótulo do botão quando o tamanho da tela for pequeno.",
-      "type": "Boolean"
+      "desc": "Esconde o rótulo (label) do botão quando o tamanho da tela for pequeno.",
+      "type": "Boolean",
+      "default": "false"
     }
   }
 }

package/dist/api/QasCard.json

@@ -0,0 +1,52 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente de card."
+  },
+  "props": {
+    "bg-image-position": {
+      "desc": "Posição da imagem \"background-position\".",
+      "default": "center",
+      "type": "String"
+    },
+    "form-mode": {
+      "desc": "Modo de formulário, altera o estilo quando está em uma pagina de formulário.",
+      "type": "Boolean"
+    },
+    "gutter": {
+      "desc": "Espaçamento dentro <q-card-section /> onde fica o slot \"default\".",
+      "default": "sm",
+      "type": "String",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    },
+    "images": {
+      "desc": "Imagens do carousel.",
+      "default": [],
+      "type": "Array"
+    },
+    "use-header": {
+      "desc": "Controla se vai ter ou não o header com carousel.",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "header": {
+      "desc": "Slot para acessar área no lugar do \"<q-carousel />\"."
+    },
+    "carousel-header": {
+      "desc": "Slot para acessar usar de header do \"<q-carousel />\"."
+    },
+    "default": {
+      "desc": "Slot para acessar conteúdo dentro do \"<q-card-section />\"."
+    },
+    "actions": {
+      "desc": "Slot para acessar conteúdo de ações como botão."
+    }
+  }
+}

package/dist/api/QasCheckboxGroup.json

@@ -0,0 +1,38 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para gerar dinamicamente checkbox agrupados."
+  },
+  "props": {
+    "options": {
+      "desc": "Opções para gerar os checkbox.",
+      "default": [],
+      "type": "Array"
+    },
+    "model-value": {
+      "desc": "Model do componente, usado para v-model.",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "v-model\"value\""
+      ],
+      "model": true
+    },
+    "inline": {
+      "desc": "Controla se o componente vai aparece em linha ou em bloco.",
+      "default": true,
+      "type": "Boolean"
+    }
+  },
+  "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": []
+        }
+      }
+    }
+  }
+}

package/dist/api/QasCopy.json

@@ -0,0 +1,29 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Copia algum texto para o clipboard após clicar no botão."
+  },
+  "props": {
+    "icon": {
+      "desc": "Ícone para mostrar no botão.",
+      "type": "String",
+      "default": "o_file_copy"
+    },
+    "size": {
+      "desc": "Tamanho do botão.",
+      "type": "String",
+      "default": "xs",
+      "examples": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
+    },
+    "text": {
+      "desc": "Texto a ser copiado.",
+      "type": "String"
+    }
+  }
+}

package/dist/api/QasDateTimeInput.json

@@ -0,0 +1,60 @@
+{
+  "type": "component",
+  "mixins": [
+    "@bildvitta/quasar-ui-asteroid/dist/api/QasInput.json"
+  ],
+  "meta": {
+    "desc": "Componente de input data e hora, implementa o \"QasInput\"."
+  },
+  "props": {
+    "date-mask": {
+      "desc": "Máscara do componente de input de data.",
+      "default": "DD/MM/YYYY",
+      "type": "String"
+    },
+    "date-only": {
+      "desc": "Habilita o componente para usar somente data.",
+      "type": "Boolean"
+    },
+    "date-props": {
+      "desc": "Propriedades do QDate (https://quasar.dev/vue-components/date#introduction).",
+      "default": {},
+      "type": "Object"
+    },
+    "gmt": {
+      "desc": "Utilizado para se usar junto da prop \"date-only\" ou \"time-only\", caso \"gmt\" for \"true\", o model sempre vai ser retornado no padrão ISO 8601, independente ser apenas um campo somente de data ou hora.",
+      "type": "Boolean"
+    },
+    "time-mask": {
+      "desc": "Máscara do componente de input de hora.",
+      "default": "HH:mm",
+      "type": "String"
+    },
+    "time-only": {
+      "desc": "Habilita o componente para usar somente hora.",
+      "type": "Boolean"
+    },
+    "time-props": {
+      "desc": "Propriedades do QTime (https://quasar.dev/vue-components/time#introduction).",
+      "default": {},
+      "type": "Object"
+    },
+    "model-value": {
+      "desc": "Model do componente, usado para v-model.",
+      "default": "",
+      "type": "String",
+      "model": true
+    }
+  },
+  "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/QasDelete.json

@@ -0,0 +1,69 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para C.R.U.D. responsável por deletar (Delete)."
+  },
+  "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"
+    },
+    "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"
+      ]
+    },
+    "dialog-props": {
+      "desc": "Props para ser repassada para o componente \"QasDialog\"",
+      "default": {},
+      "type": "Object"
+    },
+    "url": {
+      "desc": "Envia como parâmetro para a action \"fetchSingle\" do modulo correspondente a \"entity\".",
+      "type": "String"
+    },
+    "tag": {
+      "desc": "Tag do componente.",
+      "default": "qas-btn",
+      "type": "String",
+      "examples": [
+        "q-item"
+      ]
+    },
+    "deleting": {
+      "desc": "Model para saber se está deletando.",
+      "type": "Boolean",
+      "examples": [
+        "v-model:deleting=\"isDeleting\""
+      ],
+      "model": true
+    },
+    "use-auto-delete-route": {
+      "desc": "Controla se sempre que deletar com sucesso um item, remove todas as rotas do histórico de rotas que contenha id do item deletado.",
+      "default": true,
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot para acessar dentro do componente."
+    }
+  },
+  "events": {
+    "@success -> function()": {
+      "desc": "Dispara quando o componente deleta com sucesso."
+    },
+    "@error -> function(value)": {
+      "desc": "Dispara quando acontece algum erro na hora de deletar.",
+      "params": {
+        "value": {
+          "desc": "Erro retornado.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasDialog.json

@@ -0,0 +1,109 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente de dialog."
+  },
+  "props": {
+    "actions-props": {
+      "desc": "Props repassadas para o \"QasActions\".",
+      "default": {},
+      "type": "Object"
+    },
+    "cancel": {
+      "desc": "Props para o botão de cancelar, pode ser objeto com as propriedades ou um boolean, caso for \"false\", remove o botão de cancelar.",
+      "default": "{ label: 'Cancelar', outline: true }",
+      "type": [
+        "Object",
+        "Boolean"
+      ],
+      "examples": [
+        "{ label: 'Meu botão de cancelar', onClick: () => alert('fui clicado!') }"
+      ]
+    },
+    "card": {
+      "desc": "Objeto contendo as informações para serem exibidas dentro do dialog como \"title\" e \"description\".",
+      "default": {},
+      "type": "Object",
+      "examples": [
+        "{ title: 'Meu título', description: 'Minha descrição' }"
+      ]
+    },
+    "card-props": {
+      "desc": "Props repassadas para o componente \"<q-card />\".",
+      "default": {},
+      "type": "Object"
+    },
+    "max-width": {
+      "desc": "Tamanho máximo do dialog.",
+      "type": "String"
+    },
+    "min-width": {
+      "desc": "Tamanho mínimo do dialog.",
+      "type": "String"
+    },
+    "ok": {
+      "desc": "Props para o botão de confirmar (ok), pode ser objeto com as propriedades ou um boolean, caso for \"false\", remove o botão de confirmar.",
+      "default": "{ label: 'Ok', outline: type: this.ok?.type || this.useForm ? 'submit' : 'button' }",
+      "debugger": true,
+      "type": [
+        "Object",
+        "Boolean"
+      ],
+      "examples": [
+        "{ label: 'Meu botão de confirmar', onClick: () => alert('fui clicado!') }"
+      ]
+    },
+    "persistent": {
+      "desc": "Define se o dialog vai fechar ou não após clicar fora do dialog.",
+      "default": true,
+      "type": "Object"
+    },
+    "use-form": {
+      "desc": "Define se a tag onde fica a descrição no dialog vai ser um \"<q-form />\" ou \"<div />\".",
+      "type": "Boolean"
+    },
+    "model-value": {
+      "desc": "Model do componente, abre ou fecha o dialog.",
+      "type": "Boolean",
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "model": true
+    },
+    "use-close-icon": {
+      "desc": "Define se vai ter ou não Ícone de fechar o dialog.",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "header": {
+      "desc": "Slot para o título."
+    },
+    "description": {
+      "desc": "Slot para descrição."
+    },
+    "actions": {
+      "desc": "Slot para ações (botões por exemplo)."
+    }
+  },
+  "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": "Boolean"
+        }
+      }
+    },
+    "@validate: -> function (value)": {
+      "desc": "Dispara se a prop \"useForm\" for \"true\" e após um submit.",
+      "params": {
+        "value": {
+          "desc": "Retorna se os campos passou ou não na validação",
+          "type": "Boolean"
+        }
+      }
+    }
+  }
+}