@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6

package/classes/ElementIDUtils.md

@@ -1,86 +1,75 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ElementIDUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ElementIDUtils
 
 # Class: ElementIDUtils
 
 `ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id. 
 A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
 
-## Table of contents
-
-### Constructors
-
-- [constructor](ElementIDUtils.md#constructor)
-
-### Properties
-
-- [DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME](ElementIDUtils.md#data_element_id_attribute_name)
-- [INTERNAL\_INPUT\_NAME](ElementIDUtils.md#internal_input_name)
-- [REGEX\_DATAUNIT\_NAME](ElementIDUtils.md#regex_dataunit_name)
-
-### Methods
+## Constructors
 
-- [addIDInfo](ElementIDUtils.md#addidinfo)
-- [addIDInfoIfNotExists](ElementIDUtils.md#addidinfoifnotexists)
-- [addPrefix](ElementIDUtils.md#addprefix)
-- [addSuffix](ElementIDUtils.md#addsuffix)
-- [formatDescription](ElementIDUtils.md#formatdescription)
-- [getAttributeValid](ElementIDUtils.md#getattributevalid)
-- [getDataElementID](ElementIDUtils.md#getdataelementid)
-- [getDataElementIDAttribute](ElementIDUtils.md#getdataelementidattribute)
-- [getInternalIDInfo](ElementIDUtils.md#getinternalidinfo)
-- [parseDataUnitName](ElementIDUtils.md#parsedataunitname)
+### new ElementIDUtils()
 
-## Constructors
+> **new ElementIDUtils**(): [`ElementIDUtils`](ElementIDUtils.md)
 
-### constructor
+#### Returns
 
-• **new ElementIDUtils**()
+[`ElementIDUtils`](ElementIDUtils.md)
 
 ## Properties
 
 ### DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME
 
-▪ `Static` **DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME**: `string` = `"data-element-id"`
+> `static` **DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME**: `string` = `"data-element-id"`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:14
 
-___
+***
 
 ### INTERNAL\_INPUT\_NAME
 
-▪ `Static` **INTERNAL\_INPUT\_NAME**: `string` = `"embedded"`
+> `static` **INTERNAL\_INPUT\_NAME**: `string` = `"embedded"`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:15
 
-___
+***
 
 ### REGEX\_DATAUNIT\_NAME
 
-▪ `Static` `Private` **REGEX\_DATAUNIT\_NAME**: `RegExp`
+> `static` `private` **REGEX\_DATAUNIT\_NAME**: `RegExp`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:16
 
 ## Methods
 
-### addIDInfo
+### addIDInfo()
 
-▸ `Static` **addIDInfo**(`element`, `suffix?`, `iDInfo?`): `string`
+> `static` **addIDInfo**(`element`, `suffix`?, `iDInfo`?): `string`
 
 Cria e adiciona a propriedade `data-element-id` em um elemento.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
-| `suffix?` | `string` | Sufixo/Texto para ser adicionado. |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
+• **element**: `HTMLElement`
+
+Elemento HTML a ser modificado (HTMLElement).
+
+• **suffix?**: `string`
+
+Sufixo/Texto para ser adicionado.
+
+• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
+
+ID para ser adicionado.
 
 #### Returns
 
@@ -88,46 +77,49 @@ Cria e adiciona a propriedade `data-element-id` em um elemento.
 
 - O data-element-id gerado.
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:26
 
-___
+***
 
-### addIDInfoIfNotExists
+### addIDInfoIfNotExists()
 
-▸ `Static` **addIDInfoIfNotExists**(`element`, `suffix?`, `iDInfo?`): `string`
+> `static` **addIDInfoIfNotExists**(`element`, `suffix`?, `iDInfo`?): `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
+• **element**: `HTMLElement`
+
+• **suffix?**: `string`
+
+• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
 
 #### Returns
 
 `string`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:39
 
-___
+***
 
-### addPrefix
+### addPrefix()
 
-▸ `Static` `Private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
+> `static` `private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
 
 Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `iDInfo` | `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado ao `data-element-id`. |
-| `dataElementID` | `string` | Sufixo/Texto para ser adicionado ao `data-element-id`. |
+• **iDInfo**: `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
+
+ID para ser adicionado ao `data-element-id`.
+
+• **dataElementID**: `string`
+
+Sufixo/Texto para ser adicionado ao `data-element-id`.
 
 #### Returns
 
@@ -135,32 +127,31 @@ Adiciona a propriedade name do DataUnit como prefixo do data-element-id do eleme
 
 - String contendo informação para ser usada no `data-element-id` do elemento.
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:147
 
-___
+***
 
-### addSuffix
+### addSuffix()
 
