@widergy/energy-ui 3.172.1 → 3.172.3

package/dist/components/UTPanel/versions/V1/README.md

@@ -1,60 +0,0 @@
-# UTPanel
-
-Component used for displaying a side panel.
-
-## Props
-
-| Name                        | Type    | Default  | Description                                                                                                                                                                                                    |
-| :-------------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| children                    | node    |          | Component content                                                                                                                                                                                              |
-| classes                     | object  |          | Classes returned by UTPanel own[theme](./theme.js#L40) `retrieveStyle` and classes received from props.                                                                                                        |
-| classNames                  | object  |          | Overrides the default panel theme. headerMainActionButton                                                                                                                                                      |
-| collapsableHeader           | bool    | false    | Indicates if "header items" section is collapsible.                                                                                                                                                            |
-| currentStep                 | number  | 1        | Workflow step number used to show the current progress in the UTProgressBar                                                                                                                                    |
-| disableScrollbar            | bool    | false    | Render the children without scrollbar                                                                                                                                                                          |
-| HeaderComponent             | node    |          | Custom header to render.                                                                                                                                                                                       |
-| headerItems                 | array   |          | Array of items (object) to show in "header items" section. Each item should have: "title" - String, "icon" - String, "value" - String                                                                          |
-| headerMainActionButton      | object  |          | Object with header main button details: "colorTheme" - string - deafult: 'primary' // "variant" - string - default: 'semitransparent'<br />// This prop will be spread so that it supports any UTButton props. |
-| headerSecondaryActionButton | object  |          | Object with header secondary button details: "colorTheme" - string - default: "success" // "variant" - string - default: "filled" // This prop will be spread so that it supports any UTButton props.          |
-| hideCloseButton             | bool    | false    | Indicates whether the close button is hide or not                                                                                                                                                              |
-| hideHeader                  | bool    | false    | Indicates whether the entire header is hide or not                                                                                                                                                             |
-| hideMainButton              | bool    | false    | Indicates whether the main (bottom) button is hide or not                                                                                                                                                      |
-| isWorkflow                  | bool    | false    | Indicates if the panel children's content a workflow. This prop activates the progress bar.                                                                                                                    |
-| mainButton                  | object  |          | [UTButton props](https://github.com/widergy/Energy-UI/tree/master/src/lib/components/UTButton)                                                                                                                 |
-| modalProps                  | object  |          | Material UI[modal props](https://v4.mui.com/api/modal/)                                                                                                                                                        |
-| onClose                     | func    |          | Callback to execute when closing panel.                                                                                                                                                                        |
-| onEndReachedCallback        | func    |          | Callback to execute when reaching the end of the vertical scroll                                                                                                                                               |
-| onGoBack                    | func    | () => {} | Callback to execute when goBackButton is used                                                                                                                                                                  |
-| onOpen                      | func    | () => {} | Callback to execute when opening panel.                                                                                                                                                                        |
-| open                        | bool    |          | Indicates whether the panel is open or not                                                                                                                                                                     |
-| panelSide                   | string  |          | Indicates panel side.                                                                                                                                                                                          |
-| perfectScrollbarOptions     | object  |          | [Perfect scrollbar](https://www.npmjs.com/package/react-perfect-scrollbar) props                                                                                                                               |
-| singleHeaderItemsColumn     | bool    | false    | Indicates whether the header items are shown in a single column or not                                                                                                                                         |
-| size                        | string  | 'M'      | Indicates the size of panel. Currently we have two options:<br /> L -> 800px<br /> M -> 450px                                                                                                                  |
-| stepsCount                  | Number  |          | Indicates the total steps in case of workflow                                                                                                                                                                  |
-| subtitle                    | string  |          | Subtitle to show                                                                                                                                                                                               |
-| title                       | string  |          | Title to show                                                                                                                                                                                                  |
-| titleProps                  | object  | {}       | UTLabel props for title. Default props: variant="title2" weight="medium"                                                                                                                                       |
-| collapsablePanel            | bool    | false    | Indicates if panel can be collapsed when inline mode is enabled                                                                                                                                                |
-| inline                      | bool    | false    | Indicates if panel should be rendered inline instead of as a modal                                                                                                                                             |
-| paginationProps             | object  | {}       | Object containing pagination configuration: nextButton (UTButton props), backButton (UTButton props), currentPage (number), totalPages (number)                                                                |
-| showMainStatus              | bool    | false    | Shows a status indicator next to the title                                                                                                                                                                     |
-| showPagination              | bool    | false    | Shows pagination controls in the header                                                                                                                                                                        |
-| statusProps                 | object  | {}       | Props passed to UTStatus component when showMainStatus is true                                                                                                                                                 |
-| showBackButton              | boolean | false    | Shows a go back arrow button                                                                                                                                                                                   |
-| showTag                     | bool    | false    | Shows a tag indicator in the header area. When true, the tagProps object is passed to the UTStatus component to render a tag.                                                                                  |
-| tagProps                    | object  | {}       | Object containing props for the UTStatus component used as a tag in the header. Supports all [UTStatus props](https://github.com/widergy/Energy-UI/tree/master/src/lib/components/UTStatus)                    |
-| additionalContent           | array   |          | Array of sidebar items rendered in a collapsible side panel. See structure below.                                                                                                                             |
-
-### `additionalContent` item structure
-
-Each object in the array can contain:
-
-| Field           | Type          | Required | Description                                                                                      |
-| :-------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------ |
-| `id`            | `string`      | ✅        | Unique identifier for the item. Used as the active key and as part of the sidebar button testId. |
-| `Icon`          | `string`      | ✅        | Tabler icon name for the sidebar button (e.g. `'IconSettings'`).                                 |
-| `BodyComponent` | `elementType` | ✅        | React component rendered in the expanded content area when this item is active.                  |
-| `tooltipProps`  | `object`      | ✅        | Props passed to the `UTTooltip` wrapping the sidebar button. Must include `content`.             |
-| `count`         | `number`      | —        | When greater than 0, shows a numeric badge over the sidebar icon.                                |
-| `disabled`      | `bool`        | —        | When `true`, the sidebar button is disabled and the item cannot be selected.                     |

package/dist/components/UTPasswordField/versions/V0/README.md

@@ -1,19 +0,0 @@
-# UTPasswordField
-
-### Description
-Component that abstracts all possible uses for a password field. Based on the `UTTextField` component.
-
-### Usage
-This component shares all `UTTextField` props. The following props are specific to the `UTPasswordField` component:
-
-- `field`: expects an `object` with the field configuration. This prop is passed down to the text field, but the password component extracts
-  - `passwordValidations`: expects an `array` of `objects` with attributes `error: string, expression: string, requirement: string`. The `expression` attribute consists of a regular expression used to check for both an error or password requirement. The error and requirement attributes are messages to be displayed whenever it is needed. Validations are checked in real time, whereas errors show up after a submission failure.
-  - `showValidations`: expects a `boolean`. Flag to show or hide the validations based on the location of the password field. e.g: one would not want to show requirements on a sign in view, would want to in a sign up screen.
-- ValidationPassedIcon: expects an `element`, icon used to indicate when a validation has passed.
-- ValidationFailedIcon: expects an `element`, icon used to indicate when a validation has failed.
-- NoValueIcon: expects an `element`, icon used to indicate when the input has no value and has not failed to submit.
-- ErrorIcon: expects an `element`, icon used to indicate when an error is present.
-
-### Observations
-
-The `passwordValidations` object should be the same one used to set the validations in the field configuration for better understanding between visuals and functionality.

package/dist/components/UTPasswordField/versions/V1/README.md

@@ -1,23 +0,0 @@
-# UTPasswordField
-
-## Description
-
-`UTPasswordField` is a component that provides a password input field with an optional toggle to show or hide the password. It builds on the `UTTextInput` component and adds functionality specific to password inputs.
-
-## Props
-
-`UTPasswordField` inherits all the props from `UTTextInput` and adds custom behavior for handling password visibility.
-
-| Name | Type | Default | Description                            |
-| ---- | ---- | ------- | -------------------------------------- |
-| ...  | ...  | ...     | Inherits all props from `UTTextInput`. |
-
-## Usage
-
-```javascript
-<UTPasswordField placeholder="Enter your password" />
-```
-
-## Notes
-
-For more detailed information on inherited props, refer to the documentation for `UTTextInput`.

package/dist/components/UTPhoneInput/versions/V1/README.md

@@ -1,89 +0,0 @@
-# UTPhoneInput
-
-## Description
-
-`UTPhoneInput` is a configurable phone input component that allows users to input phone numbers, optionally including an area code or country code. It supports various customization options such as icons, validation messages, and configurable error handling. The component also handles validation for specific area codes and can work with or without them. The component now supports both string and object value formats for enhanced flexibility.
-
-## Props
-
-| Name                  | Type                                                                      | Default                                                                                                    | Description                                                                                                                          |
-| --------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| actions               | object                                                                    |                                                                                                            | Actions to render within `UTFieldLabel`.                                                                                             |
-| areaCodeDataTestId    | string                                                                    |                                                                                                            | Identifier for the area code input field, useful for testing.                                                                        |
-| areaCodePlaceholder   | string                                                                    |                                                                                                            | Placeholder for the area code input field.                                                                                           |
-| prefix                | string                                                                    |                                                                                                            | Country code prefix for the phone number (e.g., "+54" for Argentina). When provided, enables country code selection functionality.    |
-| prefixDataTestId      | string                                                                    |                                                                                                            | Identifier for the country code select field, useful for testing.                                                                    |
-| disabled              | bool                                                                      | false                                                                                                      | Disables both the area code and phone number input fields.                                                                           |
-| error                 | string                                                                    |                                                                                                            | Error message displayed below the input fields.                                                                                      |
-| inputSize             | string                                                                    |                                                                                                            | Size of the input field. One of: `small`, `large`.                                                                                   |
-| helpText              | string                                                                    |                                                                                                            | Help text displayed below the input fields.                                                                                          |
-| maxLength             | number                                                                    | 10                                                                                                         | Maximum number of characters allowed in the phone number input (excluding the area code).                                            |
-| onChange              | func                                                                      |                                                                                                            | Function called when either the area code or phone number value changes. Returns string format (`areaCode-phoneNumber`) or object format (`{number, prefix}`) when `prefix` is provided. |
-| phoneNumberDataTestId | string                                                                    |                                                                                                            | Identifier for the phone number input field, useful for testing.                                                                     |
-| placeholder           | string                                                                    |                                                                                                            | Placeholder text displayed in the phone number input when it's empty.                                                                |
-| readOnly              | bool                                                                      | false                                                                                                      | Makes the area code and phone number input fields read-only.                                                                         |
-| required              | bool                                                                      | false                                                                                                      | Marks the input fields as required.                                                                                                  |
-| RightIcon             | elementType                                                               |                                                                                                            | Icon displayed on the right side of both the area code and phone number input fields.                                                |
-| title                 | string                                                                    |                                                                                                            | Title displayed above the input fields.                                                                                              |
-| titleVariant          | string                                                                    | 'large'                                                                                                    | Variant of the title, can be `small` or `large`.                                                                                     |
-| translations          | shape({ areaCodeWithoutZeroError: string, invalidAreaCodeError: string, areaCodeMinLenghtError: string }) | `{ areaCodeMinLenghtError: 'El código de área debe contener al menos 2 dígitos.', areaCodeWithoutZeroError: 'El código de área debe comenzar sin 0.', invalidAreaCodeError: 'No pudimos reconocer el código de área ingresado. Intenta con uno diferente.' }` | Translation strings used for error messages related to area code validation.                                                         |
-| validationDataTestId  | string                                                                    |                                                                                                            | Identifier for the validation component, useful for testing.                                                                         |
-| validations           | object                                                                    |                                                                                                            | Object containing validation rules to be applied to the input fields.                                                                |
-| value                 | string \| object                                                          |                                                                                                            | Current value of the phone input. Can be a string in format `areaCode-phoneNumber` or an object `{number, prefix}` when `prefix` is provided. |
-| withAreaCode          | bool                                                                      | true                                                                                                       | If `true`, displays the area code input field. If `false`, only the phone number input is shown.                                     |
-| editablePrefix        | bool                                                                      | false                                                                                                      | If `true`, allows users to edit the country code prefix. When `false`, the prefix is read-only. Only applies when `prefix` is provided. |
-
-### Value Formats
-
-The component supports two value formats depending on the configuration:
-
-#### String Format (Default)
-When `prefix` is not provided, the component uses string format:
-- **Input**: `"11-82712232"` (area code + phone number)
-- **Output**: `"11-82712232"` via `onChange`
-
-#### Object Format (prefix provided)
-When `prefix` is provided, the component uses object format:
-- **Input**: `{number: "1182712232", prefix: "+54"}`
-- **Output**: `{number: "1182712232", prefix: "+54"}` via `onChange`
-
-### Translations
-
-The `translations` prop allows you to customize the error messages displayed when the area code is invalid. It supports the following keys:
-
-- **areaCodeMinLenghtError**: Error message displayed when the area code has less than 2 digits.
-- **areaCodeWithoutZeroError**: Error message displayed when the area code starts with a `0`.
-- **invalidAreaCodeError**: Error message displayed when the area code is invalid.
-
-### titleVariant
-
-The value of `titleVariant` must be one of the following:
-
-- "small"
-- "large"
-
-### Handling Errors
-
-Errors related to the area code or phone number input can be displayed using the `error` prop or through the `validations` prop, which allows more complex validation rules. The component also provides built-in area code validation, which can be customized through the `translations` prop.
-
-### Validations
-
-The `validations` prop allows you to pass an object with validation rules to be applied to both the area code and phone number inputs. For more information on the structure of `validations`, refer to the **UTValidation** component documentation.
-
-### Country Code Selection
-
-When `prefix` is provided, the component displays a country selector with:
-- Country flags using the `react-flagpack` library
-- Phone prefixes for each country
-- Automatic country code detection based on the current value
-- Support for 195 countries with 2 digit ISO code
-- Editable prefix selection when `editablePrefix` is `true`
-
-### Combining the Area Code and Phone Number
-
-The `withAreaCode` prop should not be `true` when `prefix` is provided. When the `onChange` handler is called, it returns the value in the appropriate format:
-
-- **String format**: `areaCode-phoneNumber` (e.g., "11-82712232")
-- **Object format**: `{number: "1182712232", prefix: "+54"}` when `prefix` is provided
-
-If the `withAreaCode` prop is set to `false`, only the phone number will be returned in the appropriate format.

package/dist/components/UTPopUp/README.md

@@ -1,50 +0,0 @@
-# UTPopUp
-
-## Description
-
-`UTPopUp` is a configurable floating component with actions.
-
-## Props
-
-| Name                   | Type      | Default            | Description                                                                                             |
-| ---------------------- | --------- | ------------------ | ------------------------------------------------------------------------------------------------------- |
-| `checkBox`             | string    |                    | Title for the checkbox input.                                                                           |
-| `children`             | element   |                    | The content to be rendered inside the component.                                                        |
-| `dataTestId`           | string    |                    | Unique identifier for testing purposes.                                                                 |
-| `enabled`              | bool      | `true`             | Indicates whether the component is enabled or not.                                                      |
-| `onClose`              | func      |                    | Callback for the close button.                                                                          |
-| `position`             | string    | `bottomRight`      | Defines the position of the component.                                                                  |
-| `primaryAction`        | func      |                    | Callback function for the primary action.                                                               |
-| `primaryActionProps`   | object    |                    | Props to be applied to the primary action button.                                                       |
-| `primaryActionText`    | string    |                    | Text for the primary action button.                                                                     |
-| `progress`             | number    |                    | Width of the progress bar                                                                               |
-| `secondaryAction`      | func      |                    | Callback function for the secondary action .                                                            |
-| `secondaryActionProps` | object    |                    | Props to be applied to the secondary action button.                                                     |
-| `secondaryActionText`  | string    |                    | Text for the secondary action button.                                                                   |
-| `size`                 | string    | `medium`           | Defines the size of the component.                                                                      |
-| `withBodyPadding`      | bool      | `false`            | Indicates whether the body of the component should have horizontal padding around its content.          |
-
-
-### checkBox
-
-`checkBox` is the title and enabler for the UTCheckBox. Its value is passed as a parameter to `onClose`, `primaryAction`, and `secondaryAction`
-
-### progress
-
-Enables the progress bar. The value of `progress` must be between 0 and 1.
-
-### position 
-
-The value of `position` must be one of the following:
-
-- "bottomLeft"
-- "bottomRight"
-- "topLeft"
-- "topRight"
-
-### size
-
-The value of `size` must be one of the following:
-
-- "medium"
-- "large"

package/dist/components/UTPopper/README.md

@@ -1,17 +0,0 @@
-# UTPopper
-
-## Description
-
-Component meant to be used as a PopUp anchored to other elements
-
-## Props
-
-| Name                    | Type                               | Default | Description                                       |
-| ----------------------- | ---------------------------------- | ------- | ------------------------------------------------- |
-| anchor                  | oneOfType([refType, elementType]), |         | Element to which the popper is anchored           |
-| children,               | object                             |         | Elements to render within the popper              |
-| classes,                | objectOf( string)                  |         | CSS classes                                       |
-| clickAwayListenerProps, | object                             |         | Props handed over to ClickawayListener            |
-| onClose,                | func                               |         | Close function                                    |
-| paperProps,             | object                             |         | Props to hand over to the UTPapper                |
-| ...popperProps          | object                             |         | Spread of props compatible with materialUIs props |

package/dist/components/UTProductItem/README.md

@@ -1,28 +0,0 @@
-# UTProductItem
-
-### Description
-Product item component.
-
-### Action
-This action object will wait for a function and a type to apply a determinate style to the action button:
-Available types:
-- `add`
-- `modify`
-- `detail`
-- `modifyDetail`
-
-Also, you can pass a CustomIcon if you want to.
-
-### Props
-
-| Name                 | Type                                                                                                            | Default   |Description                      |
-|----------------------|-----------------------------------------------------------------------------------------------------------------|-----------|---------------------------------|
-| action               | object: {CustomIcon: ReactComponent, type: 'add' \| 'modify' \| 'detail' \| 'modifyDetail', onClick: () => () } |           | The action definition.          |
-| additionalInfo       | string                                                                                                          |           | The additional info to detail.  |
-| amount               |                                                                                                                 |           | The current amount.             |
-| discount             | number                                                                                                          |           | Current discount.               |
-| discountSize         | 'small' \| 'medium'                                                                                             | medium    | UTLabel component variant.      | 
-| Image                | asset                                                                                                           |           | Image of the product.           |
-| previousAmount       | number                                                                                                          |           | Amount without discount applied.|
-| selectedQuantity     | number                                                                                                          |           | Selected item product quantity. |
-| title                | string                                                                                                          |           | Product name.                   |