etudes 1.2.0 → 2.1.0

package/lib/AbstractSelectableCollection.d.ts

@@ -1,94 +0,0 @@
-import { CSSProperties, PureComponent } from 'react';
-export interface Props {
-    /**
-     * Class attribute of the root element.
-     */
-    className?: string;
-    /**
-     * Inline style attribute of the root element.
-     */
-    style?: CSSProperties;
-    /**
-     * Indicates whether selections can be toggled. For example, in the case of
-     * a vertical list of selectable rows, being able to toggle a row means it
-     * gets deselected when selected again. Being unable to toggle the row means
-     * it does not get deselected when selected again.
-     */
-    isTogglable?: boolean;
-    /**
-     * Indicates whether selections are retained. For example, in the case of
-     * a vertical list of clickable rows, being able to retain a selection means
-     * when the row is clicked, it becomes and stays selected. Being unable to
-     * retain a selection means when the row is clicked, it does not become
-     * selected. It is simply clicked and the subsequent event is dispatched.
-     */
-    shouldStaySelected?: boolean;
-    /**
-     * The default selected index. Any value below 0 indicates that nothing is
-     * selected.
-     */
-    defaultSelectedIndex?: number;
-    /**
-     * Handler invoked when an index is deselected.
-     */
-    onDeselectAt?: (index: number) => void;
-    /**
-     * Handler invoked when an index is selected.
-     */
-    onSelectAt?: (index: number) => void;
-}
-export interface State {
-    /**
-     * The current selected index. Any value less than 0 indicates that no index
-     * is selected.
-     */
-    selectedIndex?: number;
-}
-/**
- * An abstract component that mimics and handles index selection in an abstract
- * collection.
- */
-export default class AbstractSelectableCollection<P extends Props = Props, S extends State = State> extends PureComponent<P, S> {
-    constructor(props: P);
-    componentDidMount(): void;
-    componentDidUpdate(prevProps: P, prevState: S): void;
-    render(): JSX.Element;
-    /**
-     * Checks if an index is out of range.
-     *
-     * @param index - The index to check.
-     *
-     * @returns `true` if the index is out of range, `false` otherwise.
-     */
-    isIndexOutOfRange(index: number): boolean;
-    /**
-     * Checks if an index is selected.
-     *
-     * @param index - The index to check.
-     *
-     * @returns `true` if the index is selected, `false` otherwise.
-     */
-    isSelectedAt(index: number): boolean;
-    /**
-     * Toggles an index, i.e. reverses its selected state.
-     *
-     * @param index - The index to toggle.
-     */
-    toggleAt(index: number): void;
-    /**
-     * Selects an index.
-     *
-     * @param index - The index to select.
-     */
-    selectAt(index: number): void;
-    /**
-     * Deselects an index if it is currently selected.
-     *
-     * @param index - The index to deselect.
-     */
-    deselectAt(index: number): void;
-    /**
-     * Deselects the currently selected index.
-     */
-    deselectCurrent(): void;
-}

package/lib/AbstractSelectableCollection.js

