@dxc-technology/halstack-react 4.0.1 → 5.0.0

package/radio/Radio.stories.tsx

@@ -0,0 +1,192 @@
+import React from "react";
+import DxcRadio from "./Radio";
+import { BackgroundColorProvider } from "../BackgroundColorContext";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DarkContainer from "../../.storybook/components/DarkSection";
+import { userEvent, within } from "@storybook/testing-library";
+
+export default {
+  title: "Radio",
+  component: DxcRadio,
+};
+
+const Radio = () => (
+  <>
+    <>
+      <ExampleContainer>
+        <Title title="Default" theme="light" level={4} />
+        <DxcRadio label="Radio" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Focused" theme="light" level={4} />
+        <DxcRadio label="Focused" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Checked" theme="light" level={4} />
+        <DxcRadio label="Radio" checked />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Required" theme="light" level={4} />
+        <DxcRadio label="Radio" required />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled and checked" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled checked />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled and required" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled required />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled, required and checked" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled required checked />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Label after" theme="light" level={4} />
+        <DxcRadio label="Radio" labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Checked with label after" theme="light" level={4} />
+        <DxcRadio label="Radio" checked labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Required with label after" theme="light" level={4} />
+        <DxcRadio label="Radio" required labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled and checked with label after" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled checked labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled and required with label after" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled required labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer>
+        <Title title="Disabled, required and checked with label after" theme="light" level={4} />
+        <DxcRadio label="Radio" disabled required checked labelPosition="after" />
+      </ExampleContainer>
+      <ExampleContainer pseudoState="pseudo-hover">
+        <Title title="Hovered" theme="light" level={4} />
+        <DxcRadio label="Hovered" />
+      </ExampleContainer>
+      <ExampleContainer pseudoState="pseudo-hover">
+        <Title title="Hovered and checked" theme="light" level={4} />
+        <DxcRadio label="Hovered" checked />
+      </ExampleContainer>
+    </>
+    <BackgroundColorProvider color="#333333">
+      <DarkContainer>
+        <>
+          <ExampleContainer>
+            <Title title="Default" theme="dark" level={4} />
+            <DxcRadio label="Radio" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Checked" theme="dark" level={4} />
+            <DxcRadio label="Radio" checked />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Required" theme="dark" level={4} />
+            <DxcRadio label="Radio" required />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled and checked" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled checked />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled and required" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled required />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled, required and checked" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled required checked />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Checked with label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" checked labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Required with label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" required labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled and checked with label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled checked labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled and required with label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled required labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer>
+            <Title title="Disabled, required and checked with label after" theme="dark" level={4} />
+            <DxcRadio label="Radio" disabled required checked labelPosition="after" />
+          </ExampleContainer>
+          <ExampleContainer pseudoState="pseudo-hover">
+            <Title title="Hovered" theme="dark" level={4} />
+            <DxcRadio label="Hovered" />
+          </ExampleContainer>
+          <ExampleContainer pseudoState="pseudo-hover">
+            <Title title="Hovered and checked" theme="dark" level={4} />
+            <DxcRadio label="Hovered" checked />
+          </ExampleContainer>
+        </>
+      </DarkContainer>
+    </BackgroundColorProvider>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <DxcRadio label="Small" size="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcRadio label="Medium" size="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcRadio label="Large" size="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcRadio label="FitContent" size="fitContent" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcRadio label="FillParent" size="fillParent" />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcRadio label="Xxsmall" margin={"xxsmall"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcRadio label="Xsmall" margin={"xsmall"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcRadio label="Small" margin={"small"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcRadio label="Medium" margin={"medium"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcRadio label="Large" margin={"large"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcRadio label="Xlarge" margin={"xlarge"} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcRadio label="Xxlarge" margin={"xxlarge"} />
+    </ExampleContainer>
+  </>
+);
+
+export const Chromatic = Radio.bind({});
+Chromatic.play = async () => {
+  await userEvent.tab();
+  await userEvent.tab();
+};

package/radio/Radio.test.js

