@salesforce/design-system-react
Version:
Salesforce Lightning Design System for React
375 lines (320 loc) • 14.1 kB
JavaScript
function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
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); }
function _objectWithoutProperties(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]; } 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 _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved */
/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */
// # Pill Component
// Implements the [Pill design pattern](https://lightningdesignsystem.com/components/pills/) in React.
import React from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';
import { PILL } from '../../utilities/constants';
import UtilityIcon from '../utilities/utility-icon';
import KEYS from '../../utilities/key-code';
import EventUtil from '../../utilities/event'; // This component's `checkProps` which issues warnings to developers about properties when in development mode (similar to React's built in development tools)
import checkProps from './check-props';
import componentDoc from './docs.json';
var propTypes = {
/**
* **Assistive text for accessibility**
* This object is merged with the default props object on every render.
* * `remove`: This is a visually hidden label for the close button.
* _Tested with snapshot testing._
*/
assistiveText: PropTypes.shape({
remove: PropTypes.string
}),
/**
* SLDSAvatar component to show on the left of the pill.
* _Tested with Mocha framework._
*/
avatar: PropTypes.element,
/**
* Applies the bare style to the component.
* _Tested with Mocha framework._
*/
bare: PropTypes.bool,
/**
* This is a way to specify custom contents for the pill in the case a simple text label is not enough.
* _Tested with Mocha framework._
*/
children: PropTypes.node,
/**
* CSS classes to be added to tag with `.slds-pill`. Uses `classNames` [API](https://github.com/JedWatson/classnames).
* _Tested with Mocha framework._
*/
className: PropTypes.oneOfType([PropTypes.array, PropTypes.object, PropTypes.string]),
/**
* Applies the error style to the component.
* _Tested with Mocha framework._
*/
hasError: PropTypes.bool,
/**
* An href to use if the pill is shown as a link.
* _Tested with Mocha framework._
*/
href: PropTypes.string,
/**
* SLDSIcon component to show on the left of the pill.
* _Tested with Mocha framework._
*/
icon: PropTypes.element,
/**
* **Text labels for internationalization**
* This object is merged with the default props object on every render.
* * `label`: Pill's label.
* * `title`: Pill's title.
* * `removeTitle`: A title to use for the remove icon.
*
* _Tested with snapshot testing._
*/
labels: PropTypes.shape({
label: PropTypes.string,
title: PropTypes.string,
removeTitle: PropTypes.string
}),
/**
* `onBlur` callback executes when the component loses focus.
* _Tested with Mocha framework._
*/
onBlur: PropTypes.func,
/**
* `onClick` callback executes when a user clicks on the pill or presses the Enter key.
* _Tested with Mocha framework._
*/
onClick: PropTypes.func,
/**
* `onFocus` callback executes when the component receives focus.
* _Tested with Mocha framework._
*/
onFocus: PropTypes.func,
/**
* `onKeyDown` callback executes when a user presses a key.
* _Tested with Mocha framework._
*/
onKeyDown: PropTypes.func,
/**
* `onRemove` callback executes when a user clicks on the pill's remove icon or presses the delete or the backspace keys.
* _Tested with Mocha framework._
*/
onRemove: PropTypes.func,
/**
* A variant of a pill
* _Tested with Mocha framework._
*/
variant: PropTypes.oneOf(['link', 'option'])
};
/**
* A pill represents an object that can be viewed with or without an icon.
*/
var Pill =
/*#__PURE__*/
function (_React$Component) {
_inherits(Pill, _React$Component);
function Pill() {
var _ref;
var _temp, _this;
_classCallCheck(this, Pill);
for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
return _possibleConstructorReturn(_this, (_temp = _this = _possibleConstructorReturn(this, (_ref = Pill.__proto__ || Object.getPrototypeOf(Pill)).call.apply(_ref, [this].concat(args))), Object.defineProperty(_assertThisInitialized(_this), "getHref", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
return typeof _this.props.href === 'string' ? _this.props.href : 'javascript:void(0);';
}
}), Object.defineProperty(_assertThisInitialized(_this), "blur", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
_this.root.blur();
}
}), Object.defineProperty(_assertThisInitialized(_this), "focus", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
_this.root.focus();
}
}), Object.defineProperty(_assertThisInitialized(_this), "handleKeyDown", {
configurable: true,
enumerable: true,
writable: true,
value: function value(event) {
if (typeof _this.props.onKeyDown === 'function') {
var _this$props$onKeyDown;
for (var _len2 = arguments.length, rest = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
rest[_key2 - 1] = arguments[_key2];
}
// Make a callback to onKeyDown.
(_this$props$onKeyDown = _this.props.onKeyDown).call.apply(_this$props$onKeyDown, [null, event].concat(rest)); // Cancel further handling if the default handling for the event was prevented.
if (event.defaultPrevented) {
return;
}
}
switch (event.keyCode) {
case KEYS.ENTER:
if (typeof _this.props.onClick === 'function') {
EventUtil.trap(event);
_this.props.onClick();
}
break;
case KEYS.BACKSPACE:
case KEYS.DELETE:
if (typeof _this.props.onRemove === 'function') {
EventUtil.trap(event);
_this.props.onRemove();
}
break;
default:
break;
}
}
}), Object.defineProperty(_assertThisInitialized(_this), "handleRef", {
configurable: true,
enumerable: true,
writable: true,
value: function value(root) {
// Keeping the top-most element to support focus() and blur()
_this.root = root;
}
}), Object.defineProperty(_assertThisInitialized(_this), "restProps", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
var _this$props = _this.props,
bare = _this$props.bare,
hasError = _this$props.hasError,
variant = _this$props.variant,
className = _this$props.className,
onClick = _this$props.onClick,
onRemove = _this$props.onRemove,
labels = _this$props.labels,
assistiveText = _this$props.assistiveText,
children = _this$props.children,
href = _this$props.href,
icon = _this$props.icon,
avatar = _this$props.avatar,
onKeyDown = _this$props.onKeyDown,
other = _objectWithoutProperties(_this$props, ["bare", "hasError", "variant", "className", "onClick", "onRemove", "labels", "assistiveText", "children", "href", "icon", "avatar", "onKeyDown"]);
return other;
}
}), Object.defineProperty(_assertThisInitialized(_this), "renderIcon", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
var icon = _this.props.icon || _this.props.avatar;
if (icon) {
return React.createElement("span", {
className: "slds-pill__icon_container"
}, icon);
}
return null;
}
}), Object.defineProperty(_assertThisInitialized(_this), "renderLabel", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
if (_this.props.labels.label) {
if (_this.props.variant === 'link') {
return React.createElement("a", {
href: _this.getHref(),
className: "slds-pill__action",
title: _this.props.labels.title || _this.props.labels.label,
onClick: _this.props.onClick
}, React.createElement("span", {
className: "slds-pill__label"
}, _this.props.labels.label));
}
return React.createElement("span", {
className: "slds-pill__label",
title: _this.props.labels.title || _this.props.labels.label
}, _this.props.labels.label);
}
return _this.props.children;
}
}), Object.defineProperty(_assertThisInitialized(_this), "renderRemoveIcon", {
configurable: true,
enumerable: true,
writable: true,
value: function value() {
if (typeof _this.props.onRemove === 'function') {
return React.createElement("span", {
// eslint-disable-line jsx-a11y/interactive-supports-focus
className: "slds-icon_container slds-pill__remove",
title: _this.props.labels.removeTitle,
role: "button",
onClick: _this.props.onRemove
}, React.createElement(UtilityIcon, {
style: {
cursor: 'pointer'
} // remove when fixed by SLDS CSS
,
category: "utility",
className: "slds-icon slds-icon--x-small slds-icon-text-default",
name: "close"
}), React.createElement("span", {
className: "slds-assistive-text"
}, _this.props.assistiveText.remove || _this.props.labels.removeTitle));
}
return null;
}
}), _temp));
}
_createClass(Pill, [{
key: "componentWillMount",
value: function componentWillMount() {
checkProps(PILL, componentDoc);
}
}, {
key: "render",
value: function render() {
var role;
switch (this.props.variant) {
case 'link':
role = 'button';
break;
case 'option':
role = 'option';
break;
default:
}
return (
/* eslint-disable jsx-a11y/no-static-element-interactions */
React.createElement("span", _extends({}, this.restProps(), {
role: role,
className: classNames('slds-pill', {
'slds-pill_link': this.props.variant === 'link',
'slds-has-error': this.props.hasError,
'slds-pill_bare': this.props.bare
}, this.props.className),
onClick: !this.props.labels.label || this.props.variant !== 'link' ? this.props.onClick : null,
onKeyDown: typeof this.props.onRemove === 'function' ? this.handleKeyDown : null,
ref: this.handleRef
}), this.renderIcon(), this.renderLabel(), this.renderRemoveIcon())
);
}
}]);
return Pill;
}(React.Component);
Pill.displayName = PILL;
Pill.defaultProps = {
variant: 'link',
labels: {},
assistiveText: {}
};
Pill.propTypes = propTypes;
export default Pill;
//# sourceMappingURL=index.js.map