@@ -1,151 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importStar(require("react"));
-var debug = process.env.NODE_ENV === 'development' ? require('debug')('etudes:asc') : function () { };
-/**
- * An abstract component that mimics and handles index selection in an abstract
- * collection.
- */
-var AbstractSelectableCollection = /** @class */ (function (_super) {
-    __extends(AbstractSelectableCollection, _super);
-    function AbstractSelectableCollection(props) {
-        var _this = this;
-        var _a;
-        _this = _super.call(this, props) || this;
-        _this.state = {
-            selectedIndex: (_a = _this.props.defaultSelectedIndex) !== null && _a !== void 0 ? _a : -1,
-        };
-        return _this;
-    }
-    AbstractSelectableCollection.prototype.componentDidMount = function () {
-        var _a, _b, _c;
-        if (this.state.selectedIndex !== undefined && this.state.selectedIndex > -1) {
-            (_b = (_a = this.props).onSelectAt) === null || _b === void 0 ? void 0 : _b.call(_a, (_c = this.state.selectedIndex) !== null && _c !== void 0 ? _c : -1);
-        }
-    };
-    AbstractSelectableCollection.prototype.componentDidUpdate = function (prevProps, prevState) {
-        var _a, _b;
-        var _c = this.props, shouldStaySelected = _c.shouldStaySelected, onSelectAt = _c.onSelectAt, onDeselectAt = _c.onDeselectAt;
-        var prevSelectedIndex = (_a = prevState.selectedIndex) !== null && _a !== void 0 ? _a : -1;
-        var selectedIndex = (_b = this.state.selectedIndex) !== null && _b !== void 0 ? _b : -1;
-        if (prevState.selectedIndex !== selectedIndex) {
-            debug("Selected index changed: ".concat(selectedIndex));
-            if (shouldStaySelected === true) {
-                if (!this.isIndexOutOfRange(prevSelectedIndex))
-                    onDeselectAt === null || onDeselectAt === void 0 ? void 0 : onDeselectAt(prevSelectedIndex);
-                if (!this.isIndexOutOfRange(selectedIndex))
-                    onSelectAt === null || onSelectAt === void 0 ? void 0 : onSelectAt(selectedIndex);
-            }
-        }
-    };
-    AbstractSelectableCollection.prototype.render = function () {
-        return react_1.default.createElement(react_1.Fragment, null);
-    };
-    /**
-     * Checks if an index is out of range.
-     *
-     * @param index - The index to check.
-     *
-     * @returns `true` if the index is out of range, `false` otherwise.
-     */
-    AbstractSelectableCollection.prototype.isIndexOutOfRange = function (index) {
-        if (index < 0)
-            return true;
-        return false;
-    };
-    /**
-     * Checks if an index is selected.
-     *
-     * @param index - The index to check.
-     *
-     * @returns `true` if the index is selected, `false` otherwise.
-     */
-    AbstractSelectableCollection.prototype.isSelectedAt = function (index) {
-        return (this.state.selectedIndex === index);
-    };
-    /**
-     * Toggles an index, i.e. reverses its selected state.
-     *
-     * @param index - The index to toggle.
-     */
-    AbstractSelectableCollection.prototype.toggleAt = function (index) {
-        if (this.props.isTogglable === true && this.isSelectedAt(index)) {
-            this.deselectAt(index);
-        }
-        else {
-            this.selectAt(index);
-        }
-    };
-    /**
-     * Selects an index.
-     *
-     * @param index - The index to select.
-     */
-    AbstractSelectableCollection.prototype.selectAt = function (index) {
-        if (this.props.shouldStaySelected === true) {
-            if (this.isSelectedAt(index))
-                return;
-            this.setState({ selectedIndex: index });
-        }
-        else if (this.props.onSelectAt) {
-            this.props.onSelectAt(index);
-        }
-    };
-    /**
-     * Deselects an index if it is currently selected.
-     *
-     * @param index - The index to deselect.
-     */
-    AbstractSelectableCollection.prototype.deselectAt = function (index) {
-        if (!this.isSelectedAt(index))
-            return;
-        this.setState({ selectedIndex: -1 });
-    };
-    /**
-     * Deselects the currently selected index.
-     */
-    AbstractSelectableCollection.prototype.deselectCurrent = function () {
-        this.setState({ selectedIndex: -1 });
-    };
-    return AbstractSelectableCollection;
-}(react_1.PureComponent));
-exports.default = AbstractSelectableCollection;
-//# sourceMappingURL=AbstractSelectableCollection.js.map

