# snk-simple-crud



<!-- Auto Generated Below -->


## Properties

| Property                        | Attribute                           | Description                   | Type                                                    | Default                   |
| ------------------------------- | ----------------------------------- | ----------------------------- | ------------------------------------------------------- | ------------------------- |
| `actionsList`                   | --                                  |                               | `Action[]`                                              | `undefined`               |
| `autoFocus`                     | `auto-focus`                        |                               | `boolean`                                               | `true`                    |
| `autoLoad`                      | `auto-load`                         |                               | `boolean`                                               | `undefined`               |
| `configName`                    | `config-name`                       |                               | `string`                                                | `undefined`               |
| `dataState`                     | --                                  |                               | `DataState`                                             | `undefined`               |
| `dataUnit`                      | --                                  |                               | `DataUnit`                                              | `undefined`               |
| `disableGridEdition`            | `disable-grid-edition`              | Desabilita a edição na grade. | `boolean`                                               | `false`                   |
| `domainMessagesBuilder`         | `domain-messages-builder`           |                               | `string`                                                | `undefined`               |
| `enableContinuousInsert`        | `enable-continuous-insert`          |                               | `boolean`                                               | `false`                   |
| `enableGridInsert`              | `enable-grid-insert`                |                               | `boolean`                                               | `false`                   |
| `enableLockManagerLoadingComp`  | `enable-lock-manager-loading-comp`  |                               | `boolean`                                               | `false`                   |
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` |                               | `boolean`                                               | `false`                   |
| `entityName`                    | `entity-name`                       |                               | `string`                                                | `undefined`               |
| `formConfig`                    | --                                  |                               | `IFormConfig`                                           | `undefined`               |
| `formLegacyConfigName`          | `form-legacy-config-name`           |                               | `string`                                                | `undefined`               |
| `gridConfig`                    | --                                  |                               | `IGridConfig`                                           | `undefined`               |
| `gridLegacyConfigName`          | `grid-legacy-config-name`           |                               | `string`                                                | `undefined`               |
| `ignoreReadOnlyFormFields`      | `ignore-read-only-form-fields`      |                               | `boolean`                                               | `false`                   |
| `layoutFormConfig`              | `layout-form-config`                |                               | `boolean`                                               | `true`                    |
| `messagesBuilder`               | --                                  |                               | `SnkMessageBuilder`                                     | `undefined`               |
| `mode`                          | `mode`                              |                               | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
| `multipleEditionEnabled`        | `multiple-edition-enabled`          |                               | `boolean`                                               | `true`                    |
| `multipleSelection`             | `multiple-selection`                |                               | `boolean`                                               | `undefined`               |
| `outlineMode`                   | `outline-mode`                      |                               | `boolean`                                               | `false`                   |
| `pageSize`                      | `page-size`                         |                               | `number`                                                | `150`                     |
| `paginationCounterMode`         | `pagination-counter-mode`           |                               | `"auto" \| "hidden" \| "show"`                          | `'auto'`                  |
| `resourceID`                    | `resource-i-d`                      |                               | `string`                                                | `undefined`               |
| `showConfiguratorButtons`       | `show-configurator-buttons`         |                               | `boolean`                                               | `false`                   |
| `taskbarManager`                | --                                  |                               | `TaskbarManager`                                        | `undefined`               |
| `useCancelConfirm`              | `use-cancel-confirm`                |                               | `boolean`                                               | `true`                    |
| `useEnterLikeTab`               | `use-enter-like-tab`                |                               | `boolean`                                               | `false`                   |


## Events

| Event                | Description | Type                         |
| -------------------- | ----------- | ---------------------------- |
| `actionClick`        |             | `CustomEvent<string>`        |
| `configuratorCancel` |             | `CustomEvent<any>`           |
| `configuratorSave`   |             | `CustomEvent<any>`           |
| `dataStateChange`    |             | `CustomEvent<DataState>`     |
| `dataUnitReady`      |             | `CustomEvent<DataUnit>`      |
| `formItemsReady`     |             | `CustomEvent<HTMLElement[]>` |


## Methods

### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

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



#### Returns

Type: `Promise<void>`

---

### `getRecords() => Promise<Array<Record>>`



#### Returns

Type: `Promise<Record[]>`

Uma promessa que resolve com a lista de registros.

---

### `goToView(view: VIEW_MODE) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

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



#### Returns

Type: `Promise<void>`

---

### `removeCustomValueFormatter(columnName: string) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

### `setMetadata(metadata: UnitMetadata) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

### `setRecords(records: Array<Record>) => Promise<void>`



#### Returns

Type: `Promise<void>`

---

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



#### Returns

Type: `Promise<void>`




## Dependencies

### Used by

 - [snk-attach](../snk-attach)

### Depends on

- [snk-taskbar](../snk-taskbar)
- [snk-data-unit](../snk-data-unit)
- [snk-simple-form-config](../snk-simple-form-config)
- [snk-configurator](../snk-configurator)
- [snk-grid-config](../snk-grid-config)
- [snk-data-exporter](../snk-data-exporter)
- [snk-actions-button](../snk-actions-button)
- [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)

### Graph
```mermaid
graph TD;
  snk-simple-crud --> snk-taskbar
  snk-simple-crud --> snk-data-unit
  snk-simple-crud --> snk-simple-form-config
  snk-simple-crud --> snk-configurator
  snk-simple-crud --> snk-grid-config
  snk-simple-crud --> snk-data-exporter
  snk-simple-crud --> snk-actions-button
  snk-simple-crud --> taskbar-split-button
  snk-simple-crud --> taskbar-actions-button
  snk-taskbar --> snk-data-exporter
  snk-taskbar --> snk-actions-button
  snk-taskbar --> taskbar-split-button
  snk-taskbar --> taskbar-actions-button
  snk-data-exporter --> snk-exporter-email-sender
  snk-configurator --> snk-layout-form-config
  snk-layout-form-config --> snk-view-representation
  snk-grid-config --> snk-select-box
  snk-attach --> snk-simple-crud
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
```

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