@@ -0,0 +1,71 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Radio = _interopRequireDefault(require("./Radio"));
+
+describe("Radio component tests", function () {
+  test("Radio renders correctly", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Radio["default"], {
+      label: "Radio button"
+    })),
+        getByText = _render.getByText;
+
+    expect(getByText("Radio button")).toBeTruthy();
+  });
+  test("Calls correct function on click", function () {
+    var onClick = jest.fn();
+
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Radio["default"], {
+      label: "Radio button",
+      onClick: onClick
+    })),
+        getByText = _render2.getByText;
+
+    _react2.fireEvent.click(getByText("Radio button"));
+
+    expect(onClick).toHaveBeenCalled();
+    expect(onClick).toHaveBeenCalledWith(true);
+  });
+  test("Controlled Radio", function () {
+    var onClick = jest.fn();
+
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Radio["default"], {
+      label: "Radio button",
+      checked: false,
+      onClick: onClick
+    })),
+        getByText = _render3.getByText,
+        getByRole = _render3.getByRole;
+
+    expect(getByRole("radio").checked).toBe(false);
+
+    _react2.fireEvent.click(getByText("Radio button"));
+
+    expect(onClick).toHaveBeenCalled();
+    expect(onClick).toHaveBeenCalledWith(true);
+    expect(getByRole("radio").checked).toBe(false);
+  });
+  test("Uncontrolled Radio", function () {
+    var onClick = jest.fn();
+
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Radio["default"], {
+      label: "Radio button",
+      onClick: onClick
+    })),
+        getByText = _render4.getByText,
+        getByRole = _render4.getByRole;
+
+    expect(getByRole("radio").checked).toBe(false);
+
+    _react2.fireEvent.click(getByText("Radio button"));
+
+    expect(onClick).toHaveBeenCalled();
+    expect(onClick).toHaveBeenCalledWith(true);
+    expect(getByRole("radio").checked).toBe(false);
+  });
+});

package/radio/types.d.ts

@@ -0,0 +1,54 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * If true, the radio is selected. If undefined the component will be uncontrolled
+     * and the value will be managed internally by the component.
+     */
+    checked?: boolean;
+    /**
+     * Will be passed to the value attribute of the html input element. When inside a
+     * form, this value will be only submitted if the radio is checked.
+     */
+    value?: string;
+    /**
+     * Text to be placed next to the radio.
+     */
+    label: string;
+    /**
+     * Whether the label should appear after or before the radio.
+     */
+    labelPosition?: "before" | "after";
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the radio will change its appearence, showing that the value is required.
+     */
+    required?: boolean;
+    /**
+     * This function will be called when the user clicks the radio. The new value will
+     * be passed as a parameter.
+     */
+    onClick?: (val: boolean) => 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;
+    /**
+     * Size of the component.
+     */
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
+};
+export default Props;

package/radio/types.js

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

package/radio-group/Radio.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { RadioProps } from "./types";
+declare const _default: React.MemoExoticComponent<({ option, currentValue, onClick, error, disabled, focused, readonly, tabIndex, }: RadioProps) => JSX.Element>;
+export default _default;

package/radio-group/Radio.js

