@helpscout/hsds-react/components/List/List.js

React component library for Help Scout's Design System

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

exports.__esModule = true;
exports.default = exports.List = exports.ListContext = void 0;

var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));

var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));

var _react = _interopRequireWildcard(require("react"));

var _propTypes = _interopRequireDefault(require("prop-types"));

var _getValidProps = _interopRequireDefault(require("@helpscout/react-utils/dist/getValidProps"));

var _classnames = _interopRequireDefault(require("classnames"));

var _List = _interopRequireDefault(require("./List.Item"));

var _List2 = require("./List.css");

var _jsxRuntime = require("react/jsx-runtime");

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 ListContext = /*#__PURE__*/(0, _react.createContext)();
exports.ListContext = ListContext;

var List = function List(props) {
  var border = props.border,
      children = props.children,
      className = props.className,
      display = props.display,
      inlineSize = props.inlineSize,
      size = props.size,
      type = props.type,
      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["border", "children", "className", "display", "inlineSize", "size", "type"]);
  var componentClassName = (0, _classnames.default)('c-List', border === 'dot' && 'is-dotted', border === 'line' && 'is-bordered', display && "is-display-" + display, inlineSize && "is-inline-" + inlineSize, size && "is-" + size, type && "is-" + type, className);
  var as = type === 'number' ? 'ol' : 'ul';
  var contextValue = {
    borderStyle: border,
    isListItem: type === 'bullet' || type === 'number',
    inlineSize: inlineSize,
    size: size,
    type: type
  };
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(ListContext.Provider, {
    value: contextValue,
    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_List2.ListUI, (0, _extends2.default)({
      as: as
    }, (0, _getValidProps.default)(rest), {
      className: componentClassName,
      children: children
    }))
  });
};

exports.List = List;
List.Item = _List.default;
List.defaultProps = {
  'data-cy': 'List',
  display: 'block',
  inlineSize: 'md',
  role: 'list'
};
List.propTypes = {
  /** Border style for the items. */
  border: _propTypes.default.oneOf(['dot', 'line']),

  /** Custom class names to be added to the component. */
  className: _propTypes.default.string,

  /** Changes the component's CSS `display`.*/
  display: _propTypes.default.oneOf(['block', 'flex']),

  /** Size style for spacing between the items. `xs`, `sm`, `md`. */
  inlineSize: _propTypes.default.oneOf(['xs', 'sm', 'md']),

  /** Aria-role for the component.*/
  role: _propTypes.default.string,

  /** Size style for the items.*/
  size: _propTypes.default.oneOf(['xs', 'sm', 'md', 'lg']),

  /** List style style for the items. */
  type: _propTypes.default.oneOf(['bullet', 'inline', 'number']),

  /** Data attr for Cypress tests. */
  'data-cy': _propTypes.default.string
};
var _default = List;
exports.default = _default;