@carbon/react/lib/components/ContainedList/ContainedList.js

React components for the Carbon Design System

/**
 * Copyright IBM Corp. 2016, 2023
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */

'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var React = require('react');
var PropTypes = require('prop-types');
var cx = require('classnames');
var index = require('../Layout/index.js');
var useId = require('../../internal/useId.js');
var usePrefix = require('../../internal/usePrefix.js');
var ContainedListItem = require('./ContainedListItem/ContainedListItem.js');
var Search = require('../Search/Search.js');
require('../Search/Search.Skeleton.js');

function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }

var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);

const variants = ['on-page', 'disclosed'];
function filterChildren(children) {
  if (Array.isArray(children)) {
    return children?.filter(child => !['Search', 'ExpandableSearch'].includes(child?.type?.displayName));
  }
  if (children && !['Search', 'ExpandableSearch'].includes(children?.type?.displayName)) {
    return children;
  }
  return null;
}
function renderChildren(children) {
  if (Array.isArray(children)) {
    children.map((child, index) => {
      if (index === 0 && child.type === Search["default"]) {
        return child;
      }
      return child;
    });
  }
  if (children && children.type === Search["default"]) {
    return children;
  }
  return children;
}
const ContainedList = ({
  action,
  children,
  className,
  isInset,
  kind = variants[0],
  label,
  size,
  ...rest
}) => {
  const labelId = `${useId.useId('contained-list')}-header`;
  const prefix = usePrefix.usePrefix();
  const classes = cx__default["default"](`${prefix}--contained-list`, {
    [`${prefix}--contained-list--inset-rulers`]: isInset,
    [`${prefix}--contained-list--${size}`]: size,
    // TODO: V12 - Remove this class
    [`${prefix}--layout--size-${size}`]: size
  }, `${prefix}--contained-list--${kind}`, className);
  const filteredChildren = filterChildren(children);
  function isSearchAction(action) {
    if (! /*#__PURE__*/React__default["default"].isValidElement(action)) {
      return false;
    }
    const actionTypes = ['Search', 'ExpandableSearch'];
    let actionType = '';
    if (typeof action.type === 'string') {
      actionType = action.type;
    } else {
      actionType = action.type.displayName || '';
    }
    return actionTypes.includes(actionType);
  }
  const isActionSearch = isSearchAction(action);
  const renderedChildren = renderChildren(children);
  return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({
    className: classes
  }, rest), /*#__PURE__*/React__default["default"].createElement("div", {
    className: `${prefix}--contained-list__header`
  }, /*#__PURE__*/React__default["default"].createElement("div", {
    id: labelId,
    className: `${prefix}--contained-list__label`
  }, label), /*#__PURE__*/React__default["default"].createElement(index.LayoutConstraint, {
    size: {
      min: 'sm',
      max: 'xl'
    },
    className: `${prefix}--contained-list__action`
  }, action)), children &&
  /*#__PURE__*/
  /**
   * Webkit removes implicit "list" semantics when "list-style-type: none" is set.
   * Explicitly setting the "list" role ensures assistive technology in webkit
   * browsers correctly announce the semantics.
   *
   * Ref https://bugs.webkit.org/show_bug.cgi?id=170179#c1
   */
  // eslint-disable-next-line jsx-a11y/no-redundant-roles
  React__default["default"].createElement("ul", {
    role: "list",
    "aria-labelledby": labelId
  }, isActionSearch ? filteredChildren : renderedChildren));
};
ContainedList.propTypes = {
  /**
   * A slot for a possible interactive element to render.
   */
  action: PropTypes__default["default"].node,
  /**
   * A collection of ContainedListItems to be rendered in the ContainedList
   */
  children: PropTypes__default["default"].node,
  /**
   * Additional CSS class names.
   */
  className: PropTypes__default["default"].string,
  /**
   * Specify whether the dividing lines in between list items should be inset.
   */
  isInset: PropTypes__default["default"].bool,
  /**
   * The kind of ContainedList you want to display
   */
  kind: PropTypes__default["default"].oneOf(variants),
  /**
   * A label describing the contained list.
   */
  label: PropTypes__default["default"].oneOfType([PropTypes__default["default"].string, PropTypes__default["default"].node]).isRequired,
  /**
   * Specify the size of the contained list.
   */
  size: PropTypes__default["default"].oneOf(['sm', 'md', 'lg', 'xl'])
};
ContainedList.ContainedListItem = ContainedListItem["default"];

exports["default"] = ContainedList;