@dxc-technology/halstack-react 4.0.0 → 6.0.0

package/select/index.d.ts

@@ -1,131 +0,0 @@
-type SVG = string | (HTMLElement & SVGElement);
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type OptionGroup = {
-  /**
-   * Label of the group to be shown in the select's listbox.
-   */
-  label: string;
-  /**
-   * List of the grouped options.
-   */
-  options: Option[];
-};
-type Option = {
-  /**
-   * Element used as the icon that will be placed before the option label. 
-   * It can be a url of an image or an inline SVG. If the url option 
-   * is the chosen one, take into account that the component's 
-   * color styling tokens will not be applied to the image.
-   */
-  icon?: SVG;
-  /**
-   * Label of the option to be shown in the select's listbox.
-   */
-  label: string;
-  /**
-   * Value of the option. It should be unique and
-   * not an empty string, which is reserved to the empty option added
-   * by optional prop.
-   */
-  value: string;
-};
-
-type Props = {
-  /**
-   * Text to be placed above the select.
-   */
-  label?: string;
-  /**
-   * Name attribute of the input element. This attribute will allow users
-   * to find the component's value during the submit event. In this event,
-   * the component's value will always be a regular string, for both single
-   * and multiple selection modes, been in the first one a single option
-   * value and in the multiple variant more than one option value,
-   * separated by commas.
-   */
-  name?: string;
-  /**
-   * Value of the select. If undefined, the component will be uncontrolled
-   * and the value will be managed internally by the component.
-   */
-  value?: string | string[];
-  /**
-   * An array of objects representing the selectable options.
-   */
-  options?: Option[] | OptionGroup[];
-  /**
-   * Helper text to be placed above the select.
-   */
-  helperText?: string;
-  /**
-   * Text to be put as placeholder of the select.
-   */
-  placeholder?: string;
-  /**
-   * If true, the component will be disabled.
-   */
-  disabled?: boolean;
-  /**
-   * If true, the select will be optional, showing '(Optional)'
-   * next to the label and adding a default first option with empty value, been
-   * the placeholder (if defined) its label. Otherwise, the field will be
-   * considered required and an error will be passed as a parameter to the
-   * OnBlur and onChange functions if an option wasn't selected.
-   */
-  optional?: boolean;
-  /**
-   * If true, enables search functionality.
-   */
-  searchable?: boolean;
-  /**
-   * If true, the select component will support multiple selected options.
-   * In that case, value will be an array of strings with each selected
-   * option value.
-   */
-  multiple?: boolean;
-  /**
-   * This function will be called when the user selects an option.
-   * An object including the current value and the error (if the value entered is not valid) 
-   * will be passed to this function. If there is no error, error will be null.
-   */
-  onChange?: (value: string | string[]) => void;
-  /**
-   * This function will be called when the select loses the focus. An
-   * object including the value (or values) and the error (if the value
-   * selected is not valid) will be passed to this function. If there is no error,
-   * error will be null.
-   */
-  onBlur?: (val: { value: string | string[]; error: string }) => void;
-  /**
-   * If it is defined, the component will change its appearance, showing
-   * the error below the select component. If it is not defined, the error
-   * messages will be managed internally, but never displayed on its own.
-   */
-  error?: string;
-  /**
-   * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
-   * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
-   */
-  margin?: Space | Margin;
-  /**
-   * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
-   */
-  size?: "small" | "medium" | "large" | "fillParent";
-  /**
-   * Value of the tabindex attribute.
-   */
-  tabIndex?: number;
-  /**
-   * Reference to the component.
-   */
-  ref?: React.RefObject<HTMLDivElement>;
-};
-
-export default function DxcSelect(props: Props): JSX.Element;

package/sidenav/index.d.ts

@@ -1,13 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  padding?: Space | Padding;
-};
-
-export default function DxcSidenav(props: Props): JSX.Element;

package/slider/index.d.ts

@@ -1,29 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  label?: string;
-  helperText?: string;
-  minValue?: number;
-  maxValue?: number;
-  step?: number;
-  value?: number;
-  showLimitsValues?: boolean;
-  showInput?: boolean;
-  name?: string;
-  onChange?: void;
-  onDragEnd?: void;
-  disabled?: boolean;
-  marks?: boolean;
-  labelFormatCallback?: void;
-  margin?: Space | Margin;
-  size?: Size;
-};
-
-export default function DxcSlider(props: Props): JSX.Element;

package/spinner/index.d.ts

