# snk-guides-viewer ## Properties | Property | Attribute | Description | Type | Default | | -------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------- | | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` | | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` | | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` | | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` | | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` | | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` | | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` | | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` | | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` | | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` | | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` | | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` | | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` | | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` | | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` | | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` | | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` | | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` | ## Events | Event | Description | Type | | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- | | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent` | | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent` | | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent` | | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent` | ## Methods ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise` Registra um editor customizado para campos da grade e formulário #### Returns Type: `Promise` --- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise` Registra um render customizado para colunas da grid. #### Returns Type: `Promise` --- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise` Altera/adiciona uma propriedade nos metadados do campo. #### Returns Type: `Promise` --- ### `setFocus() => Promise` Atribui o foco para o componente. #### Returns Type: `Promise` --- ### `showFormConfig(detail?: boolean) => Promise` Abre o configurador do formulário #### Returns Type: `Promise` ## Dependencies ### Used by - [snk-crud](..) ### Depends on - [snk-form-view](.) - [snk-data-unit](../../snk-data-unit) - [snk-detail-view](snk-detail-view) - [snk-taskbar](../../snk-taskbar) - [snk-form-config](../../snk-form-config) - [snk-configurator](../../snk-configurator) - [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-guides-viewer --> snk-form-view snk-guides-viewer --> snk-data-unit snk-guides-viewer --> snk-detail-view snk-guides-viewer --> snk-taskbar snk-guides-viewer --> snk-form-config snk-guides-viewer --> snk-configurator snk-guides-viewer --> snk-data-exporter snk-guides-viewer --> snk-actions-button snk-guides-viewer --> taskbar-split-button snk-guides-viewer --> taskbar-actions-button snk-form-view --> snk-form-summary snk-detail-view --> snk-data-unit snk-detail-view --> snk-grid snk-detail-view --> snk-form-view snk-detail-view --> snk-taskbar snk-detail-view --> snk-attach snk-detail-view --> snk-data-exporter snk-detail-view --> snk-actions-button snk-detail-view --> taskbar-split-button snk-detail-view --> taskbar-actions-button snk-grid --> snk-filter-bar snk-grid --> snk-taskbar snk-grid --> snk-grid-config snk-grid --> snk-data-exporter snk-grid --> snk-actions-button snk-grid --> taskbar-split-button snk-grid --> taskbar-actions-button snk-filter-bar --> snk-filter-item snk-filter-bar --> snk-personalized-filter snk-filter-bar --> snk-filter-modal snk-filter-item --> snk-filter-detail snk-personalized-filter --> snk-filter-field-search snk-personalized-filter --> snk-filter-assistent-mode snk-personalized-filter --> snk-filter-advanced-mode snk-personalized-filter --> snk-simple-bar snk-filter-assistent-mode --> snk-expression-group snk-expression-group --> snk-expression-item snk-expression-group --> snk-expression-group snk-expression-item --> snk-filter-field-search snk-expression-item --> snk-filter-param-config snk-filter-modal --> snk-filter-modal-item snk-filter-modal --> snk-default-filter 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-grid-config --> snk-select-box snk-attach --> snk-simple-bar snk-attach --> snk-simple-crud 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-configurator --> snk-layout-form-config snk-layout-form-config --> snk-view-representation snk-form-config --> config-header snk-form-config --> guides-configurator snk-form-config --> fields-layout snk-form-config --> fields-selector config-header --> configs-button fields-layout --> field-item field-item --> field-config fields-selector --> field-item snk-crud --> snk-guides-viewer style snk-guides-viewer fill:#f9f,stroke:#333,stroke-width:4px ``` ----------------------------------------------