@po-ui/ng-components 5.22.0 → 5.22.4

package/lib/components/po-dynamic/po-dynamic-form/po-dynamic-form-field.interface.d.ts

@@ -1,249 +1,249 @@
-import { PoComboFilter, PoLookupFilter } from '../../po-field';
-import { PoLookupColumn } from '../../po-field/po-lookup/interfaces/po-lookup-column.interface';
-import { PoMultiselectOption } from '../../po-field/po-multiselect/po-multiselect-option.interface';
-import { PoSelectOption } from '../../po-field/po-select/po-select-option.interface';
-import { PoDynamicField } from '../po-dynamic-field.interface';
-/**
- * @usedBy PoDynamicFormComponent, PoAdvancedFilterComponent, PoPageDynamicSearchComponent
- *
- * @docsExtends PoDynamicField
- *
- * @description
- *
- * Interface para definição das propriedades dos campos de entrada que serão criados dinamicamente.
- */
-export interface PoDynamicFormField extends PoDynamicField {
-    /**
-     * Define as colunas para utilização da busca avançada. Usada somente em conjunto com a propriedade `searchService`,
-     * essa propriedade deve receber um array de objetos que implementam a interface [`PoLookupColumn`](/documentation/po-lookup).
-     *
-     * > Caso sejam informadas colunas, deve-se obrigatoriamente conter colunas definidas como *label* e *value* para valores
-     * de tela e do model respectivamente.
-     */
-    columns?: Array<PoLookupColumn>;
-    /** Define a obrigatoriedade do campo. */
-    required?: boolean;
-    /**
-     * Define se a indicação de campo opcional será exibida.
-     *
-     * > A indicação não será exibida, se:
-     * - O campo for `required`, ou;
-     * - Não possuir `help` e `label`.
-     */
-    optional?: boolean;
-    /** Lista de opções que serão exibidos em um componente, podendo selecionar uma opção. */
-    options?: Array<string> | Array<PoSelectOption> | Array<PoMultiselectOption>;
-    /**
-     * Permite que o usuário faça múltipla seleção dentro da lista de opções.
-     */
-    optionsMulti?: boolean;
-    /**
-     *  Serviço que será utilizado para buscar os itens e preencher a lista de opções dinamicamente.
-     *  Pode ser informada uma URL ou uma instancia do serviço baseado em PoComboFilter.
-     *  **Importante**
-     *  > Para que funcione corretamente, é importante que o serviço siga o
-     *  [guia de API do PO UI](https://po-ui.io/guides/api).
-     */
-    optionsService?: string | PoComboFilter;
-    /**
-     * Serviço que será utilizado para realizar a busca avançada. Pode ser utilizado em conjunto com a propriedade `columns`.
-     * Pode ser ser informada uma URL ou uma instancia do serviço baseado em PoLookupFilter.
-     * **Importante:**
-     * > Caso utilizar a propriedade `optionsService` esta propriedade será ignorada.
-     * > Para que funcione corretamente, é importante que o serviço siga o
-     * [guia de API do PO UI](https://po-ui.io/guides/api).
-     */
-    searchService?: string | PoLookupFilter;
-    /** Máscara para o campo. */
-    mask?: string;
-    /** Define que o valor do componente será conforme especificado na mascára. O valor padrão é `false`. */
-    maskFormatModel?: boolean;
-    /** Define o ícone que será exibido no início do campo.
-     * > Esta propriedade o pode ser utilizado nos campos:
-     * - Input;
-     * - Number;
-     * - Decimal;
-     * - Combo;
-     *
-     * > Veja a disponibilidade de ícones em [biblioteca de ícones](guides/icons).
-     */
-    icon?: string;
-    /**  Quantidade máxima de casas decimais.
-     *
-     * > Esta propriedade só pode ser utilizada quando o `type` for *currency*.
-     */
-    decimalsLength?: number;
-    /** Quantidade máxima de dígitos antes do separador decimal. O valor máximo permitido é 13
-     *
-     * > Esta propriedade só pode ser utilizada quando o `type` for *currency*.
-     */
-    thousandMaxlength?: number;
-    /** Regex para validação do campo. */
-    pattern?: string;
-    /** Tamanho mínimo de caracteres. */
-    minLength?: number;
-    /** Tamanho máximo de caracteres. */
-    maxLength?: number;
-    /** Desabilita o campo caso informar o valor *true*. */
-    disabled?: boolean;
-    /** Texto de ajuda. */
-    help?: string;
-    /** Texto exibido quando o valor do componente for *true*. */
-    booleanTrue?: string;
-    /** Texto exibido quando o valor do componente for *false*. */
-    booleanFalse?: string;
-    /** Valor máximo a ser informado no componente, podendo ser utilizado quando o tipo de dado por *number*, *date* ou *dateTime*. */
-    maxValue?: string | number;
-    /** Valor mínimo a ser informado no componente, podendo ser utilizado quando o tipo de dado por *number*, *date* ou *dateTime*. */
-    minValue?: string | number;
-    /** Quantidade de linhas exibidas no `po-textarea`. */
-    rows?: number;
-    /** Esconde a informação estilo *password*, pode ser utilizado quando o tipo de dado for *string*. */
-    secret?: boolean;
-    /**
-     * Função ou serviço para validar as **mudanças do campo**.
-     *
-     * * A propriedade aceita os seguintes tipos:
-     * - **String**: Endpoint usado pelo componente para requisição via `POST`.
-     * - **Function**: Método que será executado.
-     *
-     * Ao ser executado, irá receber como parâmetro um objeto com o nome da propriedade
-     * alterada e o novo valor, conforme a interface `PoDynamicFormFieldChanged`:
-     *
-     * ```
-     * { property: 'property name', value: 'new value' }
-     * ```
-     *
-     * O retorno desta função deve ser do tipo [PoDynamicFormFieldValidation](documentation/po-dynamic-form#po-dynamic-form-field-validation),
-     * onde o usuário poderá determinar as novas propriedades do campo.
-     * Por exemplo:
-     *
-     * ```
-     * onChangeField(changeValue): PoDynamicFormFieldValidation {
-     *
-     * if (changeValue.property === 'birthday' && !this.validate('birthday')) {
-     *   return {
-     *     value: '',
-     *     field: { property: 'birthday', required: true },
-     *     focus: true
-     *   };
-     * }
-     * ```
-     *
-     * Para referenciar a sua função utilize a propriedade `bind`, por exemplo:
-     * ```
-     * { property: 'state', gridColumns: 6, validate: this.myFunction.bind(this) }
-     * ```
-     */
-    validate?: string | Function;
-    /**
-     * Objeto que será enviado como parâmetro nas requisições de busca usados pelos componentes `po-lookup` e
-     * `po-combo`.
-     *
-     * Por exemplo, para o parâmetro `{ age: 23 }` a URL da requisição ficaria:
-     *
-     * ```
-     * url + ?age=23&filter=Peter
-     * ```
-     */
-    params?: any;
-    /**
-     * Mensagem que será apresentada quando o campo ficar inválido.
-     *
-     * O campo fica inválido quando as seguintes propriedades não forem respeitadas:
-     *  - pattern;
-     *  - minValue;
-     *  - maxValue;
-     *
-     * > Esta mensagem não é apresentada quando o campo estiver vazio, mesmo que ele seja requerido.
-     */
-    errorMessage?: string;
-    /**
-     * Formato de exibição no campo.
-     *
-     * Ao utilizar esta propriedade com o `type` *PoDynamicFieldType.Date* ou *PoDynamicFieldType.DateTime*,
-     * pode ser utilizada para formatação de exibição da data:
-     *
-     * Valores válidos:
-     *
-     * - dd/mm/yyyy
-     * - mm/dd/yyyy
-     * - yyyy/mm/dd
-     *
-     *
-     * Também pode-se utilizar em conjunto com `searchService`, informando uma lista de propriedades que será utilizado
-     * para formatação da exibição no campo, por exemplo: ["id", "name"].
-     */
-    format?: string | Array<string>;
-    /**
-     * Nome da propriedade do objeto retornado que será utilizado como descrição do campo.
-     *
-     * O valor padrão é: `label`.
-     *
-     * > Esta propriedade pode ser utilizada em conjunto com: `optionsService` e `searchService`.
-     */
-    fieldLabel?: string;
-    /**
-     * Nome da propriedade do objeto retornado que será utilizado como valor do campo.
-     *
-     * O valor padrão é: `value`.
-     *
-     * > Esta propriedade pode ser utilizada em conjunto com: `optionsService` e `searchService`.
-     */
-    fieldValue?: string;
-    /**
-     * Informa a ordem de exibição do campo.
-     *
-     * Exemplo de utilização:
-     *
-     * ```
-     * [
-     *   { property: 'test 1', order: 2 },
-     *   { property: 'test 2', order: 1 },
-     *   { property: 'test 3' },
-     *   { property: 'test 4', order: 3 }
-     * ];
-     * ```
-     *
-     * Na exibição a ordem ficará dessa forma:
-     * ```
-     * [
-     *   { property: 'test 2', order: 1 },
-     *   { property: 'test 1', order: 2 },
-     *   { property: 'test 4', order: 3 },
-     *   { property: 'test 3' }
-     * ];
-     * ```
-     *
-     * Só serão aceitos valores com números inteiros maiores do que zero.
-     *
-     * Campos sem `order` ou com valores negativos, zerados ou inválidos
-     * serão os últimos a serem renderizados e seguirão o posicionamento dentro do
-     * array.
-     */
-    order?: number;
-    /** Mensagem que será exibida enquanto o campo não estiver preenchido. */
-    placeholder?: string;
-    /**
-     * Define a localidade a ser utilizada no componente.
-     * Por padrão o valor será configurado segundo a o módulo [`I18n`](documentation/po-i18n)
-     *
-     * Exemplo de utilização:
-     * ```
-     * [
-     *   { property: 'birthday', locale: 'en', type: 'date' },
-     *   { property: 'wage', locale: 'ru', type: 'currency' }
-     * ];
-     * ```
-     *
-     * > Para ver quais linguagens suportadas acesse [`I18n`](documentation/po-i18n)
-     * > A propriedade será repassada para os componentes que suportam a mesma.
-     */
-    locale?: string;
-    /**
-     * O controle passa a permitir a entrada de um intervalo ao invés de um único valor.
-     *
-     * > Atualmente essa propriedade está disponível apenas para o tipo 'date' e 'dateTime'.
-     */
-    range?: boolean;
-}
+import { PoComboFilter, PoLookupFilter } from '../../po-field';
+import { PoLookupColumn } from '../../po-field/po-lookup/interfaces/po-lookup-column.interface';
+import { PoMultiselectOption } from '../../po-field/po-multiselect/po-multiselect-option.interface';
+import { PoSelectOption } from '../../po-field/po-select/po-select-option.interface';
+import { PoDynamicField } from '../po-dynamic-field.interface';
+/**
+ * @usedBy PoDynamicFormComponent, PoAdvancedFilterComponent, PoPageDynamicSearchComponent
+ *
+ * @docsExtends PoDynamicField
+ *
+ * @description
+ *
+ * Interface para definição das propriedades dos campos de entrada que serão criados dinamicamente.
+ */
+export interface PoDynamicFormField extends PoDynamicField {
+    /**
+     * Define as colunas para utilização da busca avançada. Usada somente em conjunto com a propriedade `searchService`,
+     * essa propriedade deve receber um array de objetos que implementam a interface [`PoLookupColumn`](/documentation/po-lookup).
+     *
+     * > Caso sejam informadas colunas, deve-se obrigatoriamente conter colunas definidas como *label* e *value* para valores
+     * de tela e do model respectivamente.
+     */
+    columns?: Array<PoLookupColumn>;
+    /** Define a obrigatoriedade do campo. */
+    required?: boolean;
+    /**
+     * Define se a indicação de campo opcional será exibida.
+     *
+     * > A indicação não será exibida, se:
+     * - O campo for `required`, ou;
+     * - Não possuir `help` e `label`.
+     */
+    optional?: boolean;
+    /** Lista de opções que serão exibidos em um componente, podendo selecionar uma opção. */
+    options?: Array<string> | Array<PoSelectOption> | Array<PoMultiselectOption>;
+    /**
+     * Permite que o usuário faça múltipla seleção dentro da lista de opções.
+     */
+    optionsMulti?: boolean;
+    /**
+     *  Serviço que será utilizado para buscar os itens e preencher a lista de opções dinamicamente.
+     *  Pode ser informada uma URL ou uma instancia do serviço baseado em PoComboFilter.
+     *  **Importante**
+     *  > Para que funcione corretamente, é importante que o serviço siga o
+     *  [guia de API do PO UI](https://po-ui.io/guides/api).
+     */
+    optionsService?: string | PoComboFilter;
+    /**
+     * Serviço que será utilizado para realizar a busca avançada. Pode ser utilizado em conjunto com a propriedade `columns`.
+     * Pode ser ser informada uma URL ou uma instancia do serviço baseado em PoLookupFilter.
+     * **Importante:**
+     * > Caso utilizar a propriedade `optionsService` esta propriedade será ignorada.
+     * > Para que funcione corretamente, é importante que o serviço siga o
+     * [guia de API do PO UI](https://po-ui.io/guides/api).
+     */
+    searchService?: string | PoLookupFilter;
+    /** Máscara para o campo. */
+    mask?: string;
+    /** Define que o valor do componente será conforme especificado na mascára. O valor padrão é `false`. */
+    maskFormatModel?: boolean;
+    /** Define o ícone que será exibido no início do campo.
+     * > Esta propriedade o pode ser utilizado nos campos:
+     * - Input;
+     * - Number;
+     * - Decimal;
+     * - Combo;
+     *
+     * > Veja a disponibilidade de ícones em [biblioteca de ícones](guides/icons).
+     */
+    icon?: string;
+    /**  Quantidade máxima de casas decimais.
+     *
+     * > Esta propriedade só pode ser utilizada quando o `type` for *currency*.
+     */
+    decimalsLength?: number;
+    /** Quantidade máxima de dígitos antes do separador decimal. O valor máximo permitido é 13
+     *
+     * > Esta propriedade só pode ser utilizada quando o `type` for *currency*.
+     */
+    thousandMaxlength?: number;
+    /** Regex para validação do campo. */
+    pattern?: string;
+    /** Tamanho mínimo de caracteres. */
+    minLength?: number;
+    /** Tamanho máximo de caracteres. */
+    maxLength?: number;
+    /** Desabilita o campo caso informar o valor *true*. */
+    disabled?: boolean;
+    /** Texto de ajuda. */
+    help?: string;
+    /** Texto exibido quando o valor do componente for *true*. */
+    booleanTrue?: string;
+    /** Texto exibido quando o valor do componente for *false*. */
+    booleanFalse?: string;
+    /** Valor máximo a ser informado no componente, podendo ser utilizado quando o tipo de dado por *number*, *date* ou *dateTime*. */
+    maxValue?: string | number;
+    /** Valor mínimo a ser informado no componente, podendo ser utilizado quando o tipo de dado por *number*, *date* ou *dateTime*. */
+    minValue?: string | number;
+    /** Quantidade de linhas exibidas no `po-textarea`. */
+    rows?: number;
+    /** Esconde a informação estilo *password*, pode ser utilizado quando o tipo de dado for *string*. */
+    secret?: boolean;
+    /**
+     * Função ou serviço para validar as **mudanças do campo**.
+     *
+     * * A propriedade aceita os seguintes tipos:
+     * - **String**: Endpoint usado pelo componente para requisição via `POST`.
+     * - **Function**: Método que será executado.
+     *
+     * Ao ser executado, irá receber como parâmetro um objeto com o nome da propriedade
+     * alterada e o novo valor, conforme a interface `PoDynamicFormFieldChanged`:
+     *
+     * ```
+     * { property: 'property name', value: 'new value' }
+     * ```
+     *
+     * O retorno desta função deve ser do tipo [PoDynamicFormFieldValidation](documentation/po-dynamic-form#po-dynamic-form-field-validation),
+     * onde o usuário poderá determinar as novas propriedades do campo.
+     * Por exemplo:
+     *
+     * ```
+     * onChangeField(changeValue): PoDynamicFormFieldValidation {
+     *
+     * if (changeValue.property === 'birthday' && !this.validate('birthday')) {
+     *   return {
+     *     value: '',
+     *     field: { property: 'birthday', required: true },
+     *     focus: true
+     *   };
+     * }
+     * ```
+     *
+     * Para referenciar a sua função utilize a propriedade `bind`, por exemplo:
+     * ```
+     * { property: 'state', gridColumns: 6, validate: this.myFunction.bind(this) }
+     * ```
+     */
+    validate?: string | Function;
+    /**
+     * Objeto que será enviado como parâmetro nas requisições de busca usados pelos componentes `po-lookup` e
+     * `po-combo`.
+     *
+     * Por exemplo, para o parâmetro `{ age: 23 }` a URL da requisição ficaria:
+     *
+     * ```
+     * url + ?age=23&filter=Peter
+     * ```
+     */
+    params?: any;
+    /**
+     * Mensagem que será apresentada quando o campo ficar inválido.
+     *
+     * O campo fica inválido quando as seguintes propriedades não forem respeitadas:
+     *  - pattern;
+     *  - minValue;
+     *  - maxValue;
+     *
+     * > Esta mensagem não é apresentada quando o campo estiver vazio, mesmo que ele seja requerido.
+     */
+    errorMessage?: string;
+    /**
+     * Formato de exibição no campo.
+     *
+     * Ao utilizar esta propriedade com o `type` *PoDynamicFieldType.Date* ou *PoDynamicFieldType.DateTime*,
+     * pode ser utilizada para formatação de exibição da data:
+     *
+     * Valores válidos:
+     *
+     * - dd/mm/yyyy
+     * - mm/dd/yyyy
+     * - yyyy/mm/dd
+     *
+     *
+     * Também pode-se utilizar em conjunto com `searchService`, informando uma lista de propriedades que será utilizado
+     * para formatação da exibição no campo, por exemplo: ["id", "name"].
+     */
+    format?: string | Array<string>;
+    /**
+     * Nome da propriedade do objeto retornado que será utilizado como descrição do campo.
+     *
+     * O valor padrão é: `label`.
+     *
+     * > Esta propriedade pode ser utilizada em conjunto com: `optionsService` e `searchService`.
+     */
+    fieldLabel?: string;
+    /**
+     * Nome da propriedade do objeto retornado que será utilizado como valor do campo.
+     *
+     * O valor padrão é: `value`.
+     *
+     * > Esta propriedade pode ser utilizada em conjunto com: `optionsService` e `searchService`.
+     */
+    fieldValue?: string;
+    /**
+     * Informa a ordem de exibição do campo.
+     *
+     * Exemplo de utilização:
+     *
+     * ```
+     * [
+     *   { property: 'test 1', order: 2 },
+     *   { property: 'test 2', order: 1 },
+     *   { property: 'test 3' },
+     *   { property: 'test 4', order: 3 }
+     * ];
+     * ```
+     *
+     * Na exibição a ordem ficará dessa forma:
+     * ```
+     * [
+     *   { property: 'test 2', order: 1 },
+     *   { property: 'test 1', order: 2 },
+     *   { property: 'test 4', order: 3 },
+     *   { property: 'test 3' }
+     * ];
+     * ```
+     *
+     * Só serão aceitos valores com números inteiros maiores do que zero.
+     *
+     * Campos sem `order` ou com valores negativos, zerados ou inválidos
+     * serão os últimos a serem renderizados e seguirão o posicionamento dentro do
+     * array.
+     */
+    order?: number;
+    /** Mensagem que será exibida enquanto o campo não estiver preenchido. */
+    placeholder?: string;
+    /**
+     * Define a localidade a ser utilizada no componente.
+     * Por padrão o valor será configurado segundo a o módulo [`I18n`](documentation/po-i18n)
+     *
+     * Exemplo de utilização:
+     * ```
+     * [
+     *   { property: 'birthday', locale: 'en', type: 'date' },
+     *   { property: 'wage', locale: 'ru', type: 'currency' }
+     * ];
+     * ```
+     *
+     * > Para ver quais linguagens suportadas acesse [`I18n`](documentation/po-i18n)
+     * > A propriedade será repassada para os componentes que suportam a mesma.
+     */
+    locale?: string;
+    /**
+     * O controle passa a permitir a entrada de um intervalo ao invés de um único valor.
+     *
+     * > Atualmente essa propriedade está disponível apenas para o tipo 'date' e 'dateTime'.
+     */
+    range?: boolean;
+}