@@ -1,17 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  label?: string;
-  value?: number;
-  showValue?: boolean;
-  mode?: "large" | "small" | "overlay";
-  margin?: Space | Margin;
-};
-
-export default function DxcSpinner(props: Props): JSX.Element;

package/switch/index.d.ts

@@ -1,24 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent" | "fitContent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  checked?: boolean;
-  value?: any;
-  label?: string;
-  labelPosition?: "before" | "after";
-  name?: string,
-  disabled?: boolean;
-  onChange?: void;
-  required?: boolean;
-  margin?: Space | Margin;
-  size?: Size;
-  tabIndex?: number;
-};
-
-export default function DxcSwitch(props: Props): JSX.Element;

package/table/index.d.ts

@@ -1,13 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  margin?: Space | Margin;
-};
-
-export default function DxcTable(props: Props): JSX.Element;

package/tabs/index.d.ts

@@ -1,19 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  activeTabIndex?: number;
-  tabs?: any;
-  onTabClick?: void;
-  onTabHover?: void;
-  iconPosition?: "top" | "left";
-  margin?: Space | Margin;
-  tabIndex?: number;
-};
-
-export default function DxcTabs(props: Props): JSX.Element;

package/tag/index.d.ts

@@ -1,24 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent" | "fitContent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  icon?: any;
-  iconSrc?: string;
-  label?: string;
-  linkHref?: string;
-  onClick?: void,
-  iconBgColor?: string;
-  labelPosition?: "before" | "after";
-  newWindow?: boolean;
-  margin?: Space | Margin;
-  size?: Size;
-  tabIndex?: number;
-};
-
-export default function DxcTag(props: Props): JSX.Element;

package/text-input/index.d.ts

@@ -1,135 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-type SVG = string | (HTMLElement & SVGElement);
-type Action = {
-  onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
-  icon: SVG;
-};
-
-type Props = {
-  /**
-   * Text to be placed above the input. This label will be used as the aria-label attribute of the list of suggestions.
-   */
-  label?: string;
-  /**
-   * Name attribute of the input element.
-   */
-  name?: string;
-  /**
-   * Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
-   */
-  value?: string;
-  /**
-   * Helper text to be placed above the input.
-   */
-  helperText?: string;
-  /**
-   * Text to be put as placeholder of the input.
-   */
-  placeholder?: string;
-  /**
-   * Action to be shown in the input. This is an object composed of an onClick function and an icon,
-   * being the latter either an inline svg or a URL to the image.
-   */
-  action?: Action;
-  /**
-   * If true, the input will have an action to clear the entered value.
-   */
-  clearable?: boolean;
-  /**
-   * If true, the component will be disabled.
-   */
-  disabled?: boolean;
-  /**
-   * If true, the input will be optional, showing '(Optional)'
-   * next to the label. Otherwise, the field will be considered required and an error will be
-   * passed as a parameter to the OnBlur and onChange functions when it has
-   * not been filled.
-   */
-  optional?: boolean;
-  /**
-   * Prefix to be placed before the input value.
-   */
-  prefix?: string;
-  /**
-   * Suffix to be placed after the input value.
-   */
-  suffix?: string;
-  /**
-   * This function will be called when the user types within the input
-   * element of the component. An object including the current value and
-   * the error (if the value entered is not valid) will be passed to this
-   * function. If there is no error, error will be null.
-   */
-  onChange?: (val: { value: string; error: string }) => void;
-  /**
-   * This function will be called when the input element loses the focus.
-   * An object including the input value and the error (if the value
-   * entered is not valid) will be passed to this function. If there is no error, 
-   * error will be null.
-   */
-  onBlur?: (obj: { value: string; error: string }) => void;
-  /**
-   * If it is defined, the component will change its appearance, showing
-   * the error below the input component. If it is not defined, the error
-   * messages will be managed internally, but never displayed on its own.
-   */
-  error?: string;
-  /**
-   * These are the options to be displayed as suggestions. It can be either an array or a function:
-   *    - Array:    Array of options that will be filtered by the component.
-   *    - Function: This function will be called when the user changes the value, we will send as a parameter the new value;
-   *                apart from that this function should return one promise on which we should make 'then' to get the suggestions filtered.
-   */
-  suggestions?: string[] | (() => void);
-  /**
-    * Regular expression that defines the valid format allowed by the input.
-    * This will be checked both when the input element loses the focus and
-    * while typing within it. If the string entered does not match the
-    * pattern, the onBlur and onChange functions will be called with the
-    * current value and an internal error informing that this value does not
-    * match the pattern. If the pattern is met, the error parameter of both
-    * events will be null.
-   */
-  pattern?: string;
-  /**
-    * Specifies the minimun and maximum length allowed by the input. 
-    * This will be checked both when the input element loses the
-    * focus and while typing within it. If the string entered does not
-    * comply the length, the onBlur and onChange functions will be called
-    * with the current value and an internal error informing that the value
-    * length does not comply the specified range. If a valid length is
-    * reached, the error parameter of both events will be null.
-   */
-  length?: { min?: number; max?: number };
-  /**
-   * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value.
-   * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
-   */
-  autocomplete?: string;
-  /**
-   * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
-   * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
-   */
-  margin?: Space | Margin;
-  /**
-   * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
-   */
-  size?: Size;
-  /**
-   * Value of the tabindex attribute.
-   */
-  tabIndex?: number;
-  /**
-   * Reference to the component.
-   */
-  ref?: React.RefObject<HTMLDivElement>;
-};
-
-export default function DxcTextInput(props: Props): JSX.Element;

