@sankhyalabs/sankhyablocks-docs 8.2.0-dev.1 → 8.2.0-rc.1
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 +14 -4
- package/components/snk-configurator/readme.md +0 -1
- package/components/snk-crud/readme.md +5 -6
- package/components/snk-crud/subcomponents/readme.md +5 -6
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -6
- package/components/snk-data-unit/readme.md +0 -1
- package/components/snk-entity-list/readme.md +4 -3
- package/components/snk-filter-bar/filter-modal/readme.md +1 -1
- package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +4 -5
- package/components/snk-filter-bar/readme.md +6 -7
- package/components/snk-form/readme.md +9 -11
- package/components/snk-grid/readme.md +14 -16
- package/components/snk-grid/subcomponents/snk-grid-config/readme.md +0 -1
- package/components/snk-personalized-filter/readme.md +6 -7
- package/components/snk-simple-crud/readme.md +5 -6
- package/components/snk-taskbar/readme.md +0 -1
- package/package.json +1 -1
@@ -93,7 +93,7 @@ Type: `Promise<boolean>`
|
|
93
93
|
|
94
94
|
|
95
95
|
|
96
|
-
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string
|
96
|
+
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string) => Promise<DataUnit>`
|
97
97
|
|
98
98
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
99
99
|
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
|
@@ -148,7 +148,7 @@ Type: `Promise<any[]>`
|
|
148
148
|
|
149
149
|
|
150
150
|
|
151
|
-
### `getAllAccess(
|
151
|
+
### `getAllAccess() => Promise<any>`
|
152
152
|
|
153
153
|
Obtém todos os acessos do usuário logado.
|
154
154
|
|
@@ -218,7 +218,7 @@ Type: `Promise<DataFetcher>`
|
|
218
218
|
|
219
219
|
DataFetcher do application
|
220
220
|
|
221
|
-
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string
|
221
|
+
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string) => Promise<DataUnit>`
|
222
222
|
|
223
223
|
Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
224
224
|
|
@@ -288,7 +288,7 @@ Type: `Promise<string>`
|
|
288
288
|
|
289
289
|
|
290
290
|
|
291
|
-
### `hasAccess(access: AutorizationType
|
291
|
+
### `hasAccess(access: AutorizationType) => Promise<boolean>`
|
292
292
|
|
293
293
|
Obtém `true` caso o usuário logado tem permissão pra determinada ação.
|
294
294
|
|
@@ -358,6 +358,16 @@ Type: `Promise<boolean>`
|
|
358
358
|
|
359
359
|
|
360
360
|
|
361
|
+
### `loadGridConfig(name: string) => Promise<IGridConfig>`
|
362
|
+
|
363
|
+
Obtém a configuração de grade.
|
364
|
+
|
365
|
+
#### Returns
|
366
|
+
|
367
|
+
Type: `Promise<IGridConfig>`
|
368
|
+
|
369
|
+
|
370
|
+
|
361
371
|
### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
|
362
372
|
|
363
373
|
Obtém os totalizadores da grade.
|
@@ -11,7 +11,6 @@
|
|
11
11
|
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
|
12
12
|
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
13
13
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
15
14
|
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
|
16
15
|
| `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
|
17
16
|
|
@@ -24,12 +24,11 @@
|
|
24
24
|
|
25
25
|
## Events
|
26
26
|
|
27
|
-
| Event | Description
|
28
|
-
| -------------------- |
|
29
|
-
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação.
|
30
|
-
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD.
|
31
|
-
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD.
|
32
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
27
|
+
| Event | Description | Type |
|
28
|
+
| -------------------- | ---------------------------------------------------------------------------- | --------------------- |
|
29
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
30
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
31
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
33
32
|
|
34
33
|
|
35
34
|
## Methods
|
@@ -9,6 +9,7 @@
|
|
9
9
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
|
12
|
+
| `_guideBuilders` | -- | | `Map<string, GuideBuilder>` | `new Map()` |
|
12
13
|
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
14
|
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
14
15
|
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
@@ -19,18 +20,16 @@
|
|
19
20
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
20
21
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
|
21
22
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
22
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
23
23
|
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
|
24
24
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
25
25
|
|
26
26
|
|
27
27
|
## Events
|
28
28
|
|
29
|
-
| Event
|
30
|
-
|
|
31
|
-
| `actionClick`
|
32
|
-
| `exit`
|
33
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
29
|
+
| Event | Description | Type |
|
30
|
+
| ------------- | ------------------------------------------------- | --------------------- |
|
31
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
32
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
34
33
|
|
35
34
|
|
36
35
|
## Methods
|
@@ -19,17 +19,15 @@
|
|
19
19
|
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
|
20
20
|
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
|
21
21
|
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
22
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
23
22
|
| `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
|
24
23
|
|
25
24
|
|
26
25
|
## Events
|
27
26
|
|
28
|
-
| Event | Description
|
29
|
-
| ----------------------- |
|
30
|
-
| `
|
31
|
-
| `
|
32
|
-
| `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
|
27
|
+
| Event | Description | Type |
|
28
|
+
| ----------------------- | ---------------------------------------------------------------- | --------------------------- |
|
29
|
+
| `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
|
30
|
+
| `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
|
33
31
|
|
34
32
|
|
35
33
|
## Methods
|
@@ -19,7 +19,6 @@
|
|
19
19
|
| `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
|
20
20
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
21
21
|
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
22
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
23
22
|
| `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
|
24
23
|
|
25
24
|
|
@@ -16,9 +16,10 @@
|
|
16
16
|
|
17
17
|
## Events
|
18
18
|
|
19
|
-
| Event | Description
|
20
|
-
| -------------- |
|
21
|
-
| `
|
19
|
+
| Event | Description | Type |
|
20
|
+
| -------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
21
|
+
| `saveConfig` | Evento emitido ao realizar alguma ação que altera os dados do config.value permitindo salvar estas informações | `CustomEvent<SnkFilterItemConfig>` |
|
22
|
+
| `valueChanged` | Emite um evento customizado ao realizar alteração nos valores do componente | `CustomEvent<CustomEvent<any>>` |
|
22
23
|
|
23
24
|
|
24
25
|
## Methods
|
@@ -12,7 +12,7 @@
|
|
12
12
|
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
|
13
13
|
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
|
14
14
|
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
|
15
|
-
| `configName` | `config-name` | Nome da
|
15
|
+
| `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
|
16
16
|
| `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
|
17
17
|
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
18
18
|
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
@@ -7,11 +7,10 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| ------------ |
|
12
|
-
| `configName` | `config-name`
|
13
|
-
| `filterItem` | --
|
14
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------ | ------------- | ---------------------------------------- | --------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
|
13
|
+
| `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
|
15
14
|
|
16
15
|
|
17
16
|
## Events
|
@@ -7,13 +7,12 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| ----------------- |
|
12
|
-
| `configName` | `config-name`
|
13
|
-
| `dataUnit` | --
|
14
|
-
| `filterConfig` | --
|
15
|
-
| `messagesBuilder` | --
|
16
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
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 todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
17
16
|
|
18
17
|
|
19
18
|
## Methods
|
@@ -7,21 +7,19 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| ------------------ |
|
12
|
-
| `configName` | `config-name`
|
13
|
-
| `messagesBuilder` | --
|
14
|
-
| `recordsValidator` | --
|
15
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
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
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
16
15
|
|
17
16
|
|
18
17
|
## Events
|
19
18
|
|
20
|
-
| Event
|
21
|
-
|
|
22
|
-
| `actionClick`
|
23
|
-
| `exit`
|
24
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
19
|
+
| Event | Description | Type |
|
20
|
+
| ------------- | ------------------------------------------------- | --------------------- |
|
21
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
22
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
25
23
|
|
26
24
|
|
27
25
|
## Methods
|
@@ -7,22 +7,20 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `actionsList`
|
13
|
-
| `canEdit`
|
14
|
-
| `
|
15
|
-
| `
|
16
|
-
| `
|
17
|
-
| `
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
22
|
-
| `
|
23
|
-
| `
|
24
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
25
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ---------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
14
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
15
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
16
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
17
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
18
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
19
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
20
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
21
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
22
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
23
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
26
24
|
|
27
25
|
|
28
26
|
## Events
|
@@ -13,7 +13,6 @@
|
|
13
13
|
| `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
|
14
14
|
| `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
|
15
15
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
16
|
-
| `resourceID` | `resource-i-d` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
17
16
|
| `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade. | `number` | `0` |
|
18
17
|
|
19
18
|
|
@@ -7,13 +7,12 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| ----------------- |
|
12
|
-
| `configName` | `config-name`
|
13
|
-
| `entityUri` | `entity-uri`
|
14
|
-
| `filterId` | `filter-id`
|
15
|
-
| `messagesBuilder` | --
|
16
|
-
| `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
|
13
|
+
| `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
|
14
|
+
| `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
17
16
|
|
18
17
|
|
19
18
|
## Events
|
@@ -23,12 +23,11 @@
|
|
23
23
|
|
24
24
|
## Events
|
25
25
|
|
26
|
-
| Event | Description
|
27
|
-
| ----------------- |
|
28
|
-
| `actionClick` | Emitido sempre que houver click de botão ou ação.
|
29
|
-
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit.
|
30
|
-
| `dataUnitReady` | Emitido quando o DataUnit está pronto.
|
31
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
26
|
+
| Event | Description | Type |
|
27
|
+
| ----------------- | --------------------------------------------------------- | ------------------------ |
|
28
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
29
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
30
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
32
31
|
|
33
32
|
|
34
33
|
## Methods
|
@@ -18,7 +18,6 @@
|
|
18
18
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
19
19
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
20
20
|
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
21
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
22
21
|
|
23
22
|
|
24
23
|
## Events
|