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

package/dist/api/QasSearchBox.json

@@ -0,0 +1,91 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para pesquisa utilizando Fuse.js."
+  },
+  "props": {
+    "empty-list-height": {
+      "desc": "Define altura do box quando a lista está vazia.",
+      "default": "100px",
+      "type": "String"
+    },
+    "fuse-options": {
+      "desc": "Opções do Fuse.js (https://fusejs.io/api/options.html).",
+      "default": "{ distance: 100, location: 0, maxPatternLength: 32, minMatchCharLength: 1, shouldSort: true, threshold: 0.1, tokenize: true }",
+      "debugger": true,
+      "type": "Object",
+      "examples": [
+        "{ keys: ['label'] }"
+      ]
+    },
+    "height": {
+      "desc": "Define altura do box quando a lista não está vazia.",
+      "default": "300px",
+      "type": "String"
+    },
+    "list": {
+      "desc": "Lista onde ocorrerá a busca (array de objetos).",
+      "default": [],
+      "type": "String"
+    },
+    "model-value": {
+      "desc": "Model do campo de pesquisa.",
+      "type": "String",
+      "examples": [
+        "v-model=\"search\""
+      ],
+      "model": true
+    },
+    "placeholder": {
+      "desc": "Placeholder do campo de pesquisa.",
+      "default": "Pesquisar",
+      "type": "String"
+    },
+    "use-empty-slot": {
+      "desc": "Controla o slot \"empty-result\".",
+      "default": true,
+      "type": "Boolean"
+    },
+    "results": {
+      "desc": "Model que retorna o resultado filtrado.",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "v-model:results=\"results\""
+      ],
+      "model": true
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Acesso ao conteúdo principal, só existe caso a busca retorne algum resultado."
+    },
+    "empty-result": {
+      "desc": "Acesso ao conteúdo quando a busca não retorne resultado e a prop \"useEmptySlot\" seja \"true\"."
+    }
+  },
+  "events": {
+    "@empty-result -> function ()": {
+      "desc": "Dispara toda vez que a pesquisa não retorna resultado."
+    },
+    "@update:model-value -> function (value)": {
+      "desc": "Dispara toda vez que o campo de busca é alterado, também utilizado para v-model",
+      "params": {
+        "value": {
+          "desc": "Novo valor do v-model",
+          "type": "String"
+        }
+      }
+    },
+    "@update:results -> function (value)": {
+      "desc": "Dispara toda vez que o campo de busca é alterado e acontece um novo filtro, também utilizado para v-model:results",
+      "params": {
+        "value": {
+          "desc": "Novo valor do v-model:results",
+          "default": [],
+          "type": "Array"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasSelect.json

@@ -0,0 +1,88 @@
+{
+  "type": "component",
+  "mixins": [
+    "quasar/dist/api/QSelect.json"
+  ],
+  "meta": {
+    "desc": "Componente para select que implementa o \"QSelect\" repassando propriedades, slots e eventos."
+  },
+  "props": {
+    "model-value": {
+      "desc": "Model do componente.",
+      "default": [],
+      "type": [
+        "Array",
+        "Object",
+        "String",
+        "Number"
+      ],
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "model": true
+    },
+    "fuse-options": {
+      "desc": "Opções do Fuse.js (https://fusejs.io/api/options.html).",
+      "type": "Object",
+      "debugger": true,
+      "default": {
+        "distance": 100,
+        "includeScore": true,
+        "keys": [
+          "label",
+          "value"
+        ],
+        "location": 0,
+        "maxPatternLength": 32,
+        "minMatchCharLength": 1,
+        "shouldSort": true,
+        "threshold": 0.1,
+        "tokenize": true
+      }
+    },
+    "label-key": {
+      "desc": "O componente internamente espera receber na propriedade \"options\" um array de objeto contendo \"label\" e \"value\", caso o seu objeto não tenha \"label\" mas um \"name\" por exemplo, você pode definir esta prop \"label-key\" como \"name\".",
+      "type": "String",
+      "examples": [
+        "label-key=\"name\""
+      ]
+    },
+    "no-option-label": {
+      "desc": "Rótulo padrão de quando os options estão vazios.",
+      "default": "Nenhum resultado foi encontrado.",
+      "type": "String"
+    },
+    "options": {
+      "desc": "Opções do select.",
+      "default": [],
+      "type": "Array"
+    },
+    "searchable": {
+      "desc": "Controla se vai ou não ter campo de busca no select.",
+      "type": "Boolean"
+    },
+    "value-key": {
+      "desc": "O componente internamente espera receber na propriedade \"options\" um array de objeto contendo \"label\" e \"value\", caso o seu objeto não tenha \"value\" mas um \"uuid\" por exemplo, você pode definir esta prop \"label-value\" como \"uuid\".",
+      "type": "String",
+      "examples": [
+        "value-key=\"uuid\""
+      ]
+    }
+  },
+  "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": [
+            "Array",
+            "Object",
+            "String",
+            "Number"
+          ]
+        }
+      }
+    }
+  }
+}

