@enact/limestone 1.3.0

package/Heading/Heading.js

@@ -0,0 +1,203 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.HeadingDecorator = exports.HeadingBase = exports.Heading = void 0;
+var _kind = _interopRequireDefault(require("@enact/core/kind"));
+var _Pure = _interopRequireDefault(require("@enact/ui/internal/Pure"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _compose = _interopRequireDefault(require("ramda/src/compose"));
+var _Heading = require("@enact/ui/Heading");
+var _Marquee = require("../Marquee");
+var _Skinnable = _interopRequireDefault(require("../Skinnable"));
+var _HeadingModule = _interopRequireDefault(require("./Heading.module.css"));
+var _excluded = ["css"];
+/**
+ * Limestone styled labeled Heading components and behaviors
+ *
+ * @example
+ * <Heading
+ *   size="large"
+ *   spacing="small"
+ * >
+ *   A Content Section Heading
+ * </Heading>
+ *
+ * @module limestone/Heading
+ * @exports Heading
+ * @exports HeadingBase
+ * @exports HeadingDecorator
+ */
+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; }
+/**
+ * A labeled Heading component.
+ *
+ * This component is most often not used directly but may be composed within another component as it
+ * is within {@link limestone/Heading.Heading|Heading}.
+ *
+ * @class HeadingBase
+ * @memberof limestone/Heading
+ * @ui
+ * @public
+ */
+var HeadingBase = exports.HeadingBase = (0, _kind["default"])({
+  name: 'Heading',
+  propTypes: /** @lends limestone/Heading.HeadingBase.prototype */{
+    /**
+     * 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:
+     *
+     * * `heading` - The root component class
+     * * `title` - Applied when `size` is set to "title"
+     * * `subtitle` - Applied when `size` is set to "subtitle"
+     * * `large` - Applied when `size` is set to "large"
+     * * `medium` - Applied when `size` is set to "medium"
+     * * `small` - Applied when `size` is set to "small"
+     * * `tiny` - Applied when `size` is set to "tiny"
+     * * `largeSpacing` - Applied when `spacing` is set to "large"
+     * * `mediumSpacing` - Applied when `spacing` is set to "medium"
+     * * `smallSpacing` - Applied when `spacing` is set to "small"
+     * * `noneSpacing` - Applied when `spacing` is set to "none"
+     *
+     * @type {Object}
+     * @public
+     */
+    css: _propTypes["default"].object,
+    /**
+     * Adds a horizontal-rule (line) under the component
+     *
+     * @type {Boolean}
+     * @public
+     */
+    showLine: _propTypes["default"].bool,
+    /**
+     * Set the size of the component.
+     *
+     * If the `spacing` prop is not set (defaulting to "auto"), these values automatically set
+     * the spacing to the correlated names.
+     *
+     * @type {('large'|'medium'|'small'|'tiny')}
+     * @default 'tiny'
+     * @public
+     */
+    size: _propTypes["default"].oneOf(['large', 'medium', 'small', 'tiny']),
+    /**
+     * The size for slotBefore and slotAfter.
+     * This size is used for remeasuring marquee metrics for Panels.Header.
+     *
+     * @type {String}
+     * @private
+     */
+    slotSize: _propTypes["default"].string,
+    /**
+     * The size of the spacing around the Heading.
+     *
+     * Allowed values include:
+     * * `'auto'` - Value is based on the `size` prop for automatic usage.
+     * * `'large'` - Specifically assign the `'large'` spacing.
+     * * `'medium'` - Specifically assign the `'medium'` spacing.
+     * * `'small'` - Specifically assign the `'small'` spacing.
+     * * `'none'` - No spacing at all. Neighboring elements will directly touch the Heading.
+     *
+     * @type {('auto'|'large'|'medium'|'small'|'none')}
+     * @default 'none'
+     * @public
+     */
+    spacing: _propTypes["default"].oneOf(['auto', 'large', 'medium', 'small', 'none'])
+  },
+  defaultProps: {
+    size: 'tiny',
+    spacing: 'none'
+  },
+  styles: {
+    css: _HeadingModule["default"],
+    className: 'heading',
+    publicClassNames: true
+  },
+  computed: {
+    className: function className(_ref) {
+      var showLine = _ref.showLine,
+        styler = _ref.styler;
+      return styler.append({
+        showLine: showLine
+      });
+    }
+  },
+  render: function render(_ref2) {
+    var css = _ref2.css,
+      rest = _objectWithoutProperties(_ref2, _excluded);
+    delete rest.showLine;
+    delete rest.slotSize;
+    return _Heading.HeadingBase.inline(_objectSpread({
+      css: css
+    }, rest));
+  }
+});
+
+/**
+ * Applies Limestone specific behaviors to {@link limestone/Heading.HeadingBase|HeadingBase}.
+ *
+ * @hoc
+ * @memberof limestone/Heading
+ * @mixes limestone/Marquee.MarqueeDecorator
+ * @mixes limestone/Skinnable.Skinnable
+ * @public
+ */
+var HeadingDecorator = exports.HeadingDecorator = (0, _compose["default"])(_Pure["default"], (0, _Marquee.MarqueeDecorator)({
+  invalidateProps: ['remeasure', 'slotSize']
+}), _Skinnable["default"]);
+
+/**
+ * A labeled Heading component, ready to use in Limestone applications.
+ *
+ * `Heading` may be used as a header to group related components.
+ *
+ * Usage:
+ * ```
+ * <Heading
+ *   spacing="medium"
+ * >
+ *   Related Settings
+ * </Heading>
+ * <CheckboxItem>A Setting</CheckboxItem>
+ * <CheckboxItem>A Second Setting</CheckboxItem>
+ * ```
+ *
+ * @class Heading
+ * @memberof limestone/Heading
+ * @extends limestone/Heading.HeadingBase
+ * @mixes limestone/Heading.HeadingDecorator
+ * @ui
+ * @public
+ */
+var Heading = exports.Heading = HeadingDecorator(HeadingBase);
+
+/**
+ * Marquee animation trigger.
+ *
+ * Allowed values include:
+ * * `'hover'` - Marquee begins when the pointer enters the component
+ * * `'render'` - Marquee begins when the component is rendered
+ *
+ * @name marqueeOn
+ * @type {('hover'|'render')}
+ * @default 'render'
+ * @memberof limestone/Heading.Heading.prototype
+ * @see {@link limestone/Marquee.Marquee}
+ * @public
+ */
+
+Heading.defaultProps = {
+  marqueeOn: 'render'
+};
+var _default = exports["default"] = Heading;

package/Heading/Heading.module.css

@@ -0,0 +1,217 @@
+.heading {
+  margin: 0 var(--primitive-spacing-24) var(--primitive-spacing-36);
+  padding: 0;
+  letter-spacing: 0;
+  font-style: normal;
+  line-height: 1.25em;
+}
+:global(.enact-locale-non-italic) .heading {
+  font-style: normal;
+}
+:global(.enact-locale-km) .heading {
+  line-height: 1.5em;
+}
+:global(.enact-locale-si) .heading {
+  line-height: 1.5em;
+}
+:global(.enact-locale-th) .heading {
+  line-height: 1.5em;
+}
+:global(.enact-locale-vi) .heading {
+  line-height: 1.5em;
+}
+.heading.large,
+.heading.medium,
+.heading.small,
+.heading.tiny {
+  border-bottom: 1px solid transparent;
+}
+.heading.title {
+  font-family: "Limestone";
+  line-height: 1.3em;
+  font-weight: var(--primitive-font-weight-semibold);
+  font-size: 2.25rem;
+  font-kerning: normal;
+}
+:global(.enact-locale-non-latin) .heading.title {
+  font-family: "Limestone";
+}
+:global(.enact-locale-km) .heading.title {
+  line-height: 1.5em;
+}
+:global(.enact-locale-si) .heading.title {
+  line-height: 1.5em;
+}
+:global(.enact-locale-th) .heading.title {
+  line-height: 1.5em;
+}
+:global(.enact-locale-vi) .heading.title {
+  line-height: 1.5em;
+}
+:global(.enact-locale-km) .heading.title {
+  font-size: 2.375rem;
+}
+:global(.enact-locale-si) .heading.title {
+  font-size: 2.375rem;
+}
+:global(.enact-locale-th) .heading.title {
+  font-size: 2.375rem;
+}
+:global(.enact-locale-vi) .heading.title {
+  font-size: 2.375rem;
+}
+.heading.subtitle {
+  font-family: "Limestone";
+  line-height: 1.3em;
+  font-weight: var(--primitive-font-weight-regular);
+  font-size: 1.125rem;
+}
+:global(.enact-locale-non-latin) .heading.subtitle {
+  font-family: "Limestone";
+}
+:global(.enact-locale-km) .heading.subtitle {
+  line-height: 1.5em;
+}
+:global(.enact-locale-si) .heading.subtitle {
+  line-height: 1.5em;
+}
+:global(.enact-locale-th) .heading.subtitle {
+  line-height: 1.5em;
+}
+:global(.enact-locale-vi) .heading.subtitle {
+  line-height: 1.5em;
+}
+:global(.enact-locale-km) .heading.subtitle {
+  font-size: 1rem;
+}
+:global(.enact-locale-si) .heading.subtitle {
+  font-size: 1rem;
+}
+:global(.enact-locale-th) .heading.subtitle {
+  font-size: 1rem;
+}
+:global(.enact-locale-vi) .heading.subtitle {
+  font-size: 1rem;
+}
+.heading.large {
+  font-family: "Limestone";
+  font-weight: var(--primitive-font-weight-semibold);
+  font-size: 1.5rem;
+}
+.heading.medium {
+  font-family: "Limestone";
+  font-weight: var(--primitive-font-weight-semibold);
+  font-size: 1.375rem;
+}
+.heading.small {
+  font-family: "Limestone";
+  font-weight: var(--primitive-font-weight-semibold);
+  font-size: 1.125rem;
+}
+.heading.tiny {
+  margin: var(--primitive-spacing-36) var(--primitive-spacing-24);
+  font-family: "Limestone";
+  font-weight: var(--primitive-font-weight-semibold);
+  font-size: 1rem;
+}
+.heading.titleSpacing {
+  margin-bottom: 0;
+}
+.heading.subtitleSpacing {
+  margin-bottom: 0;
+}
+.heading.largeSpacing {
+  margin-bottom: 1.60417rem;
+  min-height: 1.60417rem;
+}
+.heading.mediumSpacing {
+  margin-bottom: 0.85417rem;
+  min-height: 0.85417rem;
+}
+.heading.smallSpacing {
+  margin-bottom: calc(var(--primitive-spacing-36) - 1px );
+  min-height: 0.35417rem;
+}
+.heading.noneSpacing {
+  margin-bottom: 0;
+  min-height: 0;
+}
+.heading:global(.neutral) {
+  color: var(--semantic-color-on-background-main);
+}
+.heading:global(.neutral).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+.heading:global(.neutral).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+.heading:global(.neutral).showLine {
+  border-bottom-color: var(--semantic-color-on-background-main);
+}
+:global(.enact-a11y-high-contrast) .heading:global(.neutral):global(.highContrast) {
+  color: var(--semantic-color-on-background-main);
+}
+:global(.enact-a11y-high-contrast) .heading:global(.neutral):global(.highContrast).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+:global(.enact-a11y-high-contrast) .heading:global(.neutral):global(.highContrast).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+:global(.enact-a11y-high-contrast) .heading:global(.neutral):global(.highContrast).showLine {
+  border-bottom-color: var(--semantic-color-on-background-main);
+}
+.heading:global(.light) {
+  color: var(--semantic-color-on-background-main);
+}
+.heading:global(.light).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+.heading:global(.light).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+.heading:global(.light).showLine {
+  border-bottom-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;
+  color: var(--semantic-color-on-background-main);
+}
+.heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+.heading:global(.game).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+.heading:global(.game).showLine {
+  border-bottom-color: #8151ff;
+}
+:global(.green) .heading:global(.game) {
+  --semantic-color-surface-default: #1F2C24;
+  --semantic-color-surface-default-focused: #3ea07d;
+  color: var(--semantic-color-on-background-main);
+}
+:global(.green) .heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+:global(.green) .heading:global(.game).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+:global(.green) .heading:global(.game).showLine {
+  border-bottom-color: #3e6354;
+}
+:global(.orange) .heading:global(.game) {
+  --semantic-color-surface-default: #422923;
+  --semantic-color-surface-default-focused: #b85f23;
+  color: var(--semantic-color-on-background-main);
+}
+:global(.orange) .heading:global(.game).tiny {
+  color: var(--semantic-color-on-background-heading);
+}
+:global(.orange) .heading:global(.game).subtitle {
+  color: var(--semantic-color-on-background-sub);
+}
+:global(.orange) .heading:global(.game).showLine {
+  border-bottom-color: #ea5e00;
+}

package/Heading/package.json

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

package/Heading/tests/Heading-specs.js

@@ -0,0 +1,57 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _Heading = require("../Heading");
+var _jsxRuntime = require("react/jsx-runtime");
+describe('Heading Specs', function () {
+  test('should render a Heading with content', function () {
+    var content = 'Hello Heading!';
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading.HeadingBase, {
+      "data-testid": "heading",
+      children: content
+    }));
+    var heading = _react.screen.getByTestId('heading').textContent;
+    expect(heading).toBe(content);
+  });
+  test('should add the showLine class', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading.HeadingBase, {
+      "data-testid": "heading",
+      showLine: true,
+      children: "check"
+    }));
+    var heading = _react.screen.getByTestId('heading');
+    var expected = 'showLine';
+    expect(heading).toHaveClass(expected);
+  });
+  test('should have large class if `size` is large', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading.HeadingBase, {
+      "data-testid": "heading",
+      size: "large",
+      children: "Hello Heading"
+    }));
+    var heading = _react.screen.getByTestId('heading');
+    var expected = 'large';
+    expect(heading).toHaveClass(expected);
+  });
+  test('should have small class if `size` is small', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading.HeadingBase, {
+      "data-testid": "heading",
+      size: "small",
+      children: "Hello Heading"
+    }));
+    var heading = _react.screen.getByTestId('heading');
+    var expected = 'small';
+    expect(heading).toHaveClass(expected);
+  });
+  test('should have tiny class if `size` is tiny', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Heading.HeadingBase, {
+      "data-testid": "heading",
+      size: "tiny",
+      children: "Hello Heading"
+    }));
+    var heading = _react.screen.getByTestId('heading');
+    var expected = 'tiny';
+    expect(heading).toHaveClass(expected);
+  });
+});