@@ -0,0 +1,141 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _uuid = require("uuid");
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var DxcRadio = function DxcRadio(_ref) {
+  var _option$disabled;
+
+  var option = _ref.option,
+      currentValue = _ref.currentValue,
+      onClick = _ref.onClick,
+      error = _ref.error,
+      disabled = _ref.disabled,
+      focused = _ref.focused,
+      readonly = _ref.readonly,
+      tabIndex = _ref.tabIndex;
+
+  var _useState = (0, _react.useState)("radio-".concat((0, _uuid.v4)())),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 1),
+      radioLabelId = _useState2[0];
+
+  var ref = (0, _react.useRef)(null);
+  var colorsTheme = (0, _useTheme["default"])();
+
+  var handleOnClick = function handleOnClick() {
+    var _ref$current;
+
+    onClick();
+    focused && document.activeElement !== (ref === null || ref === void 0 ? void 0 : ref.current) && (ref === null || ref === void 0 ? void 0 : (_ref$current = ref.current) === null || _ref$current === void 0 ? void 0 : _ref$current.focus());
+  };
+
+  var _useState3 = (0, _react.useState)(true),
+      _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+      firstUpdate = _useState4[0],
+      setFirstUpdate = _useState4[1];
+
+  (0, _react.useLayoutEffect)(function () {
+    var _ref$current2;
+
+    // Don't apply in the first render
+    if (firstUpdate) {
+      setFirstUpdate(false);
+      return;
+    }
+
+    focused && (ref === null || ref === void 0 ? void 0 : (_ref$current2 = ref.current) === null || _ref$current2 === void 0 ? void 0 : _ref$current2.focus());
+  }, [focused]);
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.radioGroup
+  }, /*#__PURE__*/_react["default"].createElement(RadioMainContainer, null, /*#__PURE__*/_react["default"].createElement(RadioContainer, {
+    error: error,
+    disabled: disabled,
+    readonly: readonly,
+    onMouseDown: function onMouseDown(event) {
+      // Prevents div's onClick from stealing the radio input's focus
+      event.preventDefault();
+    },
+    onClick: handleOnClick
+  }, /*#__PURE__*/_react["default"].createElement(RadioInputContainer, null, /*#__PURE__*/_react["default"].createElement(RadioInput, {
+    error: error,
+    disabled: disabled,
+    readonly: readonly,
+    role: "radio",
+    "aria-checked": option.value === currentValue,
+    "aria-disabled": (_option$disabled = option.disabled) !== null && _option$disabled !== void 0 ? _option$disabled : false,
+    "aria-labelledby": radioLabelId,
+    tabIndex: disabled ? -1 : focused ? tabIndex : -1,
+    ref: ref
+  }, option.value === currentValue && /*#__PURE__*/_react["default"].createElement(Dot, {
+    disabled: disabled,
+    readonly: readonly,
+    error: error
+  }))), /*#__PURE__*/_react["default"].createElement(Label, {
+    id: radioLabelId,
+    disabled: disabled
+  }, option.label))));
+};
+
+var RadioMainContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n"])));
+
+var RadioContainer = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  align-items: center;\n  cursor: ", ";\n\n  ", "\n"])), function (props) {
+  return props.disabled ? "not-allowed" : props.readonly ? "default" : "pointer";
+}, function (props) {
+  return !props.disabled ? "\n      &:hover {\n        & > div > div { \n          border-color: ".concat(props.error ? props.theme.hoverErrorRadioInputColor : props.readonly ? props.theme.hoverReadonlyRadioInputColor : props.theme.hoverRadioInputColor, ";\n          & > span {\n            background-color: ").concat(props.error ? props.theme.hoverErrorRadioInputColor : props.readonly ? props.theme.hoverReadonlyRadioInputColor : props.theme.hoverRadioInputColor, ";\n          }\n        };\n      }\n      &:active {\n        & > div > div {\n          border-color: ").concat(props.error ? props.theme.activeErrorRadioInputColor : props.readonly ? props.theme.activeReadonlyRadioInputColor : props.theme.activeRadioInputColor, ";\n          & > span {\n            background-color: ").concat(props.error ? props.theme.activeErrorRadioInputColor : props.readonly ? props.theme.activeReadonlyRadioInputColor : props.theme.activeRadioInputColor, ";\n          }\n        }\n      }\n    ") : "pointer-events: none;";
+});
+
+var RadioInputContainer = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  justify-content: center;\n  height: 24px;\n  width: 24px;\n"])));
+
+var RadioInput = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  justify-content: center;\n  box-sizing: border-box;\n  width: 18px;\n  height: 18px;\n  border: 2px solid\n    ", ";\n  border-radius: 50%;\n\n  ", "\n"])), function (props) {
+  if (props.disabled) return props.theme.disabledRadioInputColor;else if (props.error) return props.theme.errorRadioInputColor;else if (props.readonly) return props.theme.readonlyRadioInputColor;else return props.theme.radioInputColor;
+}, function (props) {
+  return !props.disabled ? "&:focus {\n          outline: 2px solid ".concat(props.theme.focusBorderColor, ";\n          outline-offset: 1px;\n        }\n        &:focus-visible {\n          outline: 2px solid ").concat(props.theme.focusBorderColor, ";\n          outline-offset: 1px;\n        }\n      ") : "\n        :focus-visible {\n          outline: none;\n        }\n    ";
+});
+
+var Dot = _styledComponents["default"].span(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  height: 10px;\n  width: 10px;\n  border-radius: 50%;\n  background-color: ", ";\n"])), function (props) {
+  if (props.disabled) return props.theme.disabledRadioInputColor;else if (props.error) return props.theme.errorRadioInputColor;else if (props.readonly) return props.theme.readonlyRadioInputColor;else return props.theme.radioInputColor;
+});
+
+var Label = _styledComponents["default"].span(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  margin-left: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n  ", "\n"])), function (props) {
+  return props.theme.radioInputLabelMargin;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.radioInputLabelFontSize;
+}, function (props) {
+  return props.theme.radioInputLabelFontStyle;
+}, function (props) {
+  return props.theme.radioInputLabelFontWeight;
+}, function (props) {
+  return props.theme.radioInputLabelLineHeight;
+}, function (props) {
+  return props.disabled && "color: ".concat(props.theme.disabledRadioInputLabelFontColor, "; pointer-events: none;");
+});
+
+var _default = /*#__PURE__*/_react["default"].memo(DxcRadio);
+
+exports["default"] = _default;

package/radio-group/RadioGroup.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import RadioGroupPropsType from "./types";
+declare const DxcRadioGroup: React.ForwardRefExoticComponent<RadioGroupPropsType & React.RefAttributes<HTMLDivElement>>;
+export default DxcRadioGroup;