@elliemae/ds-menu 2.3.0-alpha.8 → 2.3.0-next.2

package/cjs/Menu.js

@@ -0,0 +1,195 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _jsx = require('@babel/runtime/helpers/jsx');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+require('core-js/modules/esnext.async-iterator.some.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.some.js');
+require('core-js/modules/esnext.async-iterator.constructor.js');
+require('core-js/modules/esnext.async-iterator.to-array.js');
+require('core-js/modules/esnext.iterator.to-array.js');
+require('core-js/modules/esnext.async-iterator.map.js');
+require('core-js/modules/esnext.iterator.map.js');
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var React = require('react');
+var reactDesc = require('react-desc');
+var lodash = require('lodash');
+var dsClassnames = require('@elliemae/ds-classnames');
+var web = require('react-spring/web');
+var hooks = require('@elliemae/ds-utilities/hooks');
+var system = require('@elliemae/ds-utilities/system');
+var FocusGroup = require('@elliemae/ds-shared/FocusGroup');
+var dsHidden = require('@elliemae/ds-hidden');
+var MenuItemRadio = require('./MenuItems/MenuItemRadio.js');
+var MenuItemCheckbox = require('./MenuItems/MenuItemCheckbox.js');
+var CheckboxGroup = require('./MenuItems/CheckboxGroup.js');
+var RadioGroup = require('./MenuItems/RadioGroup.js');
+var Separator = require('./MenuItems/Separator.js');
+var MenuItem = require('./MenuItems/MenuItem.js');
+var SubMenu = require('./MenuItems/SubMenu.js');
+var SearchableGroup = require('./MenuItems/SearchableGroup.js');
+var SelectionGroup = require('./MenuItems/SelectionGroup.js');
+var menuItemFactory = require('./MenuItems/menuItemFactory.js');
+var MenuContext = require('./MenuContext.js');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _jsx__default = /*#__PURE__*/_interopDefaultLegacy(_jsx);
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+
+const _excluded = ["containerProps", "innerRef", "as", "children", "onClickOutside", "visible", "focusOnOpen", "maxOption", "style", "minWidth", "maxWidth", "closeMenu", "responsiveHeight"],
+      _excluded2 = ["destroyed"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+const RESPONSIVE_HEIHGT_MARGIN = 120;
+const blockName = 'menu';
+
+const noop = () => {};
+
+const MenuComponent = dsClassnames.aggregatedClasses('div')(blockName, '', _ref => {
+  let {
+    menuComboBox,
+    type
+  } = _ref;
+  return {
+    'menu-combo-box': menuComboBox,
+    ["type-".concat(type)]: type
+  };
+});
+/**
+ * todo: -- IDEA -- each menu could have an overlay based on an overlay stack context so we can
+ * capture the context of the clicks on very nested components
+ */
+
+const isChildOfType = (child, type) => child.type.name === type;
+
+function DSMenu(_ref2) {
+  let {
+    containerProps = {},
+    innerRef,
+    as: MenuTag = web.animated.ul,
+    children = undefined,
+    onClickOutside = noop,
+    // handlers from hidden
+    visible = undefined,
+    focusOnOpen = false,
+    maxOption = 0,
+    style = {},
+    minWidth = undefined,
+    maxWidth = undefined,
+    closeMenu,
+    responsiveHeight = false
+  } = _ref2,
+      otherProps = _objectWithoutProperties__default["default"](_ref2, _excluded);
+
+  const menuRef = React.useRef(null);
+  const {
+    focusFirst
+  } = React.useContext(FocusGroup.FocusGroupContext);
+
+  const _useHiddenTransition = dsHidden.useHiddenTransition({
+    visible,
+    style
+  }),
+        hiddenProps = _objectWithoutProperties__default["default"](_useHiddenTransition, _excluded2); // force no addon to the children if the menu doesn't have any item with leftAddon like SelectionGroup
+
+
+  const nextChildren = React.useMemo(() => {
+    const forceLeftAddon = React__default["default"].Children.toArray(children).some(child => isChildOfType(child, 'SelectionGroup') || isChildOfType(child, 'MenuItemCheckbox') || isChildOfType(child, 'MenuItemRadio') || child.props.leftAddon);
+    return React__default["default"].Children.map(children, child => child && /*#__PURE__*/React__default["default"].cloneElement(child, _objectSpread(_objectSpread({}, child.props), {}, {
+      noAddon: !forceLeftAddon ? true : undefined,
+      maxOption,
+      closeMenu
+    })));
+  }, [children]);
+  hooks.useOnClickOutside(menuRef, onClickOutside);
+  React.useEffect(() => {
+    if (focusOnOpen && visible) {
+      setTimeout(() => {
+        focusFirst();
+      }, 0);
+    }
+  }, [visible, focusOnOpen]); // todo: find out a better approach to this
+
+  return !hiddenProps.destroyed ? /*#__PURE__*/_jsx__default["default"](MenuContext.Provider, {
+    value: {
+      visible,
+      closeMenu
+    }
+  }, void 0, /*#__PURE__*/jsxRuntime.jsx(MenuComponent, _objectSpread(_objectSpread(_objectSpread(_objectSpread({
+    "data-testid": containerProps !== null && containerProps !== void 0 && containerProps['data-testid'] ? containerProps['data-testid'] : "em-ds-menu"
+  }, containerProps), {}, {
+    as: MenuTag,
+    classProps: _objectSpread(_objectSpread({}, otherProps.classProps || {}), {}, {
+      type: otherProps.type
+    }),
+    innerRef: system.mergeRefs(innerRef, menuRef),
+    role: "menu"
+  }, lodash.omit(otherProps, ['scheduleUpdate'])), hiddenProps), {}, {
+    children: /*#__PURE__*/_jsx__default["default"]("div", {
+      className: "menu-component-internal-wrapper",
+      style: _objectSpread(_objectSpread({}, style), {}, {
+        minWidth,
+        maxWidth
+      }, responsiveHeight ? {
+        overflowY: 'scroll',
+        maxHeight: responsiveHeight ? "".concat(window.innerHeight - RESPONSIVE_HEIHGT_MARGIN, "px") : undefined
+      } : {})
+    }, void 0, nextChildren)
+  }))) : null;
+}
+
+const Menu = FocusGroup.focusGroupManagerHoc(DSMenu, {
+  loop: true
+});
+const props = {
+  /** Injected props to wrapper element of component */
+  containerProps: reactDesc.PropTypes.object.description('Injected props to wrapper element of component'),
+
+  /** Renders the menu with a specific html element */
+  as: reactDesc.PropTypes.element.description('Renders the menu with a specific html element'),
+
+  /** Handler when a user clicks outside the menu */
+  onClickOutside: reactDesc.PropTypes.func.description('Handler when a user clicks outside the menu'),
+
+  /** Whether the menu is visible or not */
+  visible: reactDesc.PropTypes.bool.description('Whether the menu is visible or not'),
+
+  /** When set to true, it's going to focus the first item */
+  focusOnOpen: reactDesc.PropTypes.bool.description("When set to true, it's going to focus the first item"),
+
+  /** Customize menu minWidth. Can be undefined or 'number' */
+  minWidth: reactDesc.PropTypes.number.description("Customize menu minWidth. Can be undefined or 'number'"),
+
+  /** Customize menu maxWidth. Can be undefined or 'number' */
+  maxWidth: reactDesc.PropTypes.number.description("Customize menu maxWidth. Can be undefined or 'number'")
+};
+const DSMenuWithSchema = reactDesc.describe(DSMenu);
+DSMenuWithSchema.propTypes = props; // todo: add a handler to get this kind of exports for documentation
+
+Menu.Item = MenuItem["default"];
+Menu.ItemCheckbox = MenuItemCheckbox;
+Menu.ItemRadio = MenuItemRadio["default"];
+Menu.SubMenu = SubMenu["default"];
+Menu.Separator = Separator["default"];
+Menu.CheckboxGroup = CheckboxGroup["default"];
+Menu.RadioGroup = RadioGroup["default"];
+Menu.SearchableGroup = SearchableGroup["default"];
+Menu.SelectionGroup = SelectionGroup["default"];
+
+exports.menuItemFactory = menuItemFactory.menuItemFactory;
+exports.renderMenuItems = menuItemFactory.renderMenuItems;
+exports.DSMenuWithSchema = DSMenuWithSchema;
+exports.Menu = Menu;
+exports["default"] = Menu;

package/cjs/MenuCombobox.js

@@ -0,0 +1,56 @@
+'use strict';
+
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var _jsx = require('@babel/runtime/helpers/jsx');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+require('react');
+var SearchableList = require('./MenuItems/SearchableList.js');
+var Menu = require('./Menu.js');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var _jsx__default = /*#__PURE__*/_interopDefaultLegacy(_jsx);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
+
+const _excluded = ["dropdownFilterOptions", "options", "onSelectMenuItem", "innerRef", "maxOptions", "loading"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function MenuCombobox(_ref) {
+  let {
+    dropdownFilterOptions = {},
+    options = [],
+    onSelectMenuItem = () => null,
+    innerRef,
+    maxOptions = 10,
+    loading = false
+  } = _ref,
+      rest = _objectWithoutProperties__default["default"](_ref, _excluded);
+
+  return /*#__PURE__*/jsxRuntime.jsx(Menu.Menu, _objectSpread(_objectSpread({}, rest), {}, {
+    classProps: {
+      menuComboBox: true
+    },
+    innerRef: innerRef,
+    visible: true,
+    children: /*#__PURE__*/_jsx__default["default"](SearchableList["default"], {
+      appendTermInList: true,
+      extraListProps: dropdownFilterOptions,
+      items: options,
+      onSelectMenuItem: onSelectMenuItem,
+      maxOptions: maxOptions,
+      loading: loading
+    })
+  }));
+}
+
+module.exports = MenuCombobox;

package/cjs/MenuContext.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var React = require('react');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+
+var MenuContext = /*#__PURE__*/React__default["default"].createContext();
+
+module.exports = MenuContext;

package/cjs/MenuItems/CheckboxGroup.js

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+require('react');
+var reactDesc = require('react-desc');
+var CheckableGroup = require('@elliemae/ds-shared/CheckableGroup');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var CheckableGroup__default = /*#__PURE__*/_interopDefaultLegacy(CheckableGroup);
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function CheckboxGroup(props) {
+  return /*#__PURE__*/jsxRuntime.jsx(CheckableGroup__default["default"], _objectSpread(_objectSpread({}, props), {}, {
+    multi: true
+  }));
+}
+
+const props = {
+  /* The item (if multi false) or items (if multi true) selected */
+  active: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.string).description('The item (if multi false) or items (if multi true) selected'),
+
+  /* Whether is multi select or not */
+  multi: reactDesc.PropTypes.bool.description('Whether is multi select or not'),
+
+  /* Handler when a user checks an item */
+  onCheck: reactDesc.PropTypes.func.description('Handler when a user checks an item')
+};
+const DSMenuCheckboxGroupWithSchema = reactDesc.describe(CheckboxGroup);
+DSMenuCheckboxGroupWithSchema.propTypes = props;
+
+exports.DSMenuCheckboxGroupWithSchema = DSMenuCheckboxGroupWithSchema;
+exports["default"] = CheckboxGroup;

package/cjs/MenuItems/MenuItem.js

@@ -0,0 +1,203 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+var _jsx = require('@babel/runtime/helpers/jsx');
+require('core-js/modules/esnext.async-iterator.map.js');
+require('core-js/modules/esnext.iterator.map.js');
+require('core-js/modules/web.dom-collections.iterator.js');
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var React = require('react');
+var reactDesc = require('react-desc');
+var lodash = require('lodash');
+var dsClassnames = require('@elliemae/ds-classnames');
+var dsUtilities = require('@elliemae/ds-utilities');
+var FocusGroup = require('@elliemae/ds-shared/FocusGroup');
+var DSTruncatedTooltipText = require('@elliemae/ds-truncated-tooltip-text');
+var menuItemFactory = require('./menuItemFactory.js');
+var SubMenu = require('./SubMenu.js');
+var MenuContext = require('../MenuContext.js');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
+var _jsx__default = /*#__PURE__*/_interopDefaultLegacy(_jsx);
+var DSTruncatedTooltipText__default = /*#__PURE__*/_interopDefaultLegacy(DSTruncatedTooltipText);
+
+const _excluded = ["innerRef", "as", "role", "leftAddon", "rightAddon", "disabledAddonInactive", "label", "children", "tabIndex", "onKeyDown", "fixedItem", "noAddon", "disabled", "customRenderer", "maxOption", "closeMenu", "style"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const noop = () => null;
+
+const blockName = 'menu-item';
+const Content = dsClassnames.aggregatedClasses('div')(blockName, 'content');
+const Addon = dsClassnames.aggregatedClasses('div')(blockName, 'addon', _ref => {
+  let {
+    empty,
+    fixedItem
+  } = _ref;
+  return {
+    empty,
+    fixedItem
+  };
+});
+
+const renderAddon = (addon, fixedItem, addonId) => /*#__PURE__*/_jsx__default["default"](Addon, {
+  classProps: {
+    fixedItem
+  }
+}, addonId, addon);
+
+const renderAddons = (addons, fixedItem) => Array.isArray(addons) ? addons.map(renderAddon) : renderAddon(addons, fixedItem);
+
+const Wrapper = dsClassnames.aggregatedClasses('li')(blockName, null, _ref2 => {
+  let {
+    disabled,
+    disabledAddonInactive,
+    customRenderer,
+    fixedItem,
+    type
+  } = _ref2;
+  return {
+    disabled,
+    disabledAddonInactive,
+    customRenderer,
+    fixedItem,
+    ["menu-type-".concat(type)]: type
+  };
+});
+
+const calculateSize = function () {
+  let length = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+  if (length > 45) return 45 * 7;
+  return length * 7;
+};
+
+function MenuItem(props) {
+  const {
+    innerRef,
+    as = 'li',
+    role = 'menuitem',
+    leftAddon = null,
+    rightAddon = undefined,
+    disabledAddonInactive = undefined,
+    label = undefined,
+    children,
+    tabIndex = -1,
+    onKeyDown = noop,
+    fixedItem = false,
+    noAddon,
+    disabled = false,
+    customRenderer,
+    maxOption,
+    closeMenu,
+    style
+  } = props,
+        otherProps = _objectWithoutProperties__default["default"](props, _excluded);
+
+  const menuCxt = React.useContext(MenuContext);
+  const ref = React.useRef(null);
+  FocusGroup.useFocusGroupItem(ref);
+
+  if (otherProps.subItems) {
+    return /*#__PURE__*/jsxRuntime.jsx(SubMenu["default"], _objectSpread(_objectSpread({}, props), {}, {
+      closeMenu: menuCxt.closeMenu,
+      children: menuItemFactory.renderMenuItems(otherProps.subItems)
+    }));
+  }
+
+  const wrapperProps = React.useMemo(() => lodash.omit(otherProps, ['icon']), [otherProps]);
+
+  const onClick = function () {
+    if (wrapperProps.onClick) wrapperProps.onClick(...arguments);
+
+    if (wrapperProps.closeOnClick && menuCxt.closeMenu) {
+      menuCxt.closeMenu(...arguments);
+    }
+  };
+
+  return /*#__PURE__*/jsxRuntime.jsxs(Wrapper, _objectSpread(_objectSpread({
+    as: as,
+    classProps: {
+      disabled,
+      disabledAddonInactive,
+      customRenderer,
+      fixedItem,
+      type: otherProps.type
+    },
+    id: otherProps.id,
+    innerRef: otherProps.type !== 'disabled' ? dsUtilities.mergeRefs(innerRef, ref) : innerRef,
+    onKeyDown: !fixedItem && dsUtilities.runAll(e => {
+      if (e.key === ' ' || e.key === 'Enter') {
+        e.preventDefault();
+        e.target.dispatchEvent(new MouseEvent('click', {
+          view: window,
+          bubbles: true,
+          cancelable: false
+        }));
+      }
+    }, onKeyDown),
+    role: role,
+    style: style,
+    tabIndex: tabIndex
+  }, wrapperProps), {}, {
+    onClick: onClick,
+    children: [!noAddon && renderAddons(leftAddon, fixedItem), label && /*#__PURE__*/_jsx__default["default"](Content, {
+      style: maxOption > 0 ? {
+        width: "".concat(calculateSize(maxOption), "px"),
+        maxWidth: "".concat(calculateSize(maxOption), "px")
+      } : undefined
+    }, void 0, /*#__PURE__*/_jsx__default["default"](DSTruncatedTooltipText__default["default"], {
+      value: label
+    })), customRenderer, rightAddon && renderAddons(rightAddon), children]
+  }));
+}
+
+const props = {
+  /** Renders the MenuItem with a specific html element */
+  as: reactDesc.PropTypes.element.description('Renders the MenuItem with a specific html element'),
+
+  /**
+   * reference to the component
+   */
+  innerRef: reactDesc.PropTypes.oneOfType([reactDesc.PropTypes.func, reactDesc.PropTypes.shape({
+    current: reactDesc.PropTypes.any
+  })]).description('reference to the component'),
+
+  /** Renders the passed element to the left */
+  leftAddon: reactDesc.PropTypes.element.description('Renders the passed element to the left'),
+
+  /** Renders the passed element to the right */
+  rightAddon: reactDesc.PropTypes.element.description('Renders the passed element to the right'),
+
+  /** Label for the menu item */
+  label: reactDesc.PropTypes.string.description('Label for the menu item'),
+
+  /** style object for menu item wrapper */
+  style: reactDesc.PropTypes.object.description('style object for menu item wrapper'),
+
+  /** disable menu item */
+  disabled: reactDesc.PropTypes.bool.description('disable menu item'),
+
+  /** HTML tabindex to manage focus order */
+  tabindex: reactDesc.PropTypes.number.description('HTML tabindex to manage focus order'),
+
+  /** a11y role */
+  role: reactDesc.PropTypes.string.description('a11y role')
+};
+const DSMenuItemWithSchema = reactDesc.describe(MenuItem);
+DSMenuItemWithSchema.propTypes = props;
+
+exports.DSMenuItemWithSchema = DSMenuItemWithSchema;
+exports["default"] = MenuItem;

package/cjs/MenuItems/MenuItemCheckable.js

@@ -0,0 +1,119 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var _jsx = require('@babel/runtime/helpers/jsx');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+require('react');
+var reactDesc = require('react-desc');
+var dsIcons = require('@elliemae/ds-icons');
+var dsUtilities = require('@elliemae/ds-utilities');
+var MenuItem = require('./MenuItem.js');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var _jsx__default = /*#__PURE__*/_interopDefaultLegacy(_jsx);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
+
+var _div;
+
+const _excluded = ["role", "checked", "name", "checkIcon", "children", "leftAddon", "item"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function useCheckable(_ref) {
+  let {
+    checked
+  } = _ref;
+  return {
+    checked,
+    'aria-checked': checked
+  };
+}
+/**
+ * Reuses the same props as the MenuItem
+ *
+ * @param root0
+ * @param root0.role
+ * @param root0.checked
+ * @param root0.name
+ * @param root0.checkIcon
+ * @param root0.children
+ * @param root0.leftAddon
+ * @param root0.item
+ */
+
+
+function MenuItemCheckable(_ref2) {
+  let {
+    role = 'menuitemcheckbox',
+    checked = false,
+    name = '',
+    checkIcon = /*#__PURE__*/_jsx__default["default"](dsIcons.Checkmark, {
+      color: ['brand-primary', 600]
+    }),
+    // eslint-disable-next-line react/prop-types
+    children,
+    leftAddon,
+    item = undefined
+  } = _ref2,
+      otherProps = _objectWithoutProperties__default["default"](_ref2, _excluded);
+
+  const checkableProps = useCheckable({
+    checked,
+    name
+  });
+
+  const handleClick = () => dsUtilities.runAll(otherProps.onClick, checkableProps.onClick)({
+    target: {
+      value: name,
+      checked
+    }
+  }, item);
+
+  const checkAddon = leftAddon || (checkableProps.checked ? /*#__PURE__*/_jsx__default["default"]("div", {
+    className: "checkable-mark"
+  }, void 0, checkIcon) : _div || (_div = /*#__PURE__*/_jsx__default["default"]("div", {})));
+  return /*#__PURE__*/jsxRuntime.jsx(MenuItem["default"], _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, item), otherProps), checkableProps), {}, {
+    customRenderer: item && item.customRenderer ? item.customRenderer : () => {},
+    items: otherProps.subItems,
+    leftAddon: checkAddon,
+    onClick: handleClick,
+    role: role
+  }));
+}
+
+const props = {
+  /** Whether the item is checked or not */
+  checked: reactDesc.PropTypes.bool.description('Whether the item is checked or not'),
+
+  /** A custom item when the item is checked */
+  checkIcon: reactDesc.PropTypes.element.description('A custom item when the item is checked'),
+
+  /** form field name */
+  name: reactDesc.PropTypes.string.description('form field name'),
+
+  /** menu item object props */
+  item: reactDesc.PropTypes.object.description('menu item object props'),
+
+  /** a11y role */
+  role: reactDesc.PropTypes.string.description('a11y role'),
+
+  /** left addon component */
+  leftAddon: reactDesc.PropTypes.node.description('left addon component')
+};
+const DSMenuItemCheckeableWithSchema = reactDesc.describe(MenuItemCheckable);
+DSMenuItemCheckeableWithSchema.propTypes = props;
+
+exports.DSMenuItemCheckeableWithSchema = DSMenuItemCheckeableWithSchema;
+exports["default"] = MenuItemCheckable;

package/cjs/MenuItems/MenuItemCheckbox.js

@@ -0,0 +1,42 @@
+'use strict';
+
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.filter.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var _jsx = require('@babel/runtime/helpers/jsx');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+require('react');
+var dsForm = require('@elliemae/ds-form');
+var MenuItemCheckable = require('./MenuItemCheckable.js');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+var _jsx__default = /*#__PURE__*/_interopDefaultLegacy(_jsx);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
+
+const _excluded = ["checked"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function MenuItemCheckbox(_ref) {
+  let {
+    checked
+  } = _ref,
+      rest = _objectWithoutProperties__default["default"](_ref, _excluded);
+
+  return /*#__PURE__*/jsxRuntime.jsx(MenuItemCheckable["default"], _objectSpread(_objectSpread({}, rest), {}, {
+    leftAddon: /*#__PURE__*/_jsx__default["default"](dsForm.DSCheckbox, {
+      checked: checked
+    }),
+    role: "menuitemcheckbox"
+  }));
+}
+
+module.exports = MenuItemCheckbox;