@salesforce/design-system-react
Version:
Salesforce Lightning Design System for React
412 lines (361 loc) • 18.2 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _react = _interopRequireDefault(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _lodash = _interopRequireDefault(require("lodash.isequal"));
var _classnames = _interopRequireDefault(require("classnames"));
var _icon = _interopRequireDefault(require("../../icon"));
var _spinner = _interopRequireDefault(require("../../spinner"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
var propTypes = {
/*
* Active descendant in menu
*/
activeOption: _propTypes.default.object,
/*
* Index of active descendant in menu
*/
activeOptionIndex: _propTypes.default.number,
/**
* CSS classes to be added to menu sub header `span` tag. Uses `classNames` [API](https://github.com/JedWatson/classnames).
*/
classNameMenuSubHeader: _propTypes.default.oneOfType([_propTypes.default.array, _propTypes.default.object, _propTypes.default.string]),
/**
* Sets the dialog width to the width of one of the following:
* `target`: (Menus attached to `input` typically follow this UX pattern),
* `menu`: Consider setting a menuMaxWidth if using this value. If not, width will be set to width of largest menu item.
* 'none'
*/
inheritWidthOf: _propTypes.default.oneOf(['target', 'menu', 'none']),
/*
* Id used for assistive technology
*/
inputId: _propTypes.default.string,
/**
* Determines the height of the menu based on SLDS CSS classes.
*/
itemVisibleLength: _propTypes.default.oneOf([5, 7, 10]),
/**
* **Text labels for internationalization**
* This object is merged with the default props object on every render.
* * `noOptionsFound`: Custom message that renders when no matches found. The default empty state is just text that says, 'No matches found.'.
*/
labels: _propTypes.default.shape({
noOptionsFound: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.string]).isRequired
}),
/**
* Accepts a custom menu item rendering function that becomes a custom component and is passed in the following props:
* * `assistiveText`: Object, `assistiveText` prop that is passed into Combobox
* * `option`: Object, option data for item being rendered that is passed into Combobox
* * `selected`: Boolean, allows rendering of `assistiveText.optionSelectedInMenu` in Readonly Combobox
*
* _Tested with snapshot testing._
*/
onRenderMenuItem: _propTypes.default.func,
/**
* Accepts a ref function or object (React.createRef() or otherwise) to store the menu DOM reference once available
*/
menuRef: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
/*
* Sets a maximum width that the menu will be if `inheritWidthOf` is menu.
*/
maxWidth: _propTypes.default.string,
/*
* Callback when option is selected with keyboard or mouse
*/
onSelect: _propTypes.default.func,
/*
* Menu options
*/
options: _propTypes.default.array,
/*
* Selected options
*/
selection: _propTypes.default.array,
/*
* Adds loading spinner below the options
*/
hasMenuSpinner: _propTypes.default.bool,
/**
* Accepts a tooltip that is displayed when hovering on disabled menu items.
*/
tooltipMenuItemDisabled: _propTypes.default.element,
/**
* Changes styles of the menu option
*/
variant: _propTypes.default.oneOf(['icon-title-subtitle', 'checkbox']),
isSelected: _propTypes.default.func,
assistiveText: _propTypes.default.object
};
var setBold = function setBold(label, searchTerm) {
if (!label || label.length === 0 || !searchTerm || searchTerm.length === 0) {
return label;
}
var position = label.toLowerCase().indexOf(searchTerm.toLowerCase());
if (position > -1) {
return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, label.substr(0, position), /*#__PURE__*/_react.default.createElement("span", {
key: "bold",
className: "slds-text-title_bold"
}, "".concat(label.substr(position, searchTerm.length))), label.substr(position + searchTerm.length));
}
return label;
};
var renderLabel = function renderLabel(labelProp, searchTerm) {
if (labelProp == null || typeof labelProp === 'string') {
return labelProp;
}
return labelProp(searchTerm);
};
var Menu = function Menu(_ref) {
var activeOption = _ref.activeOption,
activeOptionIndex = _ref.activeOptionIndex,
classNameMenuSubHeader = _ref.classNameMenuSubHeader,
classNameMenu = _ref.classNameMenu,
inheritWidthOf = _ref.inheritWidthOf,
inputId = _ref.inputId,
itemVisibleLength = _ref.itemVisibleLength,
labels = _ref.labels,
onRenderMenuItem = _ref.onRenderMenuItem,
_ref$menuRef = _ref.menuRef,
menuRef = _ref$menuRef === void 0 ? function () {} : _ref$menuRef,
menuPosition = _ref.menuPosition,
maxWidth = _ref.maxWidth,
onSelect = _ref.onSelect,
options = _ref.options,
selection = _ref.selection,
hasMenuSpinner = _ref.hasMenuSpinner,
tooltipMenuItemDisabled = _ref.tooltipMenuItemDisabled,
variant = _ref.variant,
isSelected = _ref.isSelected,
assistiveText = _ref.assistiveText,
_ref$inputValue = _ref.inputValue,
inputValue = _ref$inputValue === void 0 ? '' : _ref$inputValue;
var menuMaxWidth = inheritWidthOf === 'menu' ? 'inherit' : undefined;
menuMaxWidth = inheritWidthOf === 'menu' && maxWidth ? maxWidth : menuMaxWidth; // .slds-dropdown sets the menu to absolute positioning, since it has a relative parent. Absolute positioning removes clientHeight and clientWidth which Popper.js needs to absolute position the menu's wrapping div. Absolute positioning an already absolute positioned element doesn't work. Setting the menu's position to relative allows PopperJS to work it's magic.
var menuOptions = options.map(function (optionData, index) {
var active = index === activeOptionIndex && activeOption && (0, _lodash.default)(optionData.id, activeOption.id);
var selected = isSelected({
selection: selection,
option: optionData
}) && (optionData.type !== 'header' || optionData.type === 'footer');
var MenuItem = onRenderMenuItem;
if (optionData.type === 'separator') {
return optionData.label ? /*#__PURE__*/_react.default.createElement("li", {
className: "slds-dropdown__header slds-truncate",
title: optionData.label,
role: "separator",
key: "menu-separator-".concat(optionData.id)
}, /*#__PURE__*/_react.default.createElement("span", {
className: (0, _classnames.default)('slds-listbox__option-header', classNameMenuSubHeader)
}, optionData.label)) : /*#__PURE__*/_react.default.createElement("li", {
className: "slds-has-divider_top-space",
role: "separator",
key: "menu-separator-".concat(optionData.id)
});
}
if (optionData.type === 'header') {
return /*#__PURE__*/_react.default.createElement("li", {
key: "menu-header-".concat(optionData.id, "}"),
role: "presentation",
className: "slds-listbox__item"
}, /*#__PURE__*/_react.default.createElement("div", {
onClick: optionData.disabled ? null : function (event) {
onSelect(event, {
option: optionData
});
},
"aria-selected": active,
id: "".concat(inputId, "-listbox-option-").concat(optionData.id),
className: (0, _classnames.default)('slds-media slds-listbox__option', 'slds-listbox__option_entity slds-listbox__option_term', {
'slds-has-focus': active
}),
role: "option"
}, /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__figure slds-listbox__option-icon"
}, optionData.icon), /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__body"
}, renderLabel(optionData.label, inputValue))));
}
if (optionData.type === 'footer') {
return /*#__PURE__*/_react.default.createElement("li", {
key: "menu-footer-".concat(optionData.id, "}"),
role: "presentation",
className: "slds-listbox__item"
}, /*#__PURE__*/_react.default.createElement("div", {
"aria-selected": active,
onClick: optionData.disabled ? null : function (event) {
onSelect(event, {
option: optionData
});
},
id: "".concat(inputId, "-listbox-option-").concat(optionData.id),
className: (0, _classnames.default)('slds-media slds-listbox__option', 'slds-listbox__option_entity slds-listbox__option_term', {
'slds-has-focus': active
}),
role: "option"
}, /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__figure slds-listbox__option-icon"
}, optionData.icon), /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__body"
}, renderLabel(optionData.label, inputValue))));
}
var disabledProps = {};
var tooltipId = "".concat(inputId, "-listbox-option-help-").concat(optionData.id);
if (optionData.disabled && tooltipMenuItemDisabled && active) {
disabledProps['aria-describedby'] = tooltipId;
}
if (optionData.disabled) {
disabledProps['aria-disabled'] = !!optionData.disabled;
disabledProps.style = {
cursor: 'default'
}; // Replace this with a css class name once SLDS has it.
}
var menuItem = {
'icon-title-subtitle': /*#__PURE__*/_react.default.createElement("span", _extends({
"aria-selected": active
}, disabledProps, {
id: "".concat(inputId, "-listbox-option-").concat(optionData.id),
key: "menu-subtitle-".concat(optionData.id),
className: (0, _classnames.default)('slds-media slds-listbox__option', 'slds-listbox__option_entity slds-listbox__option_has-meta', {
'slds-has-focus': active
}),
onClick: optionData.disabled ? null : function (event) {
onSelect(event, {
option: optionData
});
},
role: "option"
}), optionData.icon && !onRenderMenuItem ? /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__figure"
}, optionData.icon) : null, onRenderMenuItem ? /*#__PURE__*/_react.default.createElement(MenuItem, {
assistiveText: assistiveText,
selected: selected,
option: optionData
}) : /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__body"
}, /*#__PURE__*/_react.default.createElement("span", {
className: (0, _classnames.default)('slds-listbox__option-text', 'slds-listbox__option-text_entity', {
'slds-disabled-text': optionData.disabled
}),
title: optionData.label
}, setBold(optionData.label, inputValue)), /*#__PURE__*/_react.default.createElement("span", {
className: (0, _classnames.default)('slds-listbox__option-meta slds-listbox__option-meta_entity', {
'slds-disabled-text': optionData.disabled
}),
title: optionData.subTitle
}, setBold(optionData.subTitle, inputValue)))),
checkbox: /*#__PURE__*/_react.default.createElement("span", _extends({
// eslint-disable-line jsx-a11y/no-static-element-interactions
"aria-selected": active
}, disabledProps, {
id: "".concat(inputId, "-listbox-option-").concat(optionData.id),
key: "menu-checkbox-".concat(optionData.id),
className: (0, _classnames.default)('slds-media slds-listbox__option', ' slds-listbox__option_plain slds-media_small slds-media_center', {
'slds-has-focus': active,
'slds-is-selected': selected
}),
onClick: optionData.disabled ? null : function (event) {
onSelect(event, {
selection: selection,
option: optionData
});
},
role: "option"
}), /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__figure"
}, /*#__PURE__*/_react.default.createElement(_icon.default, {
className: "slds-listbox__icon-selected",
category: "utility",
name: "check",
size: "x-small"
})), /*#__PURE__*/_react.default.createElement("span", {
className: "slds-media__body"
}, onRenderMenuItem ? /*#__PURE__*/_react.default.createElement(MenuItem, {
assistiveText: assistiveText,
selected: selected,
option: optionData
}) : /*#__PURE__*/_react.default.createElement("span", {
className: (0, _classnames.default)('slds-truncate', {
'slds-disabled-text': optionData.disabled
}),
title: optionData.label
}, selected ? /*#__PURE__*/_react.default.createElement("span", {
className: "slds-assistive-text"
}, assistiveText.optionSelectedInMenu) : null, ' ', optionData.type === 'deselect' ? /*#__PURE__*/_react.default.createElement("em", null, optionData.label) : optionData.label)))
};
var item;
if (optionData.disabled && tooltipMenuItemDisabled) {
var _tooltipMenuItemDisab = tooltipMenuItemDisabled.props,
content = _tooltipMenuItemDisab.content,
userDefinedTooltipProps = _objectWithoutProperties(_tooltipMenuItemDisab, ["content"]);
var tooltipProps = _objectSpread({
align: 'top',
content: optionData.tooltipContent || content,
// either use specific content defined on option or content defined on tooltip component.
id: tooltipId,
position: 'absolute',
silenceTriggerTabbableWarning: true,
triggerStyle: {
width: '100%'
}
}, userDefinedTooltipProps);
if (active) {
// allows showing the tooltip on keyboard navigation to disabled menu item
tooltipProps.isOpen = true;
}
item = /*#__PURE__*/_react.default.cloneElement(tooltipMenuItemDisabled, tooltipProps, menuItem[variant]);
} else {
item = menuItem[variant];
}
return /*#__PURE__*/_react.default.createElement("li", {
className: "slds-listbox__item",
key: "menu-option-".concat(optionData.id),
role: "presentation"
}, item);
});
return /*#__PURE__*/_react.default.createElement("ul", {
className: (0, _classnames.default)('slds-listbox slds-listbox_vertical slds-dropdown slds-dropdown_fluid', {
'slds-dropdown_length-with-icon-5': itemVisibleLength === 5,
'slds-dropdown_length-with-icon-7': itemVisibleLength === 7,
'slds-dropdown_length-with-icon-10': itemVisibleLength === 10
}, classNameMenu),
ref: menuRef,
role: "presentation",
style: {
width: inheritWidthOf === 'menu' ? 'auto' : undefined,
maxWidth: menuMaxWidth,
position: menuPosition !== 'relative' ? 'relative' : undefined
}
}, menuOptions.length ? menuOptions : /*#__PURE__*/_react.default.createElement("li", {
className: "slds-listbox__item slds-listbox__status",
role: "status",
"aria-live": "polite"
}, /*#__PURE__*/_react.default.createElement("span", {
className: "slds-m-left_x-large slds-p-vertical_medium"
}, labels.noOptionsFound)), hasMenuSpinner && /*#__PURE__*/_react.default.createElement("li", {
role: "presentation",
className: "slds-listbox__item"
}, /*#__PURE__*/_react.default.createElement("div", {
className: "slds-align_absolute-center slds-p-top_medium"
}, /*#__PURE__*/_react.default.createElement(_spinner.default, {
assistiveText: {
label: assistiveText.loadingMenuItems
},
hasContainer: false,
isInline: true,
size: "x-small"
}))));
};
Menu.displayName = 'Menu';
Menu.propTypes = propTypes;
var _default = Menu;
exports.default = _default;