package/textarea/index.d.ts

@@ -1,117 +0,0 @@
-type Size = "small" | "medium" | "large" | "fillParent";
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  /**
-   * Text to be placed above the textarea.
-   */
-  label?: string;
-  /**
-   * Name attribute of the textarea element.
-   */
-  name?: string;
-  /**
-   * Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
-   */
-  value?: string;
-  /**
-   * Helper text to be placed above the textarea.
-   */
-  helperText?: string;
-  /**
-   * Text to be put as placeholder of the textarea.
-   */
-  placeholder?: string;
-  /**
-   * If true, the component will be disabled.
-   */
-  disabled?: boolean;
-  /**
-   * If true, the textarea will be optional, showing '(Optional)' 
-   * next to the label. Otherwise, the field will be considered required 
-   * and an error will be passed as a parameter to the OnBlur and onChange functions 
-   * when it has not been filled.
-   */
-  optional?: boolean;
-  /**
-   * Defines the textarea's ability to resize vertically. It can be:
-   *    - 'auto': The textarea grows or shrinks automatically in order to fit the content.
-   *    - 'manual': The height of the textarea is enabled to be manually modified.
-   *    - 'none': The textarea has a fixed height and can't be modified.
-   */
-  verticalGrow?: "auto" | "manual" | "none";
-  /**
-   * Number of rows of the textarea.
-   */
-  rows?: number;
-  /**
-   * This function will be called when the user types within the textarea.
-   * An object including the current value and the error (if the value
-   * entered is not valid) will be passed to this function. 
-   * If there is no error, error will be null.
-   */
-  onChange?: (val: { value: string; error: string }) => void;
-  /**
-   * This function will be called when the textarea loses the focus. An
-   * object including the textarea value and the error (if the value entered
-   * is not valid) will be passed to this function. If there is no error, 
-   * error will be null.
-   */
-  onBlur?: (val: { value: string; error: string }) => void;
-  /**
-   * If it is defined, the component will change its appearance, showing
-   * the error below the textarea. If it is not defined, the error
-   * messages will be managed internally, but never displayed on its own.
-   */
-  error?: string;
-  /**
-   * Regular expression that defines the valid format allowed by the
-   * textarea. This will be checked both when the textarea loses the focus
-   * and while typing within it. If the string entered does not match the
-   * pattern, the onBlur and onChange functions will be called with the
-   * current value and an internal error informing that this value does not
-   * match the pattern. If the pattern is met, the error parameter of both
-   * events will be null.
-   */
-  pattern?: string;
-  /**
-   * Specifies the minimun and maximum length allowed by the textarea.
-   * This will be checked both when the textarea loses the
-   * focus and while typing within it. If the string entered does not
-   * comply the length, the onBlur and onChange functions will be called
-   * with the current value and an internal error informing that the value
-   * length does not comply the specified range. If a valid length is
-   * reached, the error parameter of both events will be null.
-   */
-  length?: { min: number; max: number };
-  /**
-   * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
-   * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
-   */
-  autocomplete?: string;
-  /**
-   * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
-   * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
-   */
-  margin?: Space | Margin;
-  /**
-   * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
-   */
-  size?: Size;
-  /**
-   * Value of the tabindex attribute.
-   */
-  tabIndex?: number;
-  /**
-   * Reference to the component.
-   */
-  ref?: React.RefObject<HTMLDivElement>;
-};
-
-export default function DxcTextarea(props: Props): JSX.Element;