-▸ `Static` `Private` **addSuffix**(`dataElementID`, `suffix`, `element`): `string`
+> `static` `private` **addSuffix**(`dataElementID`, `suffix`, `element`): `string`
 
 Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para montar a hierarquia dos ids dos componentes em tela.
 
-**`Example`**
+#### Parameters
 
-```ts
-Um ez-combo-box tem data-element-id = codparc_input_embedded_combo.
-Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
-```
+• **dataElementID**: `null` \| `string`
 
-#### Parameters
+ID para ser adicionado ao `data-element-id`.
+
+• **suffix**: `undefined` \| `string`
+
+Sufixo/Texto para ser adicionado ao `data-element-id`.
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `dataElementID` | ``null`` \| `string` | ID para ser adicionado ao `data-element-id`. |
-| `suffix` | `undefined` \| `string` | Sufixo/Texto para ser adicionado ao `data-element-id`. |
-| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
+• **element**: `HTMLElement`
+
+Elemento HTML a ser modificado (HTMLElement).
 
 #### Returns
 
@@ -168,23 +159,30 @@ Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como
 
 - `data-element-id` com sufixo.
 
-#### Defined in
+#### Example
+
+```ts
+Um ez-combo-box tem data-element-id = codparc_input_embedded_combo.
+Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
+```
+
+#### Source
 
 src/utils/ElementIDUtils.ts:130
 
-___
+***
 
-### formatDescription
+### formatDescription()
 
-▸ `Static` `Private` **formatDescription**(`value`): `string`
+> `static` `private` **formatDescription**(`value`): `string`
 
 Remove caracteres especiais.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | ``null`` \| `string` | Texto que terá os caracteres especiais removidos. |
+• **value**: `null` \| `string`
+
+Texto que terá os caracteres especiais removidos.
 
 #### Returns
 
@@ -192,50 +190,59 @@ Remove caracteres especiais.
 
 - Retorna a string sem caracteres especiais e em camelCase.
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:162
 
-___
+***
 
-### getAttributeValid
+### getAttributeValid()
 
-▸ `Static` `Private` **getAttributeValid**(`element`, `iDInfo?`): ``null`` \| `string`
+> `static` `private` **getAttributeValid**(`element`, `iDInfo`?): `null` \| `string`
 
 Obtém ID válido para o elemento.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
+• **element**: `HTMLElement`
+
+Elemento HTML a ser modificado (HTMLElement).
+
+• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
+
+ID para ser adicionado.
 
 #### Returns
 
-``null`` \| `string`
+`null` \| `string`
 
 - ID para ser adicionado ao elemento conforme ordem de prioridade.
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:90
 
-___
+***
 
-### getDataElementID
+### getDataElementID()
 
-▸ `Static` `Private` **getDataElementID**(`element`, `suffix?`, `iDInfo?`): `string`
+> `static` `private` **getDataElementID**(`element`, `suffix`?, `iDInfo`?): `string`
 
 Obtém o `data-element-id` do elemento com adição do sufixo e ID.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
-| `suffix?` | `string` | Sufixo/Texto para ser adicionado. |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
+• **element**: `HTMLElement`
+
+Elemento HTML a ser modificado (HTMLElement).
+
+• **suffix?**: `string`
+
+Sufixo/Texto para ser adicionado.
+
+• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
+
+ID para ser adicionado.
 
 #### Returns
 
@@ -243,66 +250,60 @@ Obtém o `data-element-id` do elemento com adição do sufixo e ID.
 
 - Atributo `data-element-id` do elemento modificado com sufixo e/ou ID.
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:66
 
-___
+***
 
-### getDataElementIDAttribute
+### getDataElementIDAttribute()
 
-▸ `Static` `Private` **getDataElementIDAttribute**(`element`): ``null`` \| `string`
+> `static` `private` **getDataElementIDAttribute**(`element`): `null` \| `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
+• **element**: `HTMLElement`
 
 #### Returns
 
-``null`` \| `string`
+`null` \| `string`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:168
 
-___
+***
 
-### getInternalIDInfo
+### getInternalIDInfo()
 
-▸ `Static` **getInternalIDInfo**(`sufix`): `string`
+> `static` **getInternalIDInfo**(`sufix`): `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `sufix` | `string` |
+• **sufix**: `string`
 
 #### Returns
 
 `string`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:54
 
-___
+***
 
-### parseDataUnitName
+### parseDataUnitName()
 
-▸ `Static` `Private` **parseDataUnitName**(`uri`): `string`
+> `static` `private` **parseDataUnitName**(`uri`): `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `uri` | `string` |
+• **uri**: `string`
 
 #### Returns
 
 `string`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:175