@sankhyalabs/sankhyablocks-docs 2.0.0

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.
@@ -0,0 +1,67 @@
1
+ # snk-filter-item
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | --------- | ----------- | -------------------------------------- | ----------- |
12
+ | `config` | -- | | `SnkFilterItemConfig` | `undefined` |
13
+ | `getMessage` | -- | | `(key: string, props?: any) => string` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ---------------- | ------------------------------------------------------------------- | ---------------------------------- |
20
+ | `filterChange` | | `CustomEvent<SnkFilterItemConfig>` |
21
+ | `visibleChanged` | Disparado quando o detalhe de um item da lista é aberto ou fechado. | `CustomEvent<boolean>` |
22
+
23
+
24
+ ## Methods
25
+
26
+ ### `hideDetail() => Promise<void>`
27
+
28
+
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+ ### `showUp(open?: boolean) => Promise<void>`
37
+
38
+
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+
47
+ ## Dependencies
48
+
49
+ ### Used by
50
+
51
+ - [snk-filter-bar](..)
52
+
53
+ ### Depends on
54
+
55
+ - [snk-filter-detail](.)
56
+
57
+ ### Graph
58
+ ```mermaid
59
+ graph TD;
60
+ snk-filter-item --> snk-filter-detail
61
+ snk-filter-bar --> snk-filter-item
62
+ style snk-filter-item fill:#f9f,stroke:#333,stroke-width:4px
63
+ ```
64
+
65
+ ----------------------------------------------
66
+
67
+
@@ -0,0 +1,56 @@
1
+ # snk-filter-list
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ------------------ | ----------- | -------------------------------------- | ----------- |
12
+ | `buttonClass` | `button-class` | | `string` | `undefined` |
13
+ | `emptyText` | `empty-text` | | `string` | `undefined` |
14
+ | `findFilterText` | `find-filter-text` | | `string` | `undefined` |
15
+ | `getMessage` | -- | | `(key: string, props?: any) => string` | `undefined` |
16
+ | `iconName` | `icon-name` | | `string` | `undefined` |
17
+ | `items` | -- | | `ListItem[]` | `undefined` |
18
+ | `label` | `label` | | `string` | `undefined` |
19
+
20
+
21
+ ## Events
22
+
23
+ | Event | Description | Type |
24
+ | ----------------- | ----------- | --------------------- |
25
+ | `snkItemSelected` | | `CustomEvent<string>` |
26
+
27
+
28
+ ## Methods
29
+
30
+ ### `hideDetail() => Promise<void>`
31
+
32
+
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+
41
+ ## Dependencies
42
+
43
+ ### Used by
44
+
45
+ - [snk-filter-bar](..)
46
+
47
+ ### Graph
48
+ ```mermaid
49
+ graph TD;
50
+ snk-filter-bar --> snk-filter-list
51
+ style snk-filter-list fill:#f9f,stroke:#333,stroke-width:4px
52
+ ```
53
+
54
+ ----------------------------------------------
55
+
56
+
@@ -0,0 +1,38 @@
1
+ # snk-filter-modal
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------- | --------------------- | ----------- | -------------------------------------- | ----------- |
12
+ | `cancelButtonLabel` | `cancel-button-label` | | `string` | `undefined` |
13
+ | `getMessage` | -- | | `(key: string, props?: any) => string` | `undefined` |
14
+ | `infoText` | `info-text` | | `string` | `undefined` |
15
+ | `items` | -- | | `ModalItem[]` | `undefined` |
16
+ | `modalSubTitle` | `modal-sub-title` | | `string` | `undefined` |
17
+ | `modalTitle` | `modal-title` | | `string` | `undefined` |
18
+ | `okButtonLabel` | `ok-button-label` | | `string` | `undefined` |
19
+ | `processModalAction` | -- | | `(action: ModalAction) => void` | `undefined` |
20
+ | `useSearch` | `use-search` | | `boolean` | `undefined` |
21
+
22
+
23
+ ## Dependencies
24
+
25
+ ### Used by
26
+
27
+ - [snk-filter-bar](..)
28
+
29
+ ### Graph
30
+ ```mermaid
31
+ graph TD;
32
+ snk-filter-bar --> snk-filter-modal
33
+ style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
34
+ ```
35
+
36
+ ----------------------------------------------
37
+
38
+
@@ -0,0 +1,42 @@
1
+ # snk-filter-bar
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
12
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
13
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
14
+ | `filterConfig` | -- | Lista de todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
15
+
16
+
17
+ ## Dependencies
18
+
19
+ ### Used by
20
+
21
+ - [snk-grid](../snk-grid)
22
+
23
+ ### Depends on
24
+
25
+ - [snk-filter-item](filter-item)
26
+ - [snk-filter-modal](filter-modal)
27
+ - [snk-filter-list](filter-list)
28
+
29
+ ### Graph
30
+ ```mermaid
31
+ graph TD;
32
+ snk-filter-bar --> snk-filter-item
33
+ snk-filter-bar --> snk-filter-modal
34
+ snk-filter-bar --> snk-filter-list
35
+ snk-filter-item --> snk-filter-detail
36
+ snk-grid --> snk-filter-bar
37
+ style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
38
+ ```
39
+
40
+ ----------------------------------------------
41
+
42
+
@@ -0,0 +1,74 @@
1
+ # snk-form
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" | `Action[]` | `undefined` |
13
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário | `string` | `undefined` |
14
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro | `IRecordValidator` | `undefined` |
15
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------- | ------------------------------------------------ | --------------------- |
22
+ | `actionClick` | Emitido sempre que houver click de botão ou ação | `CustomEvent<string>` |
23
+ | `exit` | Emitido quando o botão de voltar é acionado | `CustomEvent<void>` |
24
+
25
+
26
+ ## Methods
27
+
28
+ ### `hideConfig() => Promise<void>`
29
+
30
+ Método responsável em fechar o modal de configurações do form.
31
+
32
+ #### Returns
33
+
34
+ Type: `Promise<void>`
35
+
36
+
37
+
38
+ ### `showConfig() => Promise<void>`
39
+
40
+ Método responsável em abrir o modal de configurações do form.
41
+
42
+ #### Returns
43
+
44
+ Type: `Promise<void>`
45
+
46
+
47
+
48
+
49
+ ## Dependencies
50
+
51
+ ### Used by
52
+
53
+ - [snk-crud](../snk-crud)
54
+
55
+ ### Depends on
56
+
57
+ - [snk-taskbar](../snk-taskbar)
58
+ - [snk-form-config](./subcomponents/snk-form-config)
59
+
60
+ ### Graph
61
+ ```mermaid
62
+ graph TD;
63
+ snk-form --> snk-taskbar
64
+ snk-form --> snk-form-config
65
+ snk-form-config --> snk-field-config
66
+ snk-form-config --> snk-config-options
67
+ snk-form-config --> snk-tab-config
68
+ snk-crud --> snk-form
69
+ style snk-form fill:#f9f,stroke:#333,stroke-width:4px
70
+ ```
71
+
72
+ ----------------------------------------------
73
+
74
+
@@ -0,0 +1,39 @@
1
+ # ez-config-options
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | ----------- | ---------------------------------------------------------------------- | -------------- | -------------------- |
12
+ | `dataUnit` | -- | Repositório de dados responsável por controlar a manipulação dos dados | `DataUnit` | `undefined` |
13
+ | `fieldConfig` | -- | Armazena as propriedades do campo | `IFieldConfig` | `{} as IFieldConfig` |
14
+ | `idConfig` | `id-config` | Armazena a chave de opções de configuração | `string` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ---------------------- | -------------------------------------------------------- | ------------------ |
21
+ | `configOptionsChanged` | Evento disparado ao realizar alguma alteração nos campos | `CustomEvent<any>` |
22
+
23
+
24
+ ## Dependencies
25
+
26
+ ### Used by
27
+
28
+ - [snk-form-config](../snk-form-config)
29
+
30
+ ### Graph
31
+ ```mermaid
32
+ graph TD;
33
+ snk-form-config --> snk-config-options
34
+ style snk-config-options fill:#f9f,stroke:#333,stroke-width:4px
35
+ ```
36
+
37
+ ----------------------------------------------
38
+
39
+
@@ -0,0 +1,40 @@
1
+ # ez-field-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ---------------- | ------------------------------------------------------ | -------------- | ----------- |
12
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados | `DataUnit` | `undefined` |
13
+ | `fieldConfig` | -- | Armazena as propriedades do campo | `IFieldConfig` | `undefined` |
14
+ | `isConfigActive` | -- | Define se o popover de configuração está ativo. | `Boolean` | `false` |
15
+ | `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção | `boolean` | `true` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------- | --------------------------------------------------------- | --------------------- |
22
+ | `ezClickIcon` | Evento disparado ao pressionar button icon(onEzClickIcon) | `CustomEvent<Object>` |
23
+
24
+
25
+ ## Dependencies
26
+
27
+ ### Used by
28
+
29
+ - [snk-form-config](../snk-form-config)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-form-config --> snk-field-config
35
+ style snk-field-config fill:#f9f,stroke:#333,stroke-width:4px
36
+ ```
37
+
38
+ ----------------------------------------------
39
+
40
+
@@ -0,0 +1,49 @@
1
+ # ez-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ----------------------------------------------------------------- | ------------- | ------------------- |
12
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados | `DataUnit` | `undefined` |
14
+ | `formConfig` | -- | Campos de configuração de formulário. | `IFormConfig` | `{} as IFormConfig` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | -------------- | -------------------------------------------- | -------------------------- |
21
+ | `configChange` | Evento disparado ao salvar as configurações. | `CustomEvent<IFormConfig>` |
22
+ | `configClose` | Evento disparado ao fechar as configurações. | `CustomEvent<void>` |
23
+
24
+
25
+ ## Dependencies
26
+
27
+ ### Used by
28
+
29
+ - [snk-form](../..)
30
+
31
+ ### Depends on
32
+
33
+ - [snk-field-config](../snk-field-config)
34
+ - [snk-config-options](../snk-config-options)
35
+ - [snk-tab-config](../snk-tab-config)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ snk-form-config --> snk-field-config
41
+ snk-form-config --> snk-config-options
42
+ snk-form-config --> snk-tab-config
43
+ snk-form --> snk-form-config
44
+ style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
45
+ ```
46
+
47
+ ----------------------------------------------
48
+
49
+
@@ -0,0 +1,44 @@
1
+ # ez-tab-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ----------------------------------------------------------------- | -------- | ----------- |
12
+ | `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
13
+ | `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
14
+ | `tabs` | `tabs` | Define o nome das abas do componente, separadas por vírgulas ",". | `string` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- |
21
+ | `canStartDrag` | Evento emitido ao ocultar uma aba. | `CustomEvent<any>` |
22
+ | `deleteTab` | Evento emitido ao deletar uma aba. | `CustomEvent<any>` |
23
+ | `editionTitleTab` | Evento emitido ao salvar uma alteração realizada no título da tab | `CustomEvent<any>` |
24
+ | `ezOrderChange` | Evento emitido ao mover a aba mudando a sua ordem. | `CustomEvent<number>` |
25
+ | `ezTabChange` | Evento emitido ao clicar para abrir o popup (ezTabChange). O detail desse evento carrega tanto o tabKey quanto o index da aba selecionada. | `CustomEvent<ITab>` |
26
+ | `hideTab` | Evento emitido ao ocultar uma aba. | `CustomEvent<any>` |
27
+
28
+
29
+ ## Dependencies
30
+
31
+ ### Used by
32
+
33
+ - [snk-form-config](../snk-form-config)
34
+
35
+ ### Graph
36
+ ```mermaid
37
+ graph TD;
38
+ snk-form-config --> snk-tab-config
39
+ style snk-tab-config fill:#f9f,stroke:#333,stroke-width:4px
40
+ ```
41
+
42
+ ----------------------------------------------
43
+
44
+
@@ -0,0 +1,89 @@
1
+ # snk-grid
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" | `Action[]` | `undefined` |
13
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração | `string` | `undefined` |
14
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada | `boolean` | `undefined` |
15
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `IStatusResolver` | `undefined` |
16
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
17
+
18
+
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | ----------------- | ------------------------------------------------ | --------------------- |
23
+ | `actionClick` | Emitido sempre que houver click de botão ou ação | `CustomEvent<string>` |
24
+ | `gridDoubleClick` | Emitido sempre que houver duplo click na grade | `CustomEvent<void>` |
25
+
26
+
27
+ ## Methods
28
+
29
+ ### `hideConfig() => Promise<void>`
30
+
31
+ Método responsável em fechar o modal de configurações da grade.
32
+
33
+ #### Returns
34
+
35
+ Type: `Promise<void>`
36
+
37
+
38
+
39
+ ### `setConfig(config: IGridConfig) => Promise<void>`
40
+
41
+ Método responsável por setar as configurações da grade.
42
+
43
+ #### Returns
44
+
45
+ Type: `Promise<void>`
46
+
47
+
48
+
49
+ ### `showConfig() => Promise<void>`
50
+
51
+ Método responsável em abrir o modal de configurações da grade.
52
+
53
+ #### Returns
54
+
55
+ Type: `Promise<void>`
56
+
57
+
58
+
59
+
60
+ ## Dependencies
61
+
62
+ ### Used by
63
+
64
+ - [snk-crud](../snk-crud)
65
+
66
+ ### Depends on
67
+
68
+ - [snk-filter-bar](../snk-filter-bar)
69
+ - [snk-taskbar](../snk-taskbar)
70
+ - [snk-grid-config](./subcomponents/snk-grid-config)
71
+
72
+ ### Graph
73
+ ```mermaid
74
+ graph TD;
75
+ snk-grid --> snk-filter-bar
76
+ snk-grid --> snk-taskbar
77
+ snk-grid --> snk-grid-config
78
+ snk-filter-bar --> snk-filter-item
79
+ snk-filter-bar --> snk-filter-modal
80
+ snk-filter-bar --> snk-filter-list
81
+ snk-filter-item --> snk-filter-detail
82
+ snk-grid-config --> snk-select-box
83
+ snk-crud --> snk-grid
84
+ style snk-grid fill:#f9f,stroke:#333,stroke-width:4px
85
+ ```
86
+
87
+ ----------------------------------------------
88
+
89
+
@@ -0,0 +1,58 @@
1
+ # ez-grid-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ------------------------------------------- | ---------------- | ----------- |
12
+ | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
13
+ | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
14
+ | `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade. | `number` | `0` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | -------------- | ----------------------------------------------------------- | -------------------------- |
21
+ | `configCancel` | Evento disparado ao cancelar a alteração das configurações. | `CustomEvent<void>` |
22
+ | `configChange` | Evento disparado ao salvar a alteração das configurações. | `CustomEvent<IGridConfig>` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `saveConfig(config: IGridConfig) => Promise<void>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+
36
+
37
+
38
+ ## Dependencies
39
+
40
+ ### Used by
41
+
42
+ - [snk-grid](../..)
43
+
44
+ ### Depends on
45
+
46
+ - [snk-select-box](../snk-select-box)
47
+
48
+ ### Graph
49
+ ```mermaid
50
+ graph TD;
51
+ snk-grid-config --> snk-select-box
52
+ snk-grid --> snk-grid-config
53
+ style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
54
+ ```
55
+
56
+ ----------------------------------------------
57
+
58
+
@@ -0,0 +1,37 @@
1
+ # snk-select-box
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ----------------- | ----------- | ------------------- | ------------------- |
12
+ | `selectedOption` | `selected-option` | | `IOption \| string` | `ORDER_VALUES.none` |
13
+
14
+
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | ---------- | ----------- | --------------------- |
19
+ | `ezChange` | | `CustomEvent<string>` |
20
+
21
+
22
+ ## Dependencies
23
+
24
+ ### Used by
25
+
26
+ - [snk-grid-config](../snk-grid-config)
27
+
28
+ ### Graph
29
+ ```mermaid
30
+ graph TD;
31
+ snk-grid-config --> snk-select-box
32
+ style snk-select-box fill:#f9f,stroke:#333,stroke-width:4px
33
+ ```
34
+
35
+ ----------------------------------------------
36
+
37
+
@@ -0,0 +1,32 @@
1
+ # snk-pesquisa
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | ---------- | ----------- | ---------- | ----------- |
12
+ | `argument` | `argument` | | `string` | `undefined` |
13
+ | `searchLoader` | -- | | `Function` | `undefined` |
14
+ | `selectItem` | -- | | `Function` | `undefined` |
15
+
16
+
17
+ ## Dependencies
18
+
19
+ ### Used by
20
+
21
+ - [snk-application](../snk-application)
22
+
23
+ ### Graph
24
+ ```mermaid
25
+ graph TD;
26
+ snk-application --> snk-pesquisa
27
+ style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
28
+ ```
29
+
30
+ ----------------------------------------------
31
+
32
+