@sankhyalabs/sankhyablocks-docs 10.1.0-dev.23 → 10.1.0-dev.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/snk-application/readme.md +8 -8
- package/components/snk-crud/readme.md +1 -0
- package/components/snk-crud/subcomponents/readme.md +1 -0
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -0
- package/components/snk-image-input/readme.md +56 -0
- package/package.json +1 -1
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
12
|
-
| `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string`
|
|
13
|
-
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean`
|
|
14
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string`
|
|
15
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string`
|
|
16
|
-
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any
|
|
17
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` |
|
|
13
|
+
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` |
|
|
14
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` |
|
|
15
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` |
|
|
16
|
+
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }, redirectFrom?: string) => void` | `undefined` |
|
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
## Events
|
|
@@ -240,6 +240,7 @@ graph TD;
|
|
|
240
240
|
snk-guides-viewer --> snk-actions-button
|
|
241
241
|
snk-guides-viewer --> taskbar-split-button
|
|
242
242
|
snk-guides-viewer --> taskbar-actions-button
|
|
243
|
+
snk-form-view --> snk-image-input
|
|
243
244
|
snk-form-view --> snk-form-summary
|
|
244
245
|
snk-detail-view --> snk-data-unit
|
|
245
246
|
snk-detail-view --> snk-grid
|
|
@@ -137,6 +137,7 @@ graph TD;
|
|
|
137
137
|
snk-guides-viewer --> snk-actions-button
|
|
138
138
|
snk-guides-viewer --> taskbar-split-button
|
|
139
139
|
snk-guides-viewer --> taskbar-actions-button
|
|
140
|
+
snk-form-view --> snk-image-input
|
|
140
141
|
snk-form-view --> snk-form-summary
|
|
141
142
|
snk-detail-view --> snk-data-unit
|
|
142
143
|
snk-detail-view --> snk-grid
|
|
@@ -147,6 +147,7 @@ graph TD;
|
|
|
147
147
|
snk-taskbar --> taskbar-actions-button
|
|
148
148
|
snk-data-exporter --> snk-exporter-email-sender
|
|
149
149
|
snk-grid-config --> snk-select-box
|
|
150
|
+
snk-form-view --> snk-image-input
|
|
150
151
|
snk-form-view --> snk-form-summary
|
|
151
152
|
snk-attach --> snk-simple-bar
|
|
152
153
|
snk-attach --> snk-simple-crud
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# snk-image-input
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | ------------- | ----------------------------------------------- | ---------- | ----------- |
|
|
12
|
+
| `acceptType` | `accept-type` | Tipos MIME aceitos (separados por vírgula) | `string` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | DataUnit associado ao componente | `DataUnit` | `undefined` |
|
|
14
|
+
| `enabled` | `enabled` | Define se está habilitado | `boolean` | `true` |
|
|
15
|
+
| `entityName` | `entity-name` | Nome da entidade (usado quando não há DataUnit) | `string` | `undefined` |
|
|
16
|
+
| `fieldName` | `field-name` | Nome do campo no DataUnit | `string` | `undefined` |
|
|
17
|
+
| `label` | `label` | Label do componente | `string` | `undefined` |
|
|
18
|
+
| `maxSize` | `max-size` | Tamanho máximo do arquivo em KB | `number` | `undefined` |
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Events
|
|
22
|
+
|
|
23
|
+
| Event | Description | Type |
|
|
24
|
+
| ------------ | ------------------------------- | --------------------- |
|
|
25
|
+
| `imageError` | Evento disparado quando há erro | `CustomEvent<string>` |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
### `reloadImage(pks?: Record<string, any>) => Promise<void>`
|
|
31
|
+
|
|
32
|
+
Força o reload da imagem
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
Type: `Promise<void>`
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## Dependencies
|
|
42
|
+
|
|
43
|
+
### Used by
|
|
44
|
+
|
|
45
|
+
- [snk-form-view](../snk-crud/subcomponents)
|
|
46
|
+
|
|
47
|
+
### Graph
|
|
48
|
+
```mermaid
|
|
49
|
+
graph TD;
|
|
50
|
+
snk-form-view --> snk-image-input
|
|
51
|
+
style snk-image-input fill:#f9f,stroke:#333,stroke-width:4px
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
----------------------------------------------
|
|
55
|
+
|
|
56
|
+
|