@dxc-technology/halstack-react 0.0.0-4d89cae → 0.0.0-4e5859a

package/wizard/types.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.SVGProps<SVGSVGElement> | React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+declare type Step = {
+    /**
+     * Step label.
+     */
+    label: string;
+    /**
+     * Description that will be placed next to the step.
+     */
+    description?: string;
+    /**
+     * Element or path used as the icon displayed in the step.
+     */
+    icon?: string | SVG;
+    /**
+     * Whether the step is disabled or not.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the step is valid or not.
+     */
+    valid?: boolean;
+};
+declare type Props = {
+    /**
+     * The wizard can be showed in horizontal or vertical.
+     */
+    mode?: "horizontal" | "vertical";
+    /**
+     * Defines which step is marked as the current. The numeration starts in 0.
+     */
+    currentStep?: number;
+    /**
+     * This function will be called when the user clicks a step. The step
+     * number will be passed as a parameter.
+     */
+    onStepClick?: (newCurrentStep: number) => void;
+    /**
+     * An array of objects representing the steps.
+     */
+    steps: Step[];
+    /**
+     * 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;
+    /**
+     * Value of the tabindex attribute that is given to all the steps.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/wizard/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/accordion/index.d.ts

@@ -1,28 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-type Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  label?: string;
-  iconSrc?: string;
-  icon?: any;
-  assistiveText?: string;
-  disabled?: boolean;
-  onChange?: void;
-  isExpanded?: boolean;
-  margin?: Space | Margin;
-  padding?: Space | Padding;
-  tabIndex?: number;
-};
-
-export default function DxcAccordion(props: Props): JSX.Element;

package/accordion-group/index.d.ts

@@ -1,16 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  disabled?: boolean;
-  onActiveChange?: void;
-  indexActive?: number;
-  margin?: Space | Margin;
-};
-
-export default function DxcAccordionGroup(props: Props): JSX.Element;

package/alert/index.d.ts

@@ -1,51 +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 = {
-  /**
-   * Uses on of the available alert types.
-   */
-  type?: "info" | "confirm" | "warning" | "error";
-  /**
-   * Uses on of the available alert modes:
-   *    'inline': If onClose function is received, close button will be visible and the function will be executed when it's clicked. 
-   *              There is no overlay layer. Position should be decided by the user.
-   *    'modal':  The alert will be displayed in the middle of the screen with an overlay layer behind. 
-   *              The onClose function will be executed when the X button or the overlay is clicked. d
-   *              The user has the responsibility of hidding the modal in the onClose function, otherwise the modal will remain visible.
-   */
-  mode?: "inline" | "modal";
-  /**
-   * Text to display after icon and alert type and before content.
-   */
-  inlineText?: string;
-  /**
-   * This function will be called when the user clicks the close button. If there is no function we should close the alert by default.
-   */
-  onClose?: () => void;
-  /**
-   * The details section of the alert. Can be used to render custom content in this area.
-   */
-  children?: React.ReactNode;
-  /**
-   * 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' | 'fitContent').
-   */
-  size?: Size;
-  /**
-   * Tabindex value given to the close button.
-   */
-  tabIndex?: number;
-};
-
-export default function Alert(props: Props): JSX.Element;

package/box/index.d.ts

@@ -1,25 +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 Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-
-type Props = {
-  shadowDepth?: 0 | 1 | 2;
-  margin?: Space | Margin;
-  padging?: Space | Padding;
-  display: string;
-  size: Size;
-};
-
-export default function DxcBox(props: Props): JSX.Element;

package/button/Button.stories.js

@@ -1,27 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Primary = exports["default"] = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Button = _interopRequireDefault(require("./Button"));
-
-var _default = {
-  title: "Button",
-  component: _Button["default"]
-};
-exports["default"] = _default;
-
-var Primary = function Primary() {
-  return _react["default"].createElement(_Button["default"], {
-    mode: "primary",
-    label: "Primary Button"
-  });
-};
-
-exports.Primary = Primary;

