# snk-configurator



<!-- Auto Generated Below -->


## Properties

| Property            | Attribute             | Description                                                                            | Type                                                       | Default          |
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
| `configName`        | `config-name`         | Usado para guardar ou recuperar as configurações do formulário.                        | `string`                                                   | `undefined`      |
| `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator.                  | `string`                                                   | `undefined`      |
| `layoutFormConfig`  | `layout-form-config`  | Define se o LayoutFormConfig será exibido no configurador.                             | `boolean`                                                  | `true`           |
| `messagesBuilder`   | --                    | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`                                        | `undefined`      |
| `resourceID`        | `resource-i-d`        | Identificador de recursos como configurações e acesso.                                 | `string`                                                   | `undefined`      |
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação                                                    | `boolean`                                                  | `false`          |
| `viewMode`          | `view-mode`           | Define qual modo de visualização está ativo.                                           | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |


## Events

| Event            | Description                                          | Type                                                                    |
| ---------------- | ---------------------------------------------------- | ----------------------------------------------------------------------- |
| `cancel`         | Emitido quando cancela o salvamento da configuração. | `CustomEvent<void>`                                                     |
| `configSelected` | Emitido quando seleciona o modo de visualização.     | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
| `openConfig`     | Emitido quando clica para abrir a configuração.      | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
| `save`           | Emitido quando salva a configuração.                 | `CustomEvent<void>`                                                     |


## Methods

### `close() => Promise<void>`

Fecha a janela de configuração.

#### Returns

Type: `Promise<void>`

---

### `open() => Promise<void>`

Exibe a janela de configuração.

#### Returns

Type: `Promise<void>`




## Dependencies

### Used by

 - [snk-crud](../snk-crud)
 - [snk-guides-viewer](../snk-crud/subcomponents)
 - [snk-simple-crud](../snk-simple-crud)

### Depends on

- [snk-layout-form-config](../snk-layout-form-config)

### Graph
```mermaid
graph TD;
  snk-configurator --> snk-layout-form-config
  snk-layout-form-config --> snk-view-representation
  snk-crud --> snk-configurator
  snk-guides-viewer --> snk-configurator
  snk-simple-crud --> snk-configurator
  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------