package/lib/components/po-dynamic/po-dynamic-form/po-dynamic-form-fields/po-dynamic-form-field-internal.interface.d.ts

@@ -1,14 +1,14 @@
-import { PoDynamicFormField } from '../po-dynamic-form-field.interface';
-/**
- * @docsPrivate
- *
- * @description
- *
- * Interface utilizada para os *fields* tratados internamente.
- */
-export interface PoDynamicFormFieldInternal extends PoDynamicFormField {
-    componentClass?: string;
-    control?: string;
-    /** Aplica foco no campo quando o componente for iniciado. */
-    focus?: boolean;
-}
+import { PoDynamicFormField } from '../po-dynamic-form-field.interface';
+/**
+ * @docsPrivate
+ *
+ * @description
+ *
+ * Interface utilizada para os *fields* tratados internamente.
+ */
+export interface PoDynamicFormFieldInternal extends PoDynamicFormField {
+    componentClass?: string;
+    control?: string;
+    /** Aplica foco no campo quando o componente for iniciado. */
+    focus?: boolean;
+}

package/lib/components/po-dynamic/po-dynamic-form/po-dynamic-form-fields/po-dynamic-form-fields-base.component.d.ts

@@ -1,44 +1,44 @@
-import { EventEmitter } from '@angular/core';
-import { TitleCasePipe } from '@angular/common';
-import { PoDynamicFormField } from '../po-dynamic-form-field.interface';
-import { PoDynamicFormFieldInternal } from './po-dynamic-form-field-internal.interface';
-export declare class PoDynamicFormFieldsBaseComponent {
-    private titleCasePipe;
-    autoFocus?: string;
-    disabledForm: boolean;
-    validate?: string | Function;
-    formValidate: EventEmitter<any>;
-    fieldsChange: EventEmitter<any>;
-    objectValue: EventEmitter<any>;
-    visibleFields: Array<PoDynamicFormFieldInternal>;
-    private _fields;
-    private _validateFields;
-    private _value?;
-    set fields(value: Array<PoDynamicFormField>);
-    get fields(): Array<PoDynamicFormField>;
-    set value(value: any);
-    get value(): any;
-    set validateFields(value: Array<string>);
-    get validateFields(): Array<string>;
-    constructor(titleCasePipe: TitleCasePipe);
-    compareTo(value: any, compareTo: any): boolean;
-    protected getVisibleFields(): any[];
-    private convertOptions;
-    private createField;
-    private existsProperty;
-    private getComponentControl;
-    private hasFocus;
-    private isCheckboxGroup;
-    private isCombo;
-    private isCurrencyType;
-    private isLookupFilter;
-    private isComboFilter;
-    private isLookup;
-    private isMultiselect;
-    private isNumberType;
-    private isPassword;
-    private isRadioGroup;
-    private isSelect;
-    private isTextarea;
-    private printError;
-}
+import { EventEmitter } from '@angular/core';
+import { TitleCasePipe } from '@angular/common';
+import { PoDynamicFormField } from '../po-dynamic-form-field.interface';
+import { PoDynamicFormFieldInternal } from './po-dynamic-form-field-internal.interface';
+export declare class PoDynamicFormFieldsBaseComponent {
+    private titleCasePipe;
+    autoFocus?: string;
+    disabledForm: boolean;
+    validate?: string | Function;
+    formValidate: EventEmitter<any>;
+    fieldsChange: EventEmitter<any>;
+    objectValue: EventEmitter<any>;
+    visibleFields: Array<PoDynamicFormFieldInternal>;
+    private _fields;
+    private _validateFields;
+    private _value?;
+    set fields(value: Array<PoDynamicFormField>);
+    get fields(): Array<PoDynamicFormField>;
+    set value(value: any);
+    get value(): any;
+    set validateFields(value: Array<string>);
+    get validateFields(): Array<string>;
+    constructor(titleCasePipe: TitleCasePipe);
+    compareTo(value: any, compareTo: any): boolean;
+    protected getVisibleFields(): any[];
+    private convertOptions;
+    private createField;
+    private existsProperty;
+    private getComponentControl;
+    private hasFocus;
+    private isCheckboxGroup;
+    private isCombo;
+    private isCurrencyType;
+    private isLookupFilter;
+    private isComboFilter;
+    private isLookup;
+    private isMultiselect;
+    private isNumberType;
+    private isPassword;
+    private isRadioGroup;
+    private isSelect;
+    private isTextarea;
+    private printError;
+}