package/lib/AbstractSelectableCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AbstractSelectableCollection.js","sourceRoot":"/","sources":["AbstractSelectableCollection.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAqE;AAErE,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAO,CAAC,CAAA;AAuDhG;;;GAGG;AACH;IAA4G,gDAAmB;IAC7H,sCAAY,KAAQ;QAApB,iBAMC;;gBALC,kBAAM,KAAK,CAAC;QAEZ,KAAI,CAAC,KAAK,GAAG;YACX,aAAa,EAAE,MAAA,KAAI,CAAC,KAAK,CAAC,oBAAoB,mCAAI,CAAC,CAAC;SAC9C,CAAA;;IACV,CAAC;IAED,wDAAiB,GAAjB;;QACE,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE;YAC3E,MAAA,MAAA,IAAI,CAAC,KAAK,EAAC,UAAU,mDAAG,MAAA,IAAI,CAAC,KAAK,CAAC,aAAa,mCAAI,CAAC,CAAC,CAAC,CAAA;SACxD;IACH,CAAC;IAED,yDAAkB,GAAlB,UAAmB,SAAY,EAAE,SAAY;;QACrC,IAAA,KAAmD,IAAI,CAAC,KAAK,EAA3D,kBAAkB,wBAAA,EAAE,UAAU,gBAAA,EAAE,YAAY,kBAAe,CAAA;QACnE,IAAM,iBAAiB,GAAG,MAAA,SAAS,CAAC,aAAa,mCAAI,CAAC,CAAC,CAAA;QACvD,IAAM,aAAa,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,aAAa,mCAAI,CAAC,CAAC,CAAA;QAEpD,IAAI,SAAS,CAAC,aAAa,KAAK,aAAa,EAAE;YAC7C,KAAK,CAAC,kCAA2B,aAAa,CAAE,CAAC,CAAA;YAEjD,IAAI,kBAAkB,KAAK,IAAI,EAAE;gBAC/B,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;oBAAE,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,iBAAiB,CAAC,CAAA;gBACjF,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC;oBAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAG,aAAa,CAAC,CAAA;aACxE;SACF;IACH,CAAC;IAED,6CAAM,GAAN;QACE,OAAO,8BAAC,gBAAQ,OAAE,CAAA;IACpB,CAAC;IAED;;;;;;OAMG;IACH,wDAAiB,GAAjB,UAAkB,KAAa;QAC7B,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAA;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,mDAAY,GAAZ,UAAa,KAAa;QACxB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,KAAK,KAAK,CAAC,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACH,+CAAQ,GAAR,UAAS,KAAa;QACpB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YAC/D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;SACvB;aACI;YACH,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;SACrB;IACH,CAAC;IAED;;;;OAIG;IACH,+CAAQ,GAAR,UAAS,KAAa;QACpB,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,KAAK,IAAI,EAAE;YAC1C,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;gBAAE,OAAM;YACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAA;SACxC;aACI,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YAC9B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;SAC7B;IACH,CAAC;IAED;;;;OAIG;IACH,iDAAU,GAAV,UAAW,KAAa;QACtB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;YAAE,OAAM;QACrC,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;IACtC,CAAC;IAED;;OAEG;IACH,sDAAe,GAAf;QACE,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;IACtC,CAAC;IACH,mCAAC;AAAD,CAAC,AAtGD,CAA4G,qBAAa,GAsGxH","sourcesContent":["import React, { CSSProperties, Fragment, PureComponent } from 'react'\n\nconst debug = process.env.NODE_ENV === 'development' ? require('debug')('etudes:asc') : () => {}\n\nexport interface Props {\n  /**\n   * Class attribute of the root element.\n   */\n  className?: string\n\n  /**\n   * Inline style attribute of the root element.\n   */\n  style?: CSSProperties\n\n  /**\n   * Indicates whether selections can be toggled. For example, in the case of\n   * a vertical list of selectable rows, being able to toggle a row means it\n   * gets deselected when selected again. Being unable to toggle the row means\n   * it does not get deselected when selected again.\n   */\n  isTogglable?: boolean\n\n  /**\n   * Indicates whether selections are retained. For example, in the case of\n   * a vertical list of clickable rows, being able to retain a selection means\n   * when the row is clicked, it becomes and stays selected. Being unable to\n   * retain a selection means when the row is clicked, it does not become\n   * selected. It is simply clicked and the subsequent event is dispatched.\n   */\n  shouldStaySelected?: boolean\n\n  /**\n   * The default selected index. Any value below 0 indicates that nothing is\n   * selected.\n   */\n  defaultSelectedIndex?: number\n\n  /**\n   * Handler invoked when an index is deselected.\n   */\n  onDeselectAt?: (index: number) => void\n\n  /**\n   * Handler invoked when an index is selected.\n   */\n  onSelectAt?: (index: number) => void\n}\n\nexport interface State {\n  /**\n   * The current selected index. Any value less than 0 indicates that no index\n   * is selected.\n   */\n  selectedIndex?: number\n}\n\n/**\n * An abstract component that mimics and handles index selection in an abstract\n * collection.\n */\nexport default class AbstractSelectableCollection<P extends Props = Props, S extends State = State> extends PureComponent<P, S> {\n  constructor(props: P) {\n    super(props)\n\n    this.state = {\n      selectedIndex: this.props.defaultSelectedIndex ?? -1,\n    } as any\n  }\n\n  componentDidMount() {\n    if (this.state.selectedIndex !== undefined && this.state.selectedIndex > -1) {\n      this.props.onSelectAt?.(this.state.selectedIndex ?? -1)\n    }\n  }\n\n  componentDidUpdate(prevProps: P, prevState: S) {\n    const { shouldStaySelected, onSelectAt, onDeselectAt } = this.props\n    const prevSelectedIndex = prevState.selectedIndex ?? -1\n    const selectedIndex = this.state.selectedIndex ?? -1\n\n    if (prevState.selectedIndex !== selectedIndex) {\n      debug(`Selected index changed: ${selectedIndex}`)\n\n      if (shouldStaySelected === true) {\n        if (!this.isIndexOutOfRange(prevSelectedIndex)) onDeselectAt?.(prevSelectedIndex)\n        if (!this.isIndexOutOfRange(selectedIndex)) onSelectAt?.(selectedIndex)\n      }\n    }\n  }\n\n  render() {\n    return <Fragment/>\n  }\n\n  /**\n   * Checks if an index is out of range.\n   *\n   * @param index - The index to check.\n   *\n   * @returns `true` if the index is out of range, `false` otherwise.\n   */\n  isIndexOutOfRange(index: number): boolean {\n    if (index < 0) return true\n    return false\n  }\n\n  /**\n   * Checks if an index is selected.\n   *\n   * @param index - The index to check.\n   *\n   * @returns `true` if the index is selected, `false` otherwise.\n   */\n  isSelectedAt(index: number): boolean {\n    return (this.state.selectedIndex === index)\n  }\n\n  /**\n   * Toggles an index, i.e. reverses its selected state.\n   *\n   * @param index - The index to toggle.\n   */\n  toggleAt(index: number) {\n    if (this.props.isTogglable === true && this.isSelectedAt(index)) {\n      this.deselectAt(index)\n    }\n    else {\n      this.selectAt(index)\n    }\n  }\n\n  /**\n   * Selects an index.\n   *\n   * @param index - The index to select.\n   */\n  selectAt(index: number) {\n    if (this.props.shouldStaySelected === true) {\n      if (this.isSelectedAt(index)) return\n      this.setState({ selectedIndex: index })\n    }\n    else if (this.props.onSelectAt) {\n      this.props.onSelectAt(index)\n    }\n  }\n\n  /**\n   * Deselects an index if it is currently selected.\n   *\n   * @param index - The index to deselect.\n   */\n  deselectAt(index: number) {\n    if (!this.isSelectedAt(index)) return\n    this.setState({ selectedIndex: -1 })\n  }\n\n  /**\n   * Deselects the currently selected index.\n   */\n  deselectCurrent() {\n    this.setState({ selectedIndex: -1 })\n  }\n}\n"]}

package/lib/types/index.d.ts

@@ -1,7 +0,0 @@
-import { FlattenSimpleInterpolation } from 'styled-components';
-export declare type ExtendedCSSFunction<P = Record<string, never>> = (props: P) => FlattenSimpleInterpolation;
-export declare type ExtendedCSSProps<P = Record<string, never>> = Readonly<{
-    extendedCSS: ExtendedCSSFunction<P>;
-}>;
-export declare type Range = Readonly<[number, number]>;
-export declare type Orientation = 'horizontal' | 'vertical';

package/lib/types/index.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"/","sources":["types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { FlattenSimpleInterpolation } from 'styled-components'\n\nexport type ExtendedCSSFunction<P = Record<string, never>> = (props: P) => FlattenSimpleInterpolation\n\nexport type ExtendedCSSProps<P = Record<string, never>> = Readonly<{ extendedCSS: ExtendedCSSFunction<P> }>\n\nexport type Range = Readonly<[number, number]>\n\nexport type Orientation = 'horizontal' | 'vertical'\n"]}