@po-ui/ng-templates 19.26.0 → 20.0.0

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-detail.interface.d.ts

@@ -1,21 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeDetail`.
- */
-export interface PoPageDynamicTableBeforeDetail {
-    /**
-     * Nova rota para abrir o detalhe, deve substituir a função ou rota definida anteriormente
-     * > Se for uma url literal, será feito o navigate direto ex: `/view/22`.
-     *
-     * > Se a url ter o coringa `:id` esse id será substituído pela chave do recurso ex: `/view/:id` será convertido para `/view/22`.
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de ir para o detalhe
-     */
-    allowAction?: boolean;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-duplicate.interface.d.ts

@@ -1,29 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeDuplicate`.
- */
-export interface PoPageDynamicTableBeforeDuplicate {
-    /**
-     * Nova rota para navegação que substituirá a definida anteriormente em `duplicate`.
-     *
-     * > Os valores a serem duplicados serão enviados via query string, exceto para aqueles definidos como `key: true`.
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de duplicação de recurso (*duplicate*)
-     */
-    allowAction?: boolean;
-    /**
-     *  Objeto com as novas propriedades para duplicação, o mesmo substituirá o objeto atual.
-     *
-     * > Essa opção não abrange campos configurados com `key: true`.
-     *
-     * > Os novos valores a serem duplicados serão enviados via query string.
-     *
-     */
-    resource?: any;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-edit.interface.d.ts

@@ -1,22 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeEdit`.
- */
-export interface PoPageDynamicTableBeforeEdit {
-    /**
-     * Nova rota para navegação que substituirá a definida anteriormente em `edit`.
-     *
-     * > Se for uma url literal, será feito o navigate direto ex: `/edit/22`.
-     *
-     * > Se a url tiver o coringa `:id` esse id será substituído pela chave do recurso ex: `/edit/:id` será convertido para `/edit/22`.
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de edição (*edit*)
-     */
-    allowAction?: boolean;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-new.interface.d.ts

@@ -1,18 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeNew`.
- */
-export interface PoPageDynamicTableBeforeNew {
-    /**
-     * Nova rota para salvar o recurso, que substituirá a rota definida anteriormente em `new`.
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de inserção (new)
-     */
-    allowAction?: boolean;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-remove-all.interface.d.ts

@@ -1,39 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeRemoveAll`.
- */
-export interface PoPageDynamicTableBeforeRemoveAll {
-    /**
-     * Nova rota para enviar o `remove all`, deve substituir a rota definida anteriormente.
-     *
-     * Caso o `remove all` seja configurado como função e for passado o atributo `newUrl`
-     * a função será ignorada e o comando será enviado pela rota definida em `newUrl`
-     *
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de exclusão `(remove all)`
-     */
-    allowAction?: boolean;
-    /**
-     * Lista com as keys dos recursos que serão enviados para a ação `removeAll`
-     * que por sua vez excluirá os itens da tabela.
-     * Deve substituir a lista selecionada na tela pelo usuário.
-     *
-     * A lista é construída com todas as propriedades marcadas com o atributo `key: true`
-     * na sua definição.
-     * Por exemplo:
-     *
-     * - Recursos com as propriedades id e name definidas como *key*:
-     *   ```
-     *   [{ id: 1, name: 'Mario' },{ id: 2, name: 'Gabriel' }]
-     *   ```
-     *
-     * Esse recurso será passado para a ação `removeAll` também se for um array vazio `[]`
-     */
-    resources?: Array<any>;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-remove.interface.d.ts

@@ -1,18 +0,0 @@
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Definição da estrutura de retorno da url ou método executado através da
- * propriedade `beforeRemove`.
- */
-export interface PoPageDynamicTableBeforeRemove {
-    /**
-     * Nova rota para enviar o delete, deve substituir a função ou rota definida anteriormente
-     */
-    newUrl?: string;
-    /**
-     * Define se deve ou não executar a ação de exclusão (delete)
-     */
-    allowAction?: boolean;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-custom-action.interface.d.ts

@@ -1,97 +0,0 @@
-import { TemplateRef } from '@angular/core';
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Interface com as propriedades para adicionar uma ação customizada na página.
- */
-export interface PoPageDynamicTableCustomAction {
-    /**
-     * Rótulo do botão que será exibido.
-     */
-    label: string;
-    /**
-     * Ação que será executada ao clicar no botão.
-     *
-     * A ação do tipo string representa um endpoint que deverá ser do tipo `POST`.
-     *
-     * Ao referenciar uma função, utilize em conjunto a propriedade `.bind()`, desta forma:
-     * ```
-     * action: this.myFunction.bind(this)
-     * ```
-     *
-     * Tanto o endpoint quanto a função, receberá o recurso selecionado pelo usuário na tabela, caso
-     * a propriedade `selectable` seja `true`.
-     *
-     * > Ao utilizar a propriedade `url` e a `action`, somente a `action` será executada.
-     */
-    action?: string | ((resources?: any) => void);
-    /**
-     * Rota para o qual será redirecionado ao clicar no botão.
-     *
-     * > Ao utilizar a propriedade `url` e a `action`, somente a `action` será executada.
-     */
-    url?: string;
-    /**
-     * Ao utilizar essa propriedade ela habilita a seleção na tabela e também desabilita
-     * o botão de ação caso nenhum recurso for selecionado.
-     */
-    selectable?: boolean;
-    /**
-     * @description
-     *
-     * Define um ícone que será exibido ao lado esquerdo do rótulo.
-     *
-     * É possível usar qualquer um dos ícones da [Biblioteca de ícones](https://po-ui.io/icons). conforme exemplo abaixo:
-     * ```
-     * <po-component
-     *  [p-property]="[{ label: 'PHOSPHOR ICON', icon: 'an an-newspaper' }]">
-     * </po-component>
-     * ```
-     *
-     * Também é possível utilizar outras fontes de ícones, por exemplo a biblioteca Font Awesome, da seguinte forma:
-     * ```
-     * <po-component
-     *  [p-property]="[{ label: 'FA ICON', icon: 'fa fa-icon-podcast' }]">
-     * </po-component>
-     * ```
-     *
-     * Outra opção seria a customização do ícone através do `TemplateRef`, conforme exemplo abaixo:
-     * component.html:
-     * ```
-     * <ng-template #iconTemplate>
-     *   <ion-icon name="heart"></ion-icon>
-     * </ng-template>
-     *
-     * <po-component [p-property]="myProperty"></po-component>
-     * ```
-     * component.ts:
-     * ```
-     * @ViewChild('iconTemplate', { static: true } ) iconTemplate : TemplateRef<void>;
-     *
-     * myProperty = [
-     *  {
-     *    label: 'FA ICON',
-     *    icon: this.iconTemplate
-     *  }
-     * ];
-     * ```
-     */
-    icon?: string | TemplateRef<void>;
-    /**
-     * @description
-     *
-     * Define se a ação será visível.
-     *
-     * > Caso o valor não seja especificado a ação será visível.
-     *
-     * Opções para tornar a ação visível ou não:
-     *
-     *  - Função que deve retornar um booleano.
-     *
-     *  - Informar diretamente um valor booleano.
-     *
-     */
-    visible?: boolean | Function;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-custom-table-action.interface.d.ts

@@ -1,106 +0,0 @@
-import { TemplateRef } from '@angular/core';
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Interface com as propriedades para adicionar uma ação customizada na tabela da página.
- */
-export interface PoPageDynamicTableCustomTableAction {
-    /**
-     * Rótulo do botão que será exibido.
-     */
-    label: string;
-    /**
-     * Ação que será executada ao clicar no botão.
-     *
-     * A ação do tipo string representa um endpoint que deverá ser do tipo `POST`.
-     *
-     * Ao referenciar uma função, utilize em conjunto a propriedade `.bind()`, desta forma:
-     * ```
-     * action: this.myFunction.bind(this)
-     * ```
-     *
-     * Tanto o endpoint quanto a função recebem o recurso da linha que a ação foi disparada.
-     * Podem também retornar o recurso com dados alterados que, consequentemente, serão atualizados na tabela.
-     *
-     * > Ao utilizar a propriedade `url` e a `action`, somente a `action` será executada.
-     */
-    action?: string | ((resource?: any) => any);
-    /**
-     * Função que deve retornar um booleano para habilitar ou desabilitar a ação para o registro selecionado.
-     *
-     * Também é possível informar diretamente um valor booleano que vai habilitar ou desabilitar a ação para todos os registros.
-     */
-    disabled?: boolean | Function;
-    /**
-     * Rota para o qual será redirecionado ao clicar no botão.
-     *
-     * > Ao utilizar a propriedade `url` e a `action`, somente a `action` será executada.
-     */
-    url?: string;
-    /**
-     * Permite concatenar o valor de propriedades definidas como keys na url via path parameter.
-     *
-     * Caso exista a necessidade de se utiizar mais de uma key, a concatenação entre as keys será separado por vírgulas, conforme exemplo: `/cidade/2,Joinville`
-     *
-     * > Poderá ser utilizada somente em conjunto com a propriedade PoPageDynamicTableCustomTableAction.url, tanto para URL interna quanto url externa.
-     */
-    concatKeys?: boolean;
-    /**
-     * @description
-     *
-     * Define um ícone que será exibido ao lado esquerdo do rótulo.
-     *
-     * É possível usar qualquer um dos ícones da [Biblioteca de ícones](https://po-ui.io/icons). conforme exemplo abaixo:
-     * ```
-     * <po-component
-     *  [p-property]="[{ label: 'PHOSPHOR ICON', icon: 'an an-newspaper' }]">
-     * </po-component>
-     * ```
-     *
-     * Também é possível utilizar outras fontes de ícones, por exemplo a biblioteca Font Awesome, da seguinte forma:
-     * ```
-     * <po-component
-     *  [p-property]="[{ label: 'FA ICON', icon: 'fa fa-icon-podcast' }]">
-     * </po-component>
-     * ```
-     *
-     * Outra opção seria a customização do ícone através do `TemplateRef`, conforme exemplo abaixo:
-     * component.html:
-     * ```
-     * <ng-template #iconTemplate>
-     *   <ion-icon name="heart"></ion-icon>
-     * </ng-template>
-     *
-     * <po-component [p-property]="myProperty"></po-component>
-     * ```
-     * component.ts:
-     * ```
-     * @ViewChild('iconTemplate', { static: true } ) iconTemplate : TemplateRef<void>;
-     *
-     * myProperty = [
-     *  {
-     *    label: 'FA ICON',
-     *    icon: this.iconTemplate
-     *  }
-     * ];
-     * ```
-     */
-    icon?: string | TemplateRef<void>;
-    /**
-     * @description
-     *
-     * Define se a ação será visível.
-     *
-     * > Caso o valor não seja especificado a ação será visível.
-     *
-     * Opções para tornar a ação visível ou não:
-     *
-     *  - Função que deve retornar um booleano.
-     *
-     *  - Informar diretamente um valor booleano.
-     *
-     */
-    visible?: boolean | Function;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-field.interface.d.ts

@@ -1,49 +0,0 @@
-import { PoDynamicFormField, PoTableColumnLabel } from '@po-ui/ng-components';
-/**
- * @docsExtends PoDynamicFormField
- *
- */
-export interface PoPageDynamicTableField extends PoDynamicFormField {
-    /** Indica se o campo será duplicado caso seja executada a ação de duplicação. */
-    duplicate?: boolean;
-    /** Indica se o campo será usado para busca avançada. */
-    filter?: boolean;
-    /** Tamanho da coluna em pixels ou porcetagem. */
-    width?: number | string;
-    /**
-     * Permite o campo aparecer no gerenciador de colunas, mesmo que esteja utilizando `visible: false`,
-     * possibilitando ativar a exibição na tabela.
-     *
-     * > Quando for `false`, será desconsiderado.
-     */
-    allowColumnsManager?: boolean;
-    /**
-     * @optional
-     *
-     * @description
-     *
-     * Controla se a coluna será considerada como "ordenável". Caso seja definido um valor falso, a coluna não será usada para
-     * ordenação.
-     *
-     * @default `true`
-     */
-    sortable?: boolean;
-    /**
-     * Lista de objetos do tipo `PoTableColumnLabel` que representa as labels disponíveis na coluna do tipo `label`.
-     *
-     * Exemplo de utilização
-     *
-     * ```
-     * {
-     *   property: 'uf',
-     *   label: 'Estados',
-     *   type: 'label',
-     *   labels: [
-     *     { value: 'SC', label: 'SANTA CATARINA', color: 'color-02' },
-     *     { value: 'SP', label: 'SAO PAULO', color: 'color-10' }
-     *   ],
-     * }
-     * ```
-     */
-    labels?: Array<PoTableColumnLabel>;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-filters.interface.d.ts

@@ -1,30 +0,0 @@
-import { PoPageDynamicTableField } from '../../..';
-/**
- * @docsExtends PoPageDynamicTableField
- *
- * @usedBy PoPageDynamicTableComponent
- *
- * @ignoreExtendedDescription
- *
- * @description
- *
- * Interface para a customização de uma página dinâmica que permite atribuir valores iniciais aos filtros de busca avançada.
- */
-export interface PoPageDynamicTableFilters extends PoPageDynamicTableField {
-    /**
-     * Define um Valor inicial para um filtro de busca avançada.
-     */
-    initValue?: any;
-    /**
-     * @optional
-     *
-     * @description
-     *
-     * Controla se o filtro será fixo, ou seja, não poderá ser alterado pelo usuário no filtro avançado.
-     * Caso seja definido um valor true, o filtro não será apresentado na tela de filtro avançado, porém continuará sendo utilizado como filtro.
-     * Por esse motivo deverá ser utilizado em conjunto com as propriedades `filter` e `initValue`.
-     *
-     * @default `false`
-     */
-    fixed?: boolean;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-metadata.interface.d.ts

@@ -1,31 +0,0 @@
-import { PoPageDynamicTableOptions } from './po-page-dynamic-table-options.interface';
-/**
- * @docsExtends PoPageDynamicTableOptions
- *
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * <a id="po-page-dynamic-table-metadata"></a>
- *
- */
-export interface PoPageDynamicTableMetaData extends PoPageDynamicTableOptions {
-    /**
-     *
-     * Cria automaticamente as rotas de edição (novo/duplicate) e detalhes caso sejam definidas ações na propriedade `p-actions`
-     *
-     * As rotas criadas serão baseadas na propriedade `p-actions`.
-     *
-     * > Para o correto funcionamento não pode haver nenhuma rota coringa (`**`) especificada.
-     *
-     * @default false
-     */
-    autoRouter?: boolean;
-    /**
-     *
-     * Versão do metadata, o sistema irá buscar a versão nas próximas iteração.
-     *
-     * @default false
-     */
-    version?: string;
-}

package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-options.interface.d.ts

@@ -1,105 +0,0 @@
-import { PoBreadcrumb } from '@po-ui/ng-components';
-import { PoPageDynamicTableActions } from './po-page-dynamic-table-actions.interface';
-import { PoPageDynamicTableFilters } from './po-page-dynamic-table-filters.interface';
-import { PoPageDynamicTableCustomAction } from './po-page-dynamic-table-custom-action.interface';
-import { PoPageDynamicTableCustomTableAction } from './po-page-dynamic-table-custom-table-action.interface';
-/**
- * @usedBy PoPageDynamicTableComponent
- *
- * @description
- *
- * Interface para as propriedades de uma página dinâmica.
- */
-export interface PoPageDynamicTableOptions {
-    /**
-     * Lista dos campos usados na tabela e busca avançada.
-     *
-     * Caso precise alterar um field que já exista deve ser passado o atributo `property` com o mesmo conteúdo do original.
-     */
-    fields?: Array<PoPageDynamicTableFilters>;
-    /**
-     * Ações que o usuário poderá executar na página através de botões.
-     */
-    actions?: PoPageDynamicTableActions;
-    /**
-     * Objeto com propriedades do breadcrumb.
-     *
-     * Caso esse atributo seja utilizado ele sempre irá substituir o original.
-     */
-    breadcrumb?: PoBreadcrumb;
-    /**
-     * Título da página.
-     *
-     * Caso esse atributo seja utilizado ele sempre irá substituir o original.
-     */
-    title?: string;
-    /**
-     * Mantém na modal de Busca Avançada os valores preenchidos do último filtro realizado pelo usuário.
-     *
-     * Caso esse atributo seja utilizado ele sempre irá substituir o original.
-     */
-    keepFilters?: boolean;
-    /**
-     * Permite a utilização da pesquisa rápida junto com a pesquisa avançada.
-     *
-     * Desta forma, ao ter uma pesquisa avançada estabelecida e ser
-     * preenchido a pesquisa rápida, o filtro será concatenado adicionando a pesquisa
-     * rápida também na lista de `disclaimers` a aplicando uma nova busca com a concatenação.
-     *
-     * Por exemplo, com os seguintes filtros aplicados:
-     *   - filtro avançado: `{ name: 'Mike', age: '12' }`
-     *   - filtro rápido: `{ search: 'paper' }`
-     *
-     * A requisição dos dados na API ficará com os parâmetros:
-     * ```
-     * page=1&pageSize=10&name=Mike&age=12&search=paper
-     * ```
-     */
-    concatFilters?: boolean;
-    /**
-     * Oculta o botão para remover todos os *disclaimers*.
-     */
-    hideRemoveAllDisclaimer?: boolean;
-    /**
-     * Lista de filtros que terão a opção de fechar ocultada
-     * em seu respectivo disclaimer. Utilizar o atributo `property` do campo.
-     *
-     * Exemplo de utilização:
-     * ```
-     * ['city','name'];
-     * ```
-     */
-    hideCloseDisclaimers?: Array<string>;
-    /**
-     * Lista de ações customizadas da página que serão incorporadas às ações informadas através da propriedade `actions`
-     *
-     * Essas ações ficam localizadas na parte superior da página em botões com ações.
-     *
-     * Exemplo de utilização:
-     * ```
-     * [
-     *  { label: 'Export', action: this.export.bind(this) },
-     *  { label: 'Print', action: this.print.bind(this) }
-     * ];
-     * ```
-     */
-    pageCustomActions?: Array<PoPageDynamicTableCustomAction>;
-    /**
-     * Lista de ações customizadas da tabela que serão incorporadas às ações informadas através da propriedade `actions`.
-     *
-     * Exemplo de utilização:
-     * ```
-     * [
-     *  { label: 'Apply Discount', action: this.applyDiscount.bind(this) },
-     *  { label: 'Details', action: this.details.bind(this) }
-     * ];
-     * ```
-     */
-    tableCustomActions?: Array<PoPageDynamicTableCustomTableAction>;
-    /**
-     * Largura do campo de busca, utilizando o *Grid System*,
-     * e limitado ao máximo de 6 colunas. O tamanho mínimo é controlado
-     * conforme resolução de tela para manter a consistência do layout.
-     */
-    quickSearchWidth?: number;
-}