package/button/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 = {
-  label?: string;
-  mode?: "primary" | "secondary" | "text";
-  disabled?: boolean;
-  iconPosition?: "before" | "after";
-  type?: "button" | "reset" | "submit";
-  iconSrc?: string;
-  icon?: any;
-  onClick?: void;
-  margin?: Space | Margin;
-  size?: Size;
-  tabIndex?: number;
-};
-
-export default function DxcButton(props: Props): JSX.Element;

package/card/index.d.ts

@@ -1,22 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  imageSrc?: string;
-  margin?: Space | Margin;
-  contentPadding?: any;
-  linkHref?: string;
-  onClick?: void;
-  imageBgColor?: string;
-  imagePadding?: any;
-  imagePosition?: "before" | "after";
-  outlined?: boolean; 
-  imageCover?: boolean;
-};
-
-export default function DxcCard(props: Props): JSX.Element;

package/checkbox/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 DxcCheckbox(props: Props): JSX.Element;

package/chip/index.d.ts

@@ -1,22 +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;
-  suffixIcon?: any;
-  preffixIcon?: any;
-  suffixIconSrc?: string;
-  onClickSuffix?: void;
-  prefixIconSrc?: string;
-  onClickPrefix?: void;
-  disabled?: boolean;
-  margin?: Space | Margin;
-  tabIndex?: number;
-};
-
-export default function DxcChip(props: Props): JSX.Element;

package/date-input/index.d.ts

@@ -1,95 +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 date.
-   */
-  label?: string;
-  /**
-   * Name attribute of the input element.
-   */
-  name?: string;
-  /**
-   * Value of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
-   */
-  value?: string;
-  /**
-   * The format in which the date value will be displayed. User must use this format when editing the value or it will be considered as an invalid date.
-   */
-  format?: string;
-  /**
-   * Helper text to be placed above the date.
-   */
-  helperText?: string;
-  /**
-   * If true, the date format will appear as placeholder in the field.
-   */
-  placeholder?: boolean;
-  /**
-   * If true, the date input will have an action to clear the entered value.
-   */
-  clearable?: boolean;
-  /**
-   * If true, the component will be disabled.
-   */
-  disabled?: boolean;
-  /**
-   * If true, the date 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;
-  /**          
-   * This function will be called when the user types within the input
-   * element of the component. An object including the string value, the
-   * error and the date value will be passed to this function.
-   * If the string value is a valid date, error will
-   * be null. Also, if the string value is not a valid date, date will be null.
-   */
-  onChange?: (val: { value: string; error: string; date: Date }) => void;
-  /**          
-   * This function will be called when the input element loses the focus.
-   * An object including the string value, the error and the date value
-   * will be passed to this function. If the string value is a valid date, error will
-   * be null. Also, if the string value is not a valid date, date will be null.
-   */
-  onBlur?: (val: { value: string; error: string; date: Date }) => void;
-  /**
-   * If it is defined, the component will change its appearance, showing
-   * the error below the date input component. If it is not defined, the error
-   * messages will be managed internally, but never displayed on its own.
-   */
-  error?: string;
-  /**
-   * 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 ('medium' | 'large' | 'fillParent').
-   */
-  size?: Size;
-  /**
-   * Value of the tabindex attribute.
-   */
-  tabIndex?: number;
-  /**
-   * Reference to the component.
-   */
-  ref?: React.RefObject<HTMLDivElement>;
-};
-
-export default function DxcDateInput(props: Props): JSX.Element;

package/dialog/index.d.ts

@@ -1,18 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  isCloseVisible?: boolean;
-  onCloseClick?: void;
-  overlay?: boolean;
-  onBackgroundClick?: void;
-  padding?: Padding,
-  tabIndex?: number;
-};
-
-export default function DxcDialog(props: Props): JSX.Element;

package/dropdown/index.d.ts

@@ -1,26 +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 = {
-  options?: any;
-  optionsIconPosition?: "before" | "after";
-  icon?: any;
-  iconSrc?: string;
-  iconPosition?: "before" | "after";
-  label?: string;
-  disabled?: boolean;
-  caretHidden?: boolean;
-  onSelectOption?: void;
-  expandOnHover?: boolean;
-  margin?: Space | Margin;
-  size?: Size;
-  tabIndex?: number;
-};
-
-export default function DxcDropdown(props: Props): JSX.Element;

