carbon-react 115.0.2 → 116.0.0

package/esm/components/tile-select/tile-select-group.component.js

@@ -2,26 +2,22 @@ function _extends() { _extends = Object.assign || function (target) { for (var i
 
 import React from "react";
 import PropTypes from "prop-types";
-import styledSystemPropTypes from "@styled-system/prop-types";
 import tagComponent from "../../__internal__/utils/helpers/tags/tags";
-import TileSelect from "./tile-select.component";
 import RadioButtonMapper from "../../__internal__/radio-button-mapper/radio-button-mapper.component";
 import { StyledTileSelectFieldset, StyledGroupDescription } from "./tile-select.style";
 import { filterStyledSystemMarginProps } from "../../style/utils";
-const marginPropTypes = filterStyledSystemMarginProps(styledSystemPropTypes.space);
 
-const TileSelectGroup = props => {
-  const {
-    children,
-    name,
-    legend,
-    description,
-    onChange,
-    onBlur,
-    value,
-    multiSelect,
-    ...rest
-  } = props;
+const TileSelectGroup = ({
+  children,
+  name,
+  legend,
+  description,
+  onChange,
+  onBlur,
+  value,
+  multiSelect = false,
+  ...rest
+}) => {
   let tiles;
 
   if (multiSelect) {
@@ -32,9 +28,15 @@ const TileSelectGroup = props => {
       onBlur: onBlur,
       onChange: onChange,
       value: value
-    }, React.Children.map(children, child => /*#__PURE__*/React.cloneElement(child, {
-      type: "radio"
-    })));
+    }, React.Children.map(children, child => {
+      if ( /*#__PURE__*/React.isValidElement(child)) {
+        return /*#__PURE__*/React.cloneElement(child, {
+          type: "radio"
+        });
+      }
+
+      return child;
+    }));
   }
 
   return /*#__PURE__*/React.createElement(StyledTileSelectFieldset, _extends({
@@ -46,46 +48,169 @@ const TileSelectGroup = props => {
   }, description) : null, /*#__PURE__*/React.createElement("div", null, tiles));
 };
 
-TileSelectGroup.propTypes = { ...marginPropTypes,
-
-  /** The TileSelect components to be rendered in the group */
-  children: (props, propName, componentName) => {
-    let error;
-    const prop = props[propName];
-    React.Children.forEach(prop, child => {
-      if (TileSelect.displayName !== child.type.displayName) {
-        error = new Error(`\`${componentName}\` only accepts children of type \`${TileSelect.displayName}\`.`);
-      }
-    });
-    return error;
-  },
-
-  /** The content for the TileSelectGroup Legend */
-  legend: PropTypes.string,
-
-  /** Description to be rendered below the legend */
-  description: PropTypes.string,
-
-  /** The currently selected value - only for single select mode. */
-  value: PropTypes.string,
-
-  /** The name to apply to the input - only for single select mode. */
-  name: PropTypes.string,
-
-  /** A callback triggered when one of tiles is selected - only for single select mode. */
-  onChange: PropTypes.func,
-
-  /** A callback triggered when one of tiles is blurred - only for single select mode. */
-  onBlur: PropTypes.func,
-
-  /** When passed as true TileSelectGroup serves only visual purpose */
-
-  /** It wraps TileSelects in fieldset element and renders the legend and description props content */
-
-  /** onChange, onBlur, value, checked and name props are meant to be passed individually on each of the TileSelects */
-  multiSelect: PropTypes.bool
-};
-TileSelectGroup.defaultProps = {
-  multiSelect: false
+TileSelectGroup.propTypes = {
+  "children": PropTypes.node,
+  "description": PropTypes.string,
+  "legend": PropTypes.string,
+  "m": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "margin": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginBottom": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginLeft": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginRight": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginTop": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginX": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginY": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mb": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "ml": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mr": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mt": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "multiSelect": PropTypes.bool,
+  "mx": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "my": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "name": PropTypes.string.isRequired,
+  "onBlur": PropTypes.func,
+  "onChange": PropTypes.func,
+  "value": PropTypes.string
 };
+export { TileSelectGroup };
 export default TileSelectGroup;

package/esm/components/tile-select/tile-select.component.d.ts

@@ -0,0 +1,58 @@
+import React from "react";
+import { MarginProps } from "styled-system";
+export interface TileSelectDeselectEvent {
+    target: {
+        name?: string;
+        id?: string;
+        value: null;
+        checked: false;
+    };
+}
+export interface TileSelectProps extends MarginProps {
+    /** title of the TileSelect */
+    title?: React.ReactNode;
+    /** adornment to be rendered next to the title */
+    titleAdornment?: React.ReactNode;
+    /** subtitle of the TileSelect */
+    subtitle?: React.ReactNode;
+    /** description of the TileSelect */
+    description?: React.ReactNode;
+    /** disables the TileSelect input */
+    disabled?: boolean;
+    /** the value that is represented by this TileSelect */
+    value?: string;
+    /** input id */
+    id?: string;
+    /** input name */
+    name?: string;
+    /** Callback triggered when user selects or deselects this tile */
+    onChange?: (ev: React.ChangeEvent<HTMLInputElement> | TileSelectDeselectEvent) => void;
+    /** Callback triggered when the user blurs this tile */
+    onBlur?: (ev: React.FocusEvent<HTMLInputElement>) => void;
+    /** Callback triggered when the user focus this tile */
+    onFocus?: (ev: React.FocusEvent<HTMLInputElement>) => void;
+    /** determines if this tile is selected or unselected */
+    checked?: boolean;
+    /** Custom class name passed to the root element of TileSelect */
+    className?: string;
+    /** Type of the TileSelect input */
+    type?: "radio" | "checkbox";
+    /** Render prop that allows overriding the default action button. */
+    customActionButton?: (onClick: () => void) => JSX.Element;
+    /** An additional help info icon rendered next to the action button */
+    actionButtonAdornment?: React.ReactNode;
+    /** footer of the TileSelect */
+    footer?: React.ReactNode;
+    /** Component to render in the top left corner of TileSelect */
+    prefixAdornment?: React.ReactNode;
+    /** Component to render additional information row between title and description */
+    additionalInformation?: React.ReactNode;
+    /** Components to render in the TileSelect Accordion */
+    accordionContent?: React.ReactNode;
+    /** Callback to toggle expanded state of TileSelect Accordion */
+    accordionControl?: (controlId: string, contentId: string) => JSX.Element;
+    /** Flag to control the open state of TileSelect Accordion */
+    accordionExpanded?: boolean;
+}
+declare const TileSelect: React.ForwardRefExoticComponent<TileSelectProps & React.RefAttributes<HTMLInputElement>>;
+export default TileSelect;