package/dist/api/QasSelectList.json

@@ -0,0 +1,134 @@
+{
+  "type": "component",
+  "mixins": [
+    "@bildvitta/quasar-ui-asteroid/dist/api/QasSearchBox.json"
+  ],
+  "meta": {
+    "desc": "Componente para selecionar dentro de uma lista com pesquisa utilizando o `QasSearchBox`."
+  },
+  "props": {
+    "delete-only": {
+      "desc": "Caso o \"modelValue\" tenha valor, ele remove tudo na lista que não esteja dentro do modelValue.",
+      "type": "Boolean"
+    },
+    "fuse-options": {
+      "desc": "Propriedade que será repassada para o \"QasSearchBox\".",
+      "default": "{ keys: ['label'] }",
+      "type": "Object"
+    },
+    "list": {
+      "desc": "Lista que será feita a seleção e pesquisa.",
+      "default": [],
+      "type": "Array"
+    },
+    "model-value": {
+      "desc": "Model do componente, que será controlado tudo que foi selecionado.",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "v-model=\"value\""
+      ],
+      "model": true
+    },
+    "to": {
+      "desc": "Configuração do vue-router para enviar no $route.push({ ...to, params: {...} }).",
+      "default": "Pesquisar",
+      "type": "String"
+    },
+    "redirect-key": {
+      "desc": "Controla qual propriedade será a chave primaria para fazer o redirecionamento.",
+      "default": "uuid",
+      "type": "String"
+    },
+    "param-key": {
+      "desc": "Controla qual parâmetro será enviado para rota.",
+      "default": "id",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "item": {
+      "desc": "Acesso dentro do \"<q-item />.",
+      "scope": {
+        "item": {
+          "desc": "Item atual da lista",
+          "type": "Object"
+        },
+        "add": {
+          "desc": "Função para adicionar um item ao model",
+          "type": "Function"
+        },
+        "handleClick": {
+          "desc": "Função que controla o model adiciona ou remove do model",
+          "type": "Function"
+        },
+        "remove": {
+          "desc": "Função para remover um item do model",
+          "type": "Function"
+        },
+        "updateModel": {
+          "desc": "Função para atualizar o v-model",
+          "type": "Function"
+        }
+      }
+    },
+    "item-action": {
+      "desc": "Acesso dentro do \"<q-item-section avatar />\".",
+      "scope": {
+        "item": {
+          "desc": "Item atual da lista",
+          "type": "Object"
+        },
+        "add": {
+          "desc": "Função para adicionar um item ao model",
+          "type": "Function"
+        },
+        "handleClick": {
+          "desc": "Função que controla o model adiciona ou remove do model",
+          "type": "Function"
+        },
+        "remove": {
+          "desc": "Função para remover um item do model",
+          "type": "Function"
+        },
+        "updateModel": {
+          "desc": "Função para atualizar o v-model",
+          "type": "Function"
+        }
+      }
+    }
+  },
+  "events": {
+    "@added -> function(item)": {
+      "desc": "Dispara toda vez que um item é adicionado no v-model.",
+      "params": {
+        "item": {
+          "desc": "Item adicionado",
+          "type": "String"
+        }
+      }
+    },
+    "@removed -> function (item, index)": {
+      "desc": "Dispara toda vez que um item é removido do v-model.",
+      "params": {
+        "item": {
+          "desc": "Valor removido.",
+          "type": "String"
+        },
+        "index": {
+          "desc": "Index do item removido.",
+          "type": "Number"
+        }
+      }
+    },
+    "@update:model-value -> function (value)": {
+      "desc": "Dispara toda vez que o campo de busca é alterado, também utilizado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do v-model",
+          "type": "String"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasSignaturePad.json

@@ -0,0 +1,63 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para assinatura que gera uma imagem."
+  },
+  "props": {
+    "empty": {
+      "desc": "Model que retorna se a tela está vazio ou não.",
+      "default": true,
+      "type": "Boolean",
+      "model": true
+    },
+    "height": {
+      "desc": "Altura da área da assinatura.",
+      "default": {},
+      "type": "Object"
+    },
+    "signature_options": {
+      "desc": "Opções da biblioteca signature_pad (https://github.com/szimek/signature_pad#options).",
+      "default": {},
+      "type": "Object"
+    },
+    "type": {
+      "desc": "Tipo da imagem gerada.",
+      "default": "image/png",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Usado para conseguir recuperar as função internas do componente.",
+      "scope": {
+        "clearSignature () => undefined": {
+          "desc": "Limpa a assinatura.",
+          "type": "Function"
+        },
+        "getSignatureData () => String": {
+          "desc": "Obtém a assinatura em formato de imagem com \"tipo\" de acordo com o que foi passado para o componente (ex: \"image/png\"). Utiliza o HTMLCanvasElement.toDataURL()",
+          "type": "Function"
+        }
+      }
+    }
+  },
+  "events": {
+    "@update:empty -> function(value)": {
+      "desc": "Dispara toda vez que para de desenhar na tela, usado para v-model:empty.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do model.",
+          "type": "Boolean"
+        }
+      }
+    }
+  },
+  "methods": {
+    "clearSignature () => undefined": {
+      "desc": "Limpa a assinatura."
+    },
+    "getSignatureData () => String": {
+      "desc": "Obtém a assinatura em formato de imagem com \"tipo\" de acordo com o que foi passado para o componente (ex: \"image/png\"). Utiliza o HTMLCanvasElement.toDataURL()"
+    }
+  }
+}

package/dist/api/QasSignatureUploader.json

@@ -0,0 +1,41 @@
+{
+  "type": "component",
+  "meta": null,
+  "desc": "Componente que implementa o \"QasUploader\" e \"QasSignaturePad\" para fazer upload de assinatura.",
+  "props": {
+    "upload-label": {
+      "desc": "Rótulo do uploader.",
+      "type": "String"
+    },
+    "signature-label": {
+      "desc": "Rótulo do componente de assinatura.",
+      "default": {},
+      "type": "Object"
+    },
+    "model-value": {
+      "desc": "Model do componente, retorna url da imagem upada, usando para v-model.",
+      "type": "String"
+    },
+    "type": {
+      "desc": "Tipo da imagem gerada.",
+      "default": "image/png",
+      "type": "String"
+    },
+    "readonly": {
+      "desc": "Controla se o componente vai ser apenas para visualização ou pode também fazer upload.",
+      "default": "image/png",
+      "type": "String"
+    }
+  },
+  "events": {
+    "@update:model-value -> function(value)": {
+      "desc": "Dispara toda vez que o acontece um novo upload, usado para v-model.",
+      "params": {
+        "value": {
+          "desc": "Novo valor do model.",
+          "type": "String"
+        }
+      }
+    }
+  }
+}

package/dist/api/QasSingleView.json

@@ -0,0 +1,147 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para C.R.U.D. responsável pela visualização (Read) ou conhecido também como \"show\"."
+  },
+  "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": {
+      "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"
+    },
+    "result": {
+      "model": true,
+      "desc": "Model de result, utilizado para recuperar o resultado retornado pelo componente.",
+      "type": "Object",
+      "examples": [
+        "v-model:result=\"result\""
+      ]
+    },
+    "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\""
+      ]
+    }
+  },
+  "slots": {
+    "header": {
+      "desc": "Slot para acessar o header."
+    },
+    "default": {
+      "desc": "Slot para ter o conteúdo principal (dentro do main)."
+    },
+    "footer": {
+      "desc": "Slot para acessar o footer."
+    }
+  },
+  "events": {
+    "@update:result -> function(value)": {
+      "desc": "Dispara quando a action \"fetchSingle\" é executada com sucesso, é chamado antes do evento \"fetch-success\".",
+      "params": {
+        "value": {
+          "desc": "lista retornada no \"fetchSingle\".",
+          "type": "Array"
+        }
+      }
+    },
+    "@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/QasSortable.json

@@ -0,0 +1,80 @@
+{
+  "type": "component",
+  "meta": {
+    "desc": "Componente para reordenar items em uma lista e salvar após isto."
+  },
+  "props": {
+    "entity": {
+      "desc": "Entidade da store que para salvar os items após reordenar a lista.",
+      "required": true,
+      "type": "String"
+    },
+    "sortable-options": {
+      "desc": "Opções do \"sortablejs\" (https://github.com/SortableJS/Sortable#options).",
+      "default": {
+        "animation": 500
+      },
+      "type": "Object"
+    },
+    "list": {
+      "desc": "Lista que vai ser reordenada.",
+      "default": [],
+      "type": "Array"
+    },
+    "tag": {
+      "desc": "Tag do componente pai.",
+      "default": "div",
+      "type": "String"
+    },
+    "url": {
+      "desc": "Parâmetro enviado para a action \"replace\".",
+      "type": "String"
+    },
+    "sorted": {
+      "desc": "Model da lista reordenada",
+      "default": [],
+      "type": "Array",
+      "examples": [
+        "v-model:sorted=\"fields\""
+      ],
+      "model": true
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot para adicionar os items que serão reordenados."
+    }
+  },
+  "events": {
+    "@update:sorted -> function(value)": {
+      "desc": "Dispara no created e toda vez que a prop \"list\" muda, usado para o v-model:sorted.",
+      "params": {
+        "value": {
+          "desc": "Lista contendo nova ordenação.",
+          "type": "Array"
+        }
+      }
+    },
+    "@sort -> function(value)": {
+      "desc": "Dispara toda vez que acontece uma nova ordenação."
+    },
+    "@success -> function(value)": {
+      "desc": "Dispara toda vez que salva com sucesso a nova ordenação.",
+      "params": {
+        "value": {
+          "desc": "fields.",
+          "type": "Object"
+        }
+      }
+    },
+    "@error -> function(value)": {
+      "desc": "Dispara toda vez que acontece algum erro ao salvar a nova ordenação.",
+      "params": {
+        "value": {
+          "desc": "fields.",
+          "type": "Object"
+        }
+      }
+    }
+  }
+}