package/file-input/index.d.ts

@@ -1,81 +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 FileData = {
-  error?: string;
-  file?: File;
-  preview?: string;
-};
-
-type Props = {
-  /**
-   * Name attribute of the file input element.
-   */
-  name?: string;
-  /**
-   * Text to be placed above the file input.
-   */
-  label?: string;
-  /**
-   * Uses one of the available file input modes:
-   *    'file': Files are selected by clicking the button and selecting it through the file explorer.
-   *    'filedrop': Files can be selected by clicking the button and selecting it through the file explorer or by dropping them inside the drag and drop area.
-   *    'dropzone':  Files can be selected by clicking the button and selecting it through the file explorer or by dropping them inside the drag and drop area. 
-   *     The drag and drop area of this mode is bigger than the one of the filedrop mode.
-   */
-   mode?: "file" | "filedrop" | "dropzone";
-  /**
-   * Helper text to be placed above the file input.
-   */
-  helperText?: string;
-  /**
-   * Defines the file types accepted by the component. It is not possible to select a file with a non valid type.
-   */
-  accept?: string;
-  /**
-   * An array of FileData representing the selected files. 
-   */
-  value?: FileData[];
-  /**
-   * Minimum file size allowed (in bytes). If the file size does not comply the minSize, an error will be passed to the FileData.
-   */
-   minSize?: number;
-  /**
-   * Maximum file size allowed (in bytes). If the file size does not comply the maxSize, an error will be passed to the FileData.
-   */
-   maxSize?: number;
-  /**
-   * If true and if the file is an image, a preview of it will be shown. If it is not an image, an icon refering to the file's type will be shown. 
-   * If mode is not multiple and there is one file already selected, the file will be replaced by the last selected one.
-   */
-   showPreview?: boolean;
-  /**
-   * If true, more than one file can be selected. If false, only one file can be selected.
-   */
-   multiple?: boolean;
-  /**
-   * If true, the component will be disabled.
-   */
-  disabled?: boolean;
-  /**
-   * This function will be called when the user selects or drops a file. The list of files will be sent as a parameter.
-   * In this function, the files can be updated or returned as they come. These files must be passed to the value in order to be shown.
-   */
-  callbackFile?: (files: FileData[]) => void;
-  /**
-   * 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;
-  /**
-   * Value of the tabindex attribute.
-   */
-  tabIndex?: number;
-};
-
-export default function DxcFileInput(props: Props): JSX.Element;

package/footer/index.d.ts

@@ -1,25 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-type Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  socialLinks?: any;
-  bottomLinks?: any;
-  copyright?: string;
-  padding?: Space | Padding;
-  margin?: Space | Margin;
-  tabIndex?: number;
-  
-};
-
-export default function DxcFooter(props: Props): JSX.Element;

package/header/index.d.ts

@@ -1,25 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-type Padding = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  underlined?: boolean;
-  onClick?: void;
-  content?: any;
-  responsiveContent?: any;
-  margin?: Space | Margin;
-  padding?: Space | Padding;
-  tabIndex?: number;
-};
-
-export default function DxcHeader(props: Props): JSX.Element;

package/heading/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 = {
-  level?: 1 | 2 | 3 | 4 | 5;
-  text?: string;
-  as?: "h1" | "h2" | "h3" | "h4" | "h5";
-  weight?: "light" | "normal" | "bold";
-  margin?: Space | Margin;
-};
-
-export default function DxcHeading(props: Props): JSX.Element;

package/link/index.d.ts

@@ -1,23 +0,0 @@
-type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-type Margin = {
-  top?: Space;
-  bottom?: Space;
-  left?: Space;
-  right?: Space;
-};
-
-type Props = {
-  inheritColor?: boolean;
-  disabled?: boolean;
-  iconSrc?: string;
-  icon?: any;
-  iconPosition?: "before" | "after";
-  href?: string;
-  newWindow?: boolean;
-  onClick?: void;
-  text?: string;
-  margin?: Space | Margin;
-  tabIndex?: number;
-};
-
-export default function DxcLink(props: Props): JSX.Element;