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

package/src/components/uploader/QasUploader.yml

@@ -1,192 +1,206 @@
-type: component
-
-mixins:
-  - quasar/dist/api/QField.json
-  - quasar/dist/api/QUploader.json
-
-meta:
-  desc: Componente para upload com auto redimensionamento que implementa o "QField" e "QUploader".
-
-props:
-  'add-button-fn -> function (scope)':
-    desc: Callback para interceptar ação do botão de adicionar arquivos, caso passe uma função para essa prop, é desabilitado o a ação de abrir o seletor de arquivos e é necessário fazer o controle manual.
-    type: Function
-    params:
-      scope:
-        desc: Retorna o valor de referencia do QUploader.
-        type: Object
-
-  add-button-label:
-    desc: Label do botão de adicionar arquivo(s).
-    default: Adicionar
-    type: String
-
-  accept-resize-types:
-    desc: Tipos de arquivos aceitos para fazer o redimensionamento antes de upar.
-    type: Array
-    debugger: true
-    default: [
-      'image/jpeg',
-      'image/png',
-      'image/gif',
-      'image/bmp',
-      'image/webp',
-      'image/jpg'
-    ]
-
-  columns:
-    desc: Seta as colunas (grid cols), valor default depende se o componente é múltiplo ou não.
-    default:
-      col: 12
-      sm: 6
-      md: 4
-      lg: 3
-    type: Object
-    examples: ['{ col: 12, sm: 6 }']
-
-  dialog-props:
-    desc: props repassadas para o componente QasDialog, que é utilizado quando os arquivos upados podem ser editados.
-    default: {}
-    type: Object
-
-  entity:
-    desc: Entidade enviada para a API do `/upload-credentials/`.
-    required: true
-    type: String
-
-  error:
-    desc: Habilita modo erro.
-    default: false
-    type: Boolean
-
-  error-message:
-    desc: Mensagem de erro.
-    type: String
-
-  fields:
-    desc: Quando utilizar os mesmos campos no "QasGridGenerator" e "QasFormGenerator", utilize esta prop para não ter que repetir os fields.
-    default: {}
-    type: Object
-
-  form-generator-props:
-    desc: Propriedades repassadas para o componente "QasFormGenerator".
-    default: {}
-    type: Object
-
-  gallery-card-props:
-    desc: Propriedades repassadas para o componente "QasGalleryCard".
-    default: {}
-    type: Object
-
-  grid-generator-props:
-    desc: Propriedades repassadas para o componente "QasGridGenerator".
-    default: {}
-    type: Object
-
-  label:
-    desc: Label do componente, repassado para o componente "QasLabel".
-    type: String
-
-  max-files:
-    desc: Quantidade maxima de arquivos no upload.
-    default: undefined
-    type: Number
-
-  model-value:
-    desc: Model do componente, caso seja múltiplo, retorna um array de string, senão somente uma string.
-    default: true
-    type: [Array, String]
-    examples: [v-model="value"]
-    model: true
-
-  pica-resize-options:
-    desc: Opções para a biblioteca "pica" que é responsável por fazer o redimensionamento antes do upload (https://github.com/nodeca/pica).
-    type: Object
-    debugger: true
-    default:
-      unsharpAmount: 160
-      unsharpRadius: 0.6
-      unsharpThreshold: 1
-
-  readonly:
-    desc: O componente não faz mais upload, apenas exibe.
-    default: true
-    type: Number
-
-  size-limit:
-    desc: Se o tamanho da imagem for menor ou igual ao passado nesta prop, não será feito um redimensionamento.
-    default: 1280
-    type: Number
-
-  upload-credentials-params:
-    desc: Parâmetros enviados para a API do `/upload-credentials/`.
-    default: {}
-    type: Object
-
-  uploading:
-    desc: Model que retorna se o componente está fazendo algum upload.
-    type: Boolean
-    examples: [v-model:uploading="isUploading"]
-    model: true
-
-  use-download:
-    desc: Habilita a opção de fazer download por arquivo.
-    default: true
-    type: Boolean
-
-  use-object-model:
-    desc: Controla se a model retornará um array de objetos.
-    type: Boolean
-    model: true
-
-  use-resize:
-    desc: Controla se o componente vai fazer o redimensionamento antes de upar as imagens.
-    default: true
-    type: Boolean
-
-  use-url-path:
-    desc: Controla se o componente vai salvar o path url no model ou por exemplo um base64.
-    default: true
-    type: Boolean
-
-slots:
-  header:
-    desc: Acesso ao header do <q-uploader />.
-    scope:
-      scope:
-        desc: Payload repassado pelo QUploader.
-        default: {}
-        type: Object
-
-  list:
-    desc: Acesso ao conteúdo onde fica a listagem de arquivos.
-    scope:
-      scope:
-        desc: Retorna o valor de referencia do QUploader.
-        type: Object
-
-  custom-upload:
-    desc: Acesso ao conteúdo onde fica a listagem de arquivos.
-    scope:
-      context:
-        desc: Retorna o valor de referencia do QasUploader.
-        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: [Array, String]
-
-  '@update:uploading -> function(value)':
-    desc: Dispara começa e termina um upload.
-    params:
-      value:
-        desc: Retorna se está ou não fazendo um upload.
-        type: Boolean
-
-methods:
-  'reset: () => void':
-    desc: Reseta o campo do uploader.
+type: component
+
+mixins:
+  - quasar/dist/api/QField.json
+  - quasar/dist/api/QUploader.json
+
+meta:
+  desc: Componente para upload com auto redimensionamento que implementa o "QField" e "QUploader".
+
+props:
+  'add-button-fn -> function (scope)':
+    desc: Callback para interceptar ação do botão de adicionar arquivos, caso passe uma função para essa prop, é desabilitado o a ação de abrir o seletor de arquivos e é necessário fazer o controle manual.
+    type: Function
+    params:
+      scope:
+        desc: Retorna o valor de referencia do QUploader.
+        type: Object
+
+  add-button-label:
+    desc: Label do botão de adicionar arquivo(s).
+    default: Adicionar
+    type: String
+
+  accept-resize-types:
+    desc: Tipos de arquivos aceitos para fazer o redimensionamento antes de upar.
+    type: Array
+    debugger: true
+    default: [
+      'image/jpeg',
+      'image/png',
+      'image/gif',
+      'image/bmp',
+      'image/webp',
+      'image/jpg'
+    ]
+
+  columns:
+    desc: Seta as colunas (grid cols), valor default depende se o componente é múltiplo ou não.
+    default:
+      col: 12
+      sm: 6
+      md: 4
+      lg: 3
+    type: Object
+    examples: ['{ col: 12, sm: 6 }']
+
+  dialog-props:
+    desc: props repassadas para o componente QasDialog, que é utilizado quando os arquivos upados podem ser editados.
+    default: {}
+    type: Object
+
+  entity:
+    desc: Entidade enviada para a API do `/upload-credentials/`.
+    required: true
+    type: String
+
+  error:
+    desc: Habilita modo erro.
+    default: false
+    type: Boolean
+
+  error-message:
+    desc: Mensagem de erro.
+    type: String
+
+  fields:
+    desc: Quando utilizar os mesmos campos no "QasGridGenerator" e "QasFormGenerator", utilize esta prop para não ter que repetir os fields.
+    default: {}
+    type: Object
+
+  form-generator-props:
+    desc: Propriedades repassadas para o componente "QasFormGenerator".
+    default: {}
+    type: Object
+
+  gallery-card-props:
+    desc: Propriedades repassadas para o componente "QasGalleryCard".
+    default: {}
+    type: Object
+
+  grid-generator-props:
+    desc: Propriedades repassadas para o componente "QasGridGenerator".
+    default: {}
+    type: Object
+
+  header-props:
+    desc: Propriedades repassadas para o componente "QasHeader".
+    default: {}
+    type: Object
+
+  label:
+    desc: Label do componente.
+    type: String
+
+  max-files:
+    desc: Quantidade maxima de arquivos no upload.
+    default: undefined
+    type: Number
+
+  model-value:
+    desc: Model do componente, caso seja múltiplo, retorna um array de string, senão somente uma string.
+    default: true
+    type: [Array, String]
+    examples: [v-model="value"]
+    model: true
+
+  pica-resize-options:
+    desc: Opções para a biblioteca "pica" que é responsável por fazer o redimensionamento antes do upload (https://github.com/nodeca/pica).
+    type: Object
+    debugger: true
+    default:
+      unsharpAmount: 160
+      unsharpRadius: 0.6
+      unsharpThreshold: 1
+
+  readonly:
+    desc: O componente não faz mais upload, apenas exibe.
+    default: true
+    type: Number
+
+  size-limit:
+    desc: Se o tamanho da imagem for menor ou igual ao passado nesta prop, não será feito um redimensionamento.
+    default: 1280
+    type: Number
+
+  upload-credentials-params:
+    desc: Parâmetros enviados para a API do `/upload-credentials/`.
+    default: {}
+    type: Object
+
+  uploading:
+    desc: Model que retorna se o componente está fazendo algum upload.
+    type: Boolean
+    examples: [v-model:uploading="isUploading"]
+    model: true
+
+  use-download:
+    desc: Habilita a opção de fazer download por arquivo.
+    default: true
+    type: Boolean
+
+  use-object-model:
+    desc: Controla se a model retornará um array de objetos.
+    type: Boolean
+    model: true
+
+  use-resize:
+    desc: Controla se o componente vai fazer o redimensionamento antes de upar as imagens.
+    default: true
+    type: Boolean
+
+  use-url-path:
+    desc: Controla se o componente vai salvar o path url no model ou por exemplo um base64.
+    default: true
+    type: Boolean
+
+slots:
+  header:
+    desc: Acesso ao header do <q-uploader />.
+    scope:
+      scope:
+        desc: Payload repassado pelo QUploader.
+        default: {}
+        type: Object
+
+  header-actions:
+    desc: Acessa o slot actions do "QasHeader".
+
+  header-description:
+    desc: Acessa o slot description do "QasHeader".
+
+  header-label:
+    desc: Acessa o slot label do "QasHeader".
+
+  list:
+    desc: Acesso ao conteúdo onde fica a listagem de arquivos.
+    scope:
+      scope:
+        desc: Retorna o valor de referencia do QUploader.
+        type: Object
+
+  custom-upload:
+    desc: Acesso ao conteúdo onde fica a listagem de arquivos.
+    scope:
+      context:
+        desc: Retorna o valor de referencia do QasUploader.
+        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: [Array, String]
+
+  '@update:uploading -> function(value)':
+    desc: Dispara começa e termina um upload.
+    params:
+      value:
+        desc: Retorna se está ou não fazendo um upload.
+        type: Boolean
+
+methods:
+  'reset: () => void':
+    desc: Reseta o campo do uploader.