@expressivecss/expressive 0.15.0 → 0.16.0

package/dist/js/chunks/chunk-CMGXGYUC.mjs

@@ -0,0 +1,74 @@
+import {
+  Utils,
+  controllerFor
+} from "./chunk-ZVLOUDIJ.mjs";
+
+// src/ts/core/component.ts
+var Component = class {
+  /**
+   * Destroys any instance already on `el`, then spreads `options` over the
+   * class defaults, and `options.i18n` over the default strings, so passing
+   * one string keeps the rest. A subclass passes options it reads from
+   * markup in `options`.
+   */
+  constructor(el, options) {
+    if (!(el instanceof HTMLElement)) {
+      console.error(Error(el + " is not an HTML Element"));
+    }
+    new.target.getInstance(el)?.destroy();
+    this.el = el;
+    const defaults = new.target.defaults;
+    const i18n = defaults.i18n && { i18n: { ...defaults.i18n, ...options?.i18n } };
+    this.options = { ...defaults, ...options, ...i18n };
+    this._events = controllerFor(el);
+    el[new.target.key] = this;
+  }
+  static init(els, options = {}) {
+    const create = (el) => new this(el, options);
+    if (els instanceof Element) return create(els);
+    return els ? Array.from(els, create) : null;
+  }
+  /**
+   * @returns default options for component instance.
+   */
+  static get defaults() {
+    return {};
+  }
+  /**
+   * Retrieves the instance of the class it is called on for the given element.
+   * @param el Associated HTML Element.
+   */
+  static getInstance(el) {
+    return el[this.key];
+  }
+  /**
+   * Runs an `on…` option callback, then fires `expressive:<type>` from the
+   * element, so pages can listen instead of passing options. The callback gets
+   * `args` (the element by default) and the event carries `detail`.
+   *
+   * A callback or listener may close, reopen or destroy the component. Pass
+   * `current` to tell whether the state `type` names still holds; the event
+   * is skipped once it does not, or once the instance is destroyed, and the
+   * result says whether to carry on.
+   */
+  _notify(type, callback, { args = [this.el], detail, current = () => true } = {}) {
+    const live = () => this.constructor.getInstance(this.el) === this && current();
+    if (typeof callback === "function") callback.apply(this, args);
+    if (!live()) return false;
+    Utils.emit(this.el, type, detail);
+    return live();
+  }
+  /**
+   * Destroy plugin instance and teardown. A subclass tears down its own state
+   * and calls this to remove its listeners and release the element.
+   */
+  destroy() {
+    this._events.abort();
+    this.el[this.constructor.key] = void 0;
+  }
+};
+
+export {
+  Component
+};
+//# sourceMappingURL=chunk-CMGXGYUC.mjs.map

package/dist/js/chunks/chunk-CMGXGYUC.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/ts/core/component.ts"],
+  "sourcesContent": ["import { Utils, controllerFor } from './utils';\n\n/**\n * Base options for component initialization.\n */\nexport interface BaseOptions {}\n\nexport type InitElement = HTMLElement | Element;\nexport type InitElements<T extends InitElement> = NodeListOf<T> | HTMLCollectionOf<T>;\n/** Any component class; `init` reads its element, options and instance types. */\ntype ComponentClass = (new (el: never, options: never) => Component<BaseOptions>) & { key: string };\n/** The element a component class is constructed on. */\ntype ElementOf<C extends ComponentClass> = C extends new (el: infer E, options: never) => unknown ? E : never;\n/** The options `init` accepts for a component class. */\ntype InitOptions<C extends ComponentClass> = Partial<InstanceType<C>['options']>;\n\nexport interface I18nOptions {\n  cancel: string;\n  clear: string;\n  done: string;\n}\n\n/** What {@link Component._notify} passes on, and when it stops. */\nexport interface NotifyOptions {\n  args?: unknown[];\n  detail?: unknown;\n  current?: () => boolean;\n}\n\n/**\n * Base class implementation for Expressive components.\n */\nexport class Component<O extends BaseOptions> {\n  /**\n   * The element property that holds an instance, `Expressive_<Name>`, so page\n   * code can read `el.Expressive_Tabs` as well as call `Tabs.getInstance(el)`.\n   */\n  static key: string;\n  /**\n   * The DOM element the plugin was initialized with.\n   */\n  el: HTMLElement;\n  /**\n   * The options the instance was initialized with.\n   */\n  options: O;\n  /** Aborted by destroy(), which removes every listener added with its signal. */\n  protected _events: AbortController;\n\n  /**\n   * Destroys any instance already on `el`, then spreads `options` over the\n   * class defaults, and `options.i18n` over the default strings, so passing\n   * one string keeps the rest. A subclass passes options it reads from\n   * markup in `options`.\n   */\n  constructor(el: HTMLElement, options: Partial<O>) {\n    // Display error if el is not a valid HTML Element\n    if (!(el instanceof HTMLElement)) {\n      console.error(Error(el + ' is not an HTML Element'));\n    }\n    new.target.getInstance(el)?.destroy();\n    this.el = el;\n    const defaults: Partial<O> & { i18n?: object } = new.target.defaults;\n    const i18n: object = defaults.i18n && { i18n: { ...defaults.i18n, ...(options as typeof defaults)?.i18n } };\n    this.options = { ...defaults, ...options, ...i18n } as O;\n    this._events = controllerFor(el);\n    el[new.target.key] = this;\n  }\n\n  /**\n   * Initializes an instance of the class it is called on.\n   * @param el HTML element.\n   * @param options Component options.\n   */\n  static init<C extends ComponentClass>(this: C, el: ElementOf<C>, options?: InitOptions<C>): InstanceType<C>;\n  /**\n   * Initializes an instance of the class it is called on for each element.\n   * @param els HTML elements.\n   * @param options Component options.\n   */\n  static init<C extends ComponentClass>(\n    this: C,\n    els: InitElements<InitElement>,\n    options?: InitOptions<C>\n  ): InstanceType<C>[];\n  static init<C extends ComponentClass>(\n    this: C,\n    els: ElementOf<C> | InitElements<InitElement>,\n    options: InitOptions<C> = {}\n  ): InstanceType<C> | InstanceType<C>[] {\n    const create = (el: unknown) => new this(el as never, options as never) as InstanceType<C>;\n    if (els instanceof Element) return create(els);\n    return els ? Array.from(els as InitElements<InitElement>, create) : null;\n  }\n\n  /**\n   * @returns default options for component instance.\n   */\n  static get defaults(): BaseOptions {\n    return {};\n  }\n\n  /**\n   * Retrieves the instance of the class it is called on for the given element.\n   * @param el Associated HTML Element.\n   */\n  static getInstance<C extends ComponentClass>(this: C, el: HTMLElement): InstanceType<C> {\n    return el[this.key];\n  }\n\n  /**\n   * Runs an `on\u2026` option callback, then fires `expressive:<type>` from the\n   * element, so pages can listen instead of passing options. The callback gets\n   * `args` (the element by default) and the event carries `detail`.\n   *\n   * A callback or listener may close, reopen or destroy the component. Pass\n   * `current` to tell whether the state `type` names still holds; the event\n   * is skipped once it does not, or once the instance is destroyed, and the\n   * result says whether to carry on.\n   */\n  protected _notify(\n    type: string,\n    callback?: Function | null,\n    { args = [this.el], detail, current = () => true }: NotifyOptions = {}\n  ): boolean {\n    const live = () => (this.constructor as typeof Component).getInstance(this.el) === this && current();\n    if (typeof callback === 'function') callback.apply(this, args);\n    if (!live()) return false;\n    Utils.emit(this.el, type, detail);\n    return live();\n  }\n\n  /**\n   * Destroy plugin instance and teardown. A subclass tears down its own state\n   * and calls this to remove its listeners and release the element.\n   */\n  destroy(): void {\n    this._events.abort();\n    this.el[(this.constructor as typeof Component).key] = undefined;\n  }\n}\n"],
+  "mappings": ";;;;;;AAgCO,IAAM,YAAN,MAAuC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuB5C,YAAY,IAAiB,SAAqB;AAEhD,QAAI,EAAE,cAAc,cAAc;AAChC,cAAQ,MAAM,MAAM,KAAK,yBAAyB,CAAC;AAAA,IACrD;AACA,eAAW,YAAY,EAAE,GAAG,QAAQ;AACpC,SAAK,KAAK;AACV,UAAM,WAA2C,WAAW;AAC5D,UAAM,OAAe,SAAS,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,MAAM,GAAI,SAA6B,KAAK,EAAE;AAC1G,SAAK,UAAU,EAAE,GAAG,UAAU,GAAG,SAAS,GAAG,KAAK;AAClD,SAAK,UAAU,cAAc,EAAE;AAC/B,OAAG,WAAW,GAAG,IAAI;AAAA,EACvB;AAAA,EAkBA,OAAO,KAEL,KACA,UAA0B,CAAC,GACU;AACrC,UAAM,SAAS,CAAC,OAAgB,IAAI,KAAK,IAAa,OAAgB;AACtE,QAAI,eAAe,QAAS,QAAO,OAAO,GAAG;AAC7C,WAAO,MAAM,MAAM,KAAK,KAAkC,MAAM,IAAI;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,WAAwB;AACjC,WAAO,CAAC;AAAA,EACV;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,YAA+C,IAAkC;AACtF,WAAO,GAAG,KAAK,GAAG;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYU,QACR,MACA,UACA,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,QAAQ,UAAU,MAAM,KAAK,IAAmB,CAAC,GAC5D;AACT,UAAM,OAAO,MAAO,KAAK,YAAiC,YAAY,KAAK,EAAE,MAAM,QAAQ,QAAQ;AACnG,QAAI,OAAO,aAAa,WAAY,UAAS,MAAM,MAAM,IAAI;AAC7D,QAAI,CAAC,KAAK,EAAG,QAAO;AACpB,UAAM,KAAK,KAAK,IAAI,MAAM,MAAM;AAChC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAgB;AACd,SAAK,QAAQ,MAAM;AACnB,SAAK,GAAI,KAAK,YAAiC,GAAG,IAAI;AAAA,EACxD;AACF;",
+  "names": []
+}