@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
301 lines (297 loc) • 11.9 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = exports.ToggleItemDecorator = exports.ToggleItemBase = exports.ToggleItem = void 0;
var _deprecate = _interopRequireDefault(require("@enact/core/internal/deprecate"));
var _propTypes = _interopRequireDefault(require("@enact/core/internal/prop-types"));
var _kind = _interopRequireDefault(require("@enact/core/kind"));
var _propTypes2 = _interopRequireDefault(require("prop-types"));
var _compose = _interopRequireDefault(require("ramda/src/compose"));
var _react = require("react");
var _ComponentOverride = _interopRequireDefault(require("../ComponentOverride"));
var _ForwardRef = _interopRequireDefault(require("../ForwardRef"));
var _Toggleable = _interopRequireDefault(require("../Toggleable"));
var _Touchable = _interopRequireDefault(require("../Touchable"));
var _ToggleItemModule = _interopRequireDefault(require("./ToggleItem.module.css"));
var _jsxRuntime = require("react/jsx-runtime");
var _excluded = ["component", "componentRef", "css", "children", "selected"];
/**
* Unstyled toggle item components and behaviors.
*
* This is not intended to be used directly, but should be extended by a component that will
* customize this component's appearance by supplying an
* {@link ui/ToggleItem.ToggleItemBase.iconComponent|iconComponent} prop.
*
* @module ui/ToggleItem
* @exports ToggleItem
* @exports ToggleItemBase
* @exports ToggleItemDecorator
* @deprecated Will be removed in 5.0.0.
*/
// eslint-disable-next-line enact/display-name,enact/prop-types
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
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; }
var iconCreator = function iconCreator(position) {
return function (_ref) {
var disabled = _ref.disabled,
icon = _ref.icon,
iconComponent = _ref.iconComponent,
iconPosition = _ref.iconPosition,
itemIcon = _ref.itemIcon,
itemIconPosition = _ref.itemIconPosition,
selected = _ref.selected;
if (position === 'before') {
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_react.Fragment, {
children: [itemIconPosition === 'before' && itemIcon, iconPosition === 'before' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_ComponentOverride["default"], {
component: iconComponent,
disabled: disabled,
selected: selected,
children: icon
}) : null, itemIconPosition === 'beforeChildren' && itemIcon]
});
} else {
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_react.Fragment, {
children: [itemIconPosition === 'afterChildren' && itemIcon, iconPosition === 'after' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_ComponentOverride["default"], {
component: iconComponent,
disabled: disabled,
selected: selected,
children: icon
}) : null, itemIconPosition === 'after' && itemIcon]
});
}
};
};
/**
* A minimally styled toggle item without any behavior, ripe for extension.
*
* @class ToggleItemBase
* @memberof ui/ToggleItem
* @ui
* @public
*/
var ToggleItemBase = exports.ToggleItemBase = (0, _kind["default"])({
name: 'ui:ToggleItem',
propTypes: /** @lends ui/ToggleItem.ToggleItemBase.prototype */{
/**
* The main content of the toggle item.
*
* @type {Node}
* @required
* @public
*/
children: _propTypes2["default"].node.isRequired,
/**
* The type of component to use to render as root element.
*
* This receives the `css` prop for theme extension and therefore must be a custom
* component and not a simple HTML DOM node. Recommended component or themed
* derivative: {@link ui/SlotItem.SlotItem|SlotItem}
*
* @type {Component}
* @required
* @public
*/
component: _propTypes["default"].component.isRequired,
/**
* The `Icon` to render in this item.
*
* This component receives the `selected` prop and value,
* and must therefore respond to it in some way. It is recommended to use
* {@link ui/ToggleIcon|ToggleIcon} for this.
*
* @type {Component|Element}
* @required
* @public
*/
iconComponent: _propTypes["default"].componentOverride.isRequired,
/**
* Called with a reference to the root component.
*
* When using {@link ui/ToggleItem.ToggleItem}, the `ref` prop is forwarded to this
* component as `componentRef`.
*
* @type {Object|Function}
* @public
*/
componentRef: _propTypes["default"].ref,
/**
* Customizes the component by mapping the supplied collection of CSS class names to the
* corresponding internal elements and states of this component.
*
* The following classes are supported:
*
* * `toggleItem` - The root class name
*
* @type {Object}
* @public
*/
css: _propTypes2["default"].object,
/**
* Applies a disabled visual state to the toggle item.
*
* @type {Boolean}
* @default false
* @public
*/
disabled: _propTypes2["default"].bool,
/**
* An optional prop that lets you override the icon of the `iconComponent` component.
*
* This accepts any string that the {@link ui/Icon.Icon|Icon} component supports, provided
* the recommendations of `iconComponent` are followed.
*
* @type {String|Object}
* @public
*/
icon: _propTypes2["default"].oneOfType([_propTypes2["default"].string, _propTypes2["default"].object]),
/**
* Specifies on which side (`'before'` or `'after'`) of `children` the icon appears.
*
* @type {('before'|'after')}
* @default 'before'
* @public
*/
iconPosition: _propTypes2["default"].oneOf(['before', 'after']),
/**
* An additional customizable icon component.
*
* Supports more granular positioning rules. This should only be used *after* specifying the
* `icon` property, as the positioning for this offers the ability to place this in front of
* or behind the existing `icon`. See `itemIconPosition` for options.
*
* @type {Node}
* @public
*/
itemIcon: _propTypes2["default"].node,
/**
* Specifies where `itemIcon` appears.
*
* * `'before'` - first element in the item
* * `'beforeChildren'` - before `children`. If `iconPosition` is `'before'`, `icon` will be
* before `itemIcon`
* * `'afterChildren'` - after `children`. If iconPosition` is `'after'`, `icon` will be
* after `itemIcon`
* * `'after'` - the last element in the item
*
* @type {('before'|'beforeChildren'|'afterChildren'|'after')}
* @default 'afterChildren'
* @public
*/
itemIconPosition: _propTypes2["default"].oneOf(['before', 'beforeChildren', 'afterChildren', 'after']),
/**
* Called when the toggle item is toggled. Developers should generally use `onToggle` instead.
*
* @type {Function}
* @public
*/
onTap: _propTypes2["default"].func,
/**
* Called when the toggle item is toggled.
*
* @type {Function}
* @param {Object} event
* @param {String} event.selected - Selected value of item.
* @param {*} event.value - Value passed from `value` prop.
* @public
*/
onToggle: _propTypes2["default"].func,
/**
* Applies the provided `icon`.
*
* @type {Boolean}
* @default false
* @public
*/
selected: _propTypes2["default"].bool,
/**
* The value that will be sent to the `onToggle` handler.
*
* @type {*}
* @default null
* @public
*/
value: _propTypes2["default"].any
},
defaultProps: {
disabled: false,
iconPosition: 'before',
itemIconPosition: 'afterChildren',
selected: false,
value: null
},
styles: {
css: _ToggleItemModule["default"],
className: 'toggleItem',
publicClassNames: true
},
computed: {
slotBefore: iconCreator('before'),
slotAfter: iconCreator('after')
},
render: (0, _deprecate["default"])(function (_ref2) {
var Component = _ref2.component,
componentRef = _ref2.componentRef,
css = _ref2.css,
children = _ref2.children,
selected = _ref2.selected,
rest = _objectWithoutProperties(_ref2, _excluded);
delete rest.iconComponent;
delete rest.iconPosition;
delete rest.itemIcon;
delete rest.itemIconPosition;
delete rest.value;
return /*#__PURE__*/(0, _jsxRuntime.jsx)(Component, _objectSpread(_objectSpread({
ref: componentRef,
role: "checkbox"
}, rest), {}, {
css: css,
"aria-checked": selected,
children: children
}));
}, {
name: 'ui/ToggleItem',
until: '5.0.0'
})
});
/**
* Adds interactive functionality to `ToggleItemBase`.
*
* @class ToggleItemDecorator
* @memberof ui/ToggleItem
* @mixes ui/ForwardRef.ForwardRef
* @mixes ui/Touchable.Touchable
* @mixes ui/Toggleable.Toggleable
* @hoc
* @public
*/
var ToggleItemDecorator = exports.ToggleItemDecorator = (0, _compose["default"])((0, _ForwardRef["default"])({
prop: 'componentRef'
}), (0, _Toggleable["default"])({
toggleProp: 'onTap',
eventProps: ['value']
}), _Touchable["default"]);
/**
* An unstyled item with built-in support for toggling.
*
* Example:
* ```
* <ToggleItem icon="lock" iconPosition="before">Toggle Me</ToggleItem>
* ```
*
* @class ToggleItem
* @memberof ui/ToggleItem
* @extends ui/ToggleItem.ToggleItemBase
* @mixes ui/ToggleItem.ToggleItemDecorator
* @omit componentRef
* @ui
* @public
*/
var ToggleItem = exports.ToggleItem = ToggleItemDecorator(ToggleItemBase);
var _default = exports["default"] = ToggleItem;