@enact/limestone 1.3.0

package/Picker/Picker.js

@@ -0,0 +1,389 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.PickerBase = exports.Picker = void 0;
+var _classnames2 = _interopRequireDefault(require("classnames"));
+var _kind = _interopRequireDefault(require("@enact/core/kind"));
+var _util = require("@enact/core/util");
+var _Changeable = _interopRequireDefault(require("@enact/ui/Changeable"));
+var _Pure = _interopRequireDefault(require("@enact/ui/internal/Pure"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _react = require("react");
+var _Heading = _interopRequireDefault(require("../Heading"));
+var _Picker = _interopRequireWildcard(require("../internal/Picker"));
+var _validators = require("../internal/validators");
+var _Marquee = require("../Marquee");
+var _PickerModule = _interopRequireDefault(require("./Picker.module.css"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["children", "css", "inlineTitle", "max", "title", "value", "voiceLabel"];
+/**
+ * A component for selecting values from a list of values.
+ *
+ * @example
+ * <Picker>
+ * 	{['A', 'B', 'C']}
+ * </Picker>
+ *
+ * @module limestone/Picker
+ * @exports Picker
+ * @exports PickerBase
+ */
+/**
+ * The base `Picker` component.
+ *
+ * This version is not {@link spotlight/Spottable.Spottable|spottable}.
+ *
+ * @class PickerBase
+ * @memberof limestone/Picker
+ * @ui
+ * @public
+ */
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : 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(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+var PickerBase = exports.PickerBase = (0, _kind["default"])({
+  name: 'Picker',
+  propTypes: /** @lends limestone/Picker.PickerBase.prototype */{
+    /**
+     * Picker value list.
+     *
+     * @type {Node}
+     * @required
+     * @public
+     */
+    children: _propTypes["default"].node.isRequired,
+    /**
+     * The `aria-valuetext` for the picker.
+     *
+     * By default, `aria-valuetext` is set to the current selected child text.
+     *
+     * @type {String}
+     * @memberof limestone/Picker.PickerBase.prototype
+     * @public
+     */
+    'aria-valuetext': _propTypes["default"].string,
+    /**
+     * Determines which key to adjust the picker's value for the joined horizontal one.
+     *
+     *  * `'enter'` allows the user to use the enter key to adjust the picker's value
+     *  * `'arrow'` allows the user to use the left or right keys to adjust the picker's value.
+     *
+     * The default value for joined horizontal picker is `'enter'`.
+     * If {@link limestone/Picker.PickerBase.orientation|orientation} is `'vertical'` or
+     * {@link limestone/Picker.PickerBase.joined|joined} is undefined or is `false`, this prop is ignored.
+     *
+     * @type {('enter'|'arrow')}
+     * @public
+     */
+    changedBy: _propTypes["default"].oneOf(['enter', 'arrow']),
+    /**
+     * 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:
+     *
+     * * `title` - The title component class
+     * * `inlineTitle` - The title component class when `inlineTitle` is true
+     *
+     * @type {Object}
+     * @public
+     */
+    css: _propTypes["default"].object,
+    /**
+     * The voice control labels for the `children`.
+     *
+     * By default, `data-webos-voice-labels-ext` is generated from `children`. However, if
+     * `children` is not an array of numbers or strings, `data-webos-voice-labels-ext` should be
+     * set to an array of labels.
+     *
+     * @type {Number[]|String[]}
+     * @memberof limestone/Picker.PickerBase.prototype
+     * @public
+     */
+    'data-webos-voice-labels-ext': _propTypes["default"].oneOfType([_propTypes["default"].arrayOf(_propTypes["default"].number), _propTypes["default"].arrayOf(_propTypes["default"].string)]),
+    /**
+     * A custom icon for the decrementer.
+     *
+     * All strings supported by {@link limestone/Icon.Icon|Icon} are supported. Without a
+     * custom icon, the default is used, and is automatically changed when the
+     * {@link limestone/Picker.PickerBase.orientation|orientation} is changed.
+     *
+     * @type {String}
+     * @public
+     */
+    decrementIcon: _propTypes["default"].string,
+    /**
+     * Disables the picker.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    disabled: _propTypes["default"].bool,
+    /**
+     * A custom icon for the incrementer.
+     *
+     * All strings supported by {@link limestone/Icon.Icon|Icon} are supported. Without a
+     * custom icon, the default is used, and is automatically changed when the
+     * {@link limestone/Picker.PickerBase.orientation|orientation} is changed.
+     *
+     * @type {String}
+     * @public
+     */
+    incrementIcon: _propTypes["default"].string,
+    /**
+     * Applies inline styling to the title.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    inlineTitle: _propTypes["default"].bool,
+    /**
+     * Allows the user to use the arrow keys or enter key to adjust the picker's value.
+     *
+     * Key presses are captured in the directions of the increment and decrement buttons but
+     * others are unaffected. A non-joined Picker allows navigation in any direction, but
+     * requires individual ENTER presses on the incrementer and decrementer buttons. Pointer
+     * interaction is the same for both formats.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    joined: _propTypes["default"].bool,
+    /**
+     * Disables marqueeing of items.
+     *
+     * By default, each picker item is wrapped by a
+     * {@link limestone/Marquee.Marquee|Marquee}. When this is set, the items will
+     * not be wrapped.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    marqueeDisabled: _propTypes["default"].bool,
+    /**
+     * Disables transition animation.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    noAnimation: _propTypes["default"].bool,
+    /**
+     * Called when the `value` changes.
+     *
+     * @type {Function}
+     * @public
+     */
+    onChange: _propTypes["default"].func,
+    /**
+     * Orientation of the picker.
+     *
+     * Controls whether the buttons are arranged horizontally or vertically around the value.
+     *
+     * @type {('horizontal'|'vertical')}
+     * @public
+     */
+    orientation: _propTypes["default"].oneOf(['horizontal', 'vertical']),
+    /**
+     * When `true`, the picker buttons operate in the reverse direction such that pressing
+     * up/left decrements the value and down/right increments the value. This is more natural
+     * for vertical lists of text options where "up" implies a spatial change rather than
+     * incrementing the value.
+     *
+     * If this prop is omitted, it will be determined by `orientation`.
+     * For example, if `orientation` is `vertical`, `reverse` is `true`.
+     * Conversely, if `orientation` is `horizontal`, `reverse` is `false`.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    reverse: _propTypes["default"].bool,
+    /**
+     * The primary text of the `Picker`.
+     *
+     * The screen readers read out the title text when the `joined` prop is false
+     *
+     * @type {String}
+     * @public
+     */
+    title: _propTypes["default"].string,
+    /**
+     * The type of picker. It determines the aria-label for the next and previous buttons.
+     *
+     * Depending on the `type`, `joined`, `decrementAriaLabel`, and `incrementAriaLabel`,
+     * the screen readers read out differently when Spotlight is on the next button, the previous button,
+     * or the picker itself.
+     *
+     * For example, if Spotlight is on the next button, the `joined` prop is false,
+     * and aria label props(`decrementAriaLabel` and `incrementAriaLabel`) are not defined,
+     * then the screen readers read out as follows.
+     *	`'string'` type: `'next item'`
+     * 	`'number'` type: `'press ok button to increase the value'`
+     *
+     * @type {('number'|'string')}
+     * @default 'string'
+     * @public
+     */
+    type: _propTypes["default"].oneOf(['number', 'string']),
+    /**
+     * Index of the selected child.
+     *
+     * @type {Number}
+     * @default 0
+     * @public
+     */
+    value: _propTypes["default"].number,
+    /**
+     * The width of the picker.
+     *
+     * A number can be used to set the minimum number of characters to be shown. Setting a
+     * number to less than the number of characters in the longest value will cause the width to
+     * grow for the longer values.
+     *
+     * A string can be used to select from pre-defined widths:
+     * * `'small'` - numeric values
+     * * `'medium'` - single or short words
+     * * `'large'` - maximum-sized pickers taking full width of its parent
+     *
+     * By default, the picker will size according to the longest valid value.
+     *
+     * @type {('small'|'medium'|'large'|Number)}
+     * @public
+     */
+    width: _propTypes["default"].oneOfType([_propTypes["default"].oneOf([null, 'small', 'medium', 'large']), _propTypes["default"].number]),
+    /**
+     * Allows picker to continue from the start of the list after it reaches the end and
+     * vice versa.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    wrap: _propTypes["default"].bool
+  },
+  defaultProps: {
+    type: 'string',
+    value: 0
+  },
+  styles: {
+    css: _PickerModule["default"],
+    publicClassNames: ['inlineTitle', 'title']
+  },
+  computed: {
+    max: function max(_ref) {
+      var children = _ref.children;
+      return children && children.length ? children.length - 1 : 0;
+    },
+    reverse: function reverse(_ref2) {
+      var orientation = _ref2.orientation,
+        _reverse = _ref2.reverse;
+      return typeof _reverse === 'boolean' ? _reverse : orientation === 'vertical';
+    },
+    children: function children(_ref3) {
+      var _children = _ref3.children,
+        disabled = _ref3.disabled,
+        joined = _ref3.joined,
+        marqueeDisabled = _ref3.marqueeDisabled;
+      return _react.Children.map(_children, function (child) {
+        var focusOrHover = !disabled && joined ? 'focus' : 'hover';
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerItem, {
+          marqueeDisabled: marqueeDisabled,
+          marqueeOn: focusOrHover,
+          children: child
+        });
+      });
+    },
+    disabled: function disabled(_ref4) {
+      var children = _ref4.children,
+        _disabled = _ref4.disabled;
+      return _react.Children.count(children) > 1 ? _disabled : true;
+    },
+    value: function value(_ref5) {
+      var _value = _ref5.value,
+        children = _ref5.children;
+      var max = children && children.length ? children.length - 1 : 0;
+      if (process.env.NODE_ENV !== "production") {
+        (0, _validators.validateRange)(_value, 0, max, 'Picker', 'value', 'min', 'max index');
+      }
+      return (0, _util.clamp)(0, max, _value);
+    },
+    voiceLabel: function voiceLabel(_ref6) {
+      var children = _ref6.children,
+        voiceLabelsExt = _ref6['data-webos-voice-labels-ext'];
+      var voiceLabel;
+      if (voiceLabelsExt) {
+        voiceLabel = voiceLabelsExt;
+      } else {
+        voiceLabel = _react.Children.map(children, function (child) {
+          return typeof child === 'number' || typeof child === 'string' ? child : '';
+        });
+      }
+      return JSON.stringify(voiceLabel);
+    }
+  },
+  render: function render(_ref7) {
+    var children = _ref7.children,
+      css = _ref7.css,
+      inlineTitle = _ref7.inlineTitle,
+      max = _ref7.max,
+      title = _ref7.title,
+      value = _ref7.value,
+      voiceLabel = _ref7.voiceLabel,
+      rest = _objectWithoutProperties(_ref7, _excluded);
+    delete rest.marqueeDisabled;
+    return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+      children: [title ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading["default"], {
+        css: css,
+        className: (0, _classnames2["default"])(css.title, _defineProperty({}, css.inlineTitle, inlineTitle)),
+        marqueeOn: "hover",
+        children: title
+      }) : null, /*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker["default"], _objectSpread(_objectSpread({}, rest), {}, {
+        "data-webos-voice-labels-ext": voiceLabel,
+        min: 0,
+        max: max,
+        index: value,
+        step: 1,
+        title: title,
+        value: value,
+        children: children
+      }))]
+    });
+  }
+});
+
+/**
+ * A Picker component that allows selecting values from a list of values.
+ *
+ * By default, `Picker` maintains the state of its `value` property. Supply the `defaultValue`
+ * property to control its initial value. If you wish to directly control updates to the component,
+ * supply a value to `value` at creation time and update it in response to `onChange` events.
+ *
+ * @class Picker
+ * @memberof limestone/Picker
+ * @extends limestone/Picker.PickerBase
+ * @mixes ui/Changeable.Changeable
+ * @mixes limestone/Marquee.MarqueeController
+ * @ui
+ * @public
+ */
+var Picker = exports.Picker = (0, _Pure["default"])((0, _Changeable["default"])((0, _Marquee.MarqueeController)({
+  marqueeOnFocus: true
+}, PickerBase)));
+
+/**
+ * Default index of the selected child.
+ *
+ * *Note*: Changing `defaultValue` after initial render has no effect.
+ *
+ * @name defaultValue
+ * @memberof limestone/Picker.Picker.prototype
+ * @type {Number}
+ * @public
+ */
+var _default = exports["default"] = Picker;

package/Picker/Picker.module.css

@@ -0,0 +1,46 @@
+.title {
+  margin-left: 1.875rem;
+  margin-right: var(--primitive-spacing-24);
+}
+:global(.enact-locale-right-to-left) .title {
+  margin-left: var(--primitive-spacing-24);
+  margin-right: 1.875rem;
+}
+.title.inlineTitle {
+  display: inline-block;
+  max-width: 10rem;
+  line-height: 1.5rem;
+  padding-bottom: 0;
+  margin-bottom: 0;
+}
+.heading:global(.neutral).tiny {
+  color: var(--semantic-color-on-background-main);
+}
+:global(.enact-a11y-high-contrast) .heading:global(.neutral):global(.highContrast).tiny {
+  color: var(--semantic-color-on-background-main);
+}
+.heading:global(.light).tiny {
+  color: var(--semantic-color-on-background-main);
+}
+.heading:global(.game) {
+  --semantic-color-surface-default: #2d224c;
+  --semantic-color-surface-default-focused: #6d2fa1;
+  --semantic-color-on-surface-main-focused: #e6e6e6;
+}
+.heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-main);
+}
+:global(.green) .heading:global(.game) {
+  --semantic-color-surface-default: #1F2C24;
+  --semantic-color-surface-default-focused: #3ea07d;
+}
+:global(.green) .heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-main);
+}
+:global(.orange) .heading:global(.game) {
+  --semantic-color-surface-default: #422923;
+  --semantic-color-surface-default-focused: #b85f23;
+}
+:global(.orange) .heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-main);
+}

package/Picker/package.json

@@ -0,0 +1,3 @@
+{
+    "main": "Picker.js"
+}

package/Picker/tests/Picker-specs.js

@@ -0,0 +1,91 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _Picker = require("../Picker");
+var _jsxRuntime = require("react/jsx-runtime");
+describe('Picker Specs', function () {
+  test('should render selected child wrapped with <PickerItem/>', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.Picker, {
+      value: 1,
+      children: [1, 2, 3, 4]
+    }));
+    var pickerText = _react.screen.getByText('2').parentElement.parentElement;
+    var expected = 'item';
+    expect(pickerText).toHaveClass(expected);
+  });
+  test('should set the max of <Picker> to be one less than the number of children', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.Picker, {
+      value: 3,
+      children: [1, 2, 3, 4]
+    }));
+    var arrowForward = _react.screen.getAllByRole('button')[0];
+    var expectedValue = 'true';
+    var expectedAttribute = 'aria-disabled';
+    expect(arrowForward).toHaveAttribute(expectedAttribute, expectedValue);
+  });
+  test('should be disabled when empty', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerBase, {
+      "data-testid": "picker",
+      children: []
+    }));
+    var picker = _react.screen.getByTestId('picker');
+    var expected = 'disabled';
+    expect(picker).toHaveAttribute(expected);
+  });
+  test('should set \'data-webos-voice-disabled\' to decrement button when voice control is disabled', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerBase, {
+      "data-webos-voice-disabled": true,
+      children: [1, 2, 3, 4]
+    }));
+    var decrementButton = _react.screen.getAllByRole('button')[1];
+    var expected = 'data-webos-voice-disabled';
+    expect(decrementButton).toHaveAttribute(expected);
+  });
+  test('should set \'data-webos-voice-disabled\' to increment button when voice control is disabled', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerBase, {
+      "data-webos-voice-disabled": true,
+      children: [1, 2, 3, 4]
+    }));
+    var incrementButton = _react.screen.getAllByRole('button')[0];
+    var expected = 'data-webos-voice-disabled';
+    expect(incrementButton).toHaveAttribute(expected);
+  });
+  test('should have a heading element when \'title\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerBase, {
+      title: "title text",
+      children: [1, 2, 3, 4]
+    }));
+    var heading = _react.screen.getByText('title text');
+    var expected = 'heading';
+    var actual = heading.parentElement.parentElement;
+    expect(heading).toBeInTheDocument();
+    expect(actual).toHaveClass(expected);
+  });
+  test('should have a heading element with inline class when \'title\' and \'inlineTitle\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.PickerBase, {
+      inlineTitle: true,
+      title: "title text",
+      children: [1, 2, 3, 4]
+    }));
+    var heading = _react.screen.getByText('title text');
+    var expectedInline = 'inlineTitle';
+    var expectedHeader = 'heading';
+    var actual = heading.parentElement.parentElement;
+    expect(heading).toBeInTheDocument();
+    expect(actual).toHaveClass(expectedInline);
+    expect(actual).toHaveClass(expectedHeader);
+  });
+  test('should stringify custom voice control labels and set to \'data-webos-voice-labels-ext\'', function () {
+    var options = ['Option 1', 'The second one', 'This is the third option', '4'];
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Picker.Picker, {
+      "data-webos-voice-labels-ext": options,
+      inlineTitle: true,
+      title: "title text",
+      children: [1, 2, 3, 4]
+    }));
+    var picker = _react.screen.getAllByRole('button')[0].parentElement;
+    var expected = "[\"Option 1\",\"The second one\",\"This is the third option\",\"4\"]";
+    expect(picker).toHaveAttribute('data-webos-voice-labels-ext', expected);
+  });
+});