@substrate-system/input 0.0.19 → 0.0.20

package/LICENSE

@@ -6,11 +6,15 @@ Version 2.0.2
 
 ## Purpose
 
-These terms let you use and share this software for noncommercial purposes and in small business for free, while also guaranteeing that paid licenses for big businesses will be available on fair, reasonable, and nondiscriminatory terms.
+These terms let you use and share this software for noncommercial purposes
+and in small business for free, while also guaranteeing that paid licenses
+for big businesses will be available on fair, reasonable, and
+nondiscriminatory terms.
 
 ## Acceptance
 
-In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+In order to get any license under these terms, you must agree to them as
+both strict obligations and conditions to all your licenses.
 
 ## Noncommercial Purposes
 
@@ -18,82 +22,147 @@ You may use the software for any noncommercial purpose.
 
 ## Personal Uses
 
-Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, count as use for noncommercial purposes.
+Personal use for research, experiment, and testing for the benefit of
+public knowledge, personal study, private entertainment, hobby projects,
+amateur pursuits, or religious observance, without any anticipated
+commercial application, count as use for noncommercial purposes.
 
 ## Noncommercial Organizations
 
-Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution counts as use for noncommercial purposes, regardless of the source of funding or obligations resulting from the funding.
+Use by any charitable organization, educational institution, public
+research organization, public safety or health organization, environmental
+protection organization, or government institution counts as use for
+noncommercial purposes, regardless of the source of funding or obligations
+resulting from the funding.
 
 ## Small Business
 
-You may use the software for the benefit of your company if it meets all these criteria:
+You may use the software for the benefit of your company if it meets all
+these criteria:
 
-1.  had fewer than 20 total individuals working as employees and independent contractors at all times during the last tax year
+1.  had fewer than 20 total individuals working as employees and
+    independent contractors at all times during the last tax year
 
 2.  earned less than $1,000,000 total revenue in the last tax year
 
-3.  received less than $1,000,000 total debt, equity, and other investment in the last five tax years, counting investment in predecessor companies that reorganized into, merged with, or spun out your company
+3.  received less than $1,000,000 total debt, equity, and other investment
+    in the last five tax years, counting investment in predecessor
+    companies that reorganized into, merged with, or spun out your company
 
-All dollar figures are United States dollars as of 2019.  Adjust for them inflation according to the United States Bureau of Labor Statistics' consumer price index for all urban consumers, United States city average, for all items, not seasonally adjusted, with 1982–1984=100 reference base.
+All dollar figures are United States dollars as of 2019.  Adjust for them
+inflation according to the United States Bureau of Labor Statistics'
+consumer price index for all urban consumers, United States city average,
+for all items, not seasonally adjusted, with 1982–1984=100 reference base.
 
 ## Big Business
 
 You may use the software for the benefit of your company:
 
-1.  for 128 days after your company stops qualifying under [Small Business](#small-business)
+1.  for 128 days after your company stops qualifying under
+    [Small Business](#small-business)
 
-2.  indefinitely, if the licensor or their legal successor does not offer fair, reasonable, and nondiscriminatory terms for a commercial license for the software within 32 days of [written request](#how-to-request) and negotiate in good faith to conclude a deal
+2.  indefinitely, if the licensor or their legal successor does not offer
+fair, reasonable, and nondiscriminatory terms for a commercial license for
+the software within 32 days of [written request](#how-to-request) and
+negotiate in good faith to conclude a deal
 
 ## How to Request
 
-If this software includes an address for the licensor or an agent of the licensor in a standard place, such as in documentation, software package metadata, or an "about" page or screen, try to request a fair commercial license at that address.  If this package includes both online and offline addresses, try online before offline.  If you can't deliver a request that way, or this software doesn't include any addressees, spend one hour online researching an address, recording all your searches and inquiries as you go, and try any addresses that you find.  If you can't find any addresses, or if those addresses also fail, that counts as failure to offer a fair commercial license by the licensor under [Big Business](#big-business).
+If this software includes an address for the licensor or an agent of the
+licensor in a standard place, such as in documentation, software package
+metadata, or an "about" page or screen, try to request a fair commercial
+license at that address.  If this package includes both online and offline
+addresses, try online before offline.  If you can't deliver a request that
+way, or this software doesn't include any addressees, spend one hour online
+researching an address, recording all your searches and inquiries as you
+go, and try any addresses that you find.  If you can't find any addresses,
+or if those addresses also fail, that counts as failure to offer a fair
+commercial license by the licensor under [Big Business](#big-business).
 
 ## Fair, Reasonable, and Nondiscriminatory Terms
 
-Fair, reasonable, and nondiscriminatory terms may license the software perpetually or for a term, and may or may not cover new versions of the software.  If the licensor advertises license terms and a pricing structure for generally available commercial licenses, the licensor proposes license terms and a price as advertised, and a customer not affiliated with the licensor has bought a commercial license for the software on substantially equivalent terms in the past year, the proposal is fair, reasonable, and nondiscriminatory.
+Fair, reasonable, and nondiscriminatory terms may license the software
+perpetually or for a term, and may or may not cover new versions of the
+software.  If the licensor advertises license terms and a pricing structure
+for generally available commercial licenses, the licensor proposes license
+terms and a price as advertised, and a customer not affiliated with the
+licensor has bought a commercial license for the software on substantially
+equivalent terms in the past year, the proposal is fair, reasonable, and
+nondiscriminatory.
 
 ## Copyright License
 
-The licensor grants you a copyright license to do everything with the software that would otherwise infringe the licensor's copyright in it for any purpose allowed by these terms.
+The licensor grants you a copyright license to do everything with the
+software that would otherwise infringe the licensor's copyright in it for
+any purpose allowed by these terms.
 
 ## Notices
 
-You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+You must ensure that anyone who gets a copy of any part of the software
+from you also gets a copy of these terms or the URL for them above, as well
+as copies of any plain-text lines beginning with `Required Notice:` that
+the licensor provided with the software.  For example:
 
-> Required Notice: Nick Thomas (https://nichoth.com)
+> Required Notice: Copyright Nick Thomas (https://nichoth.com)
 
 ## Patent License
 
-The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+The licensor grants you a patent license for the software that covers
+patent claims the licensor can license, or becomes able to license, that
+you would infringe by using the software.
 
 ## Fair Use
 
-You may have "fair use" rights for the software under the law. These terms do not limit them.
+You may have "fair use" rights for the software under the law. These terms
+do not limit them.
 
 ## No Other Rights
 
-These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+These terms do not allow you to sublicense or transfer any of your licenses
+to anyone else, or prevent the licensor from granting licenses to anyone
+else.  These terms do not imply any other licenses.
 
 ## Patent Defense
 
-If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+If you make any written claim that the software infringes or contributes to
+infringement of any patent, your patent license for the software granted
+under these terms ends immediately. If your company makes such a claim,
+your patent license ends immediately for work on behalf of your company.
 
 ## Violations
 
-The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+The first time you are notified in writing that you have violated any of
+these terms, or done anything with the software not covered by your
+licenses, your licenses can nonetheless continue if you come into full
+compliance with these terms, and take practical steps to correct past
+violations, within 32 days of receiving notice.  Otherwise, all your
+licenses end immediately.
 
 ## No Liability
 
-***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+***As far as the law allows, the software comes as is, without any warranty
+or condition, and the licensor will not be liable to you for any damages
+arising out of these terms or the use or nature of the software, under any
+kind of legal claim.***
 
 ## Definitions
 
-The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+The **licensor** is the individual or entity offering these terms, and
+the **software** is the software the licensor makes available under these
+terms.
 
 **You** refers to the individual or entity agreeing to these terms.
 
-**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+**Your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control
+over, are under the control of, or are under common control with that
+organization.  **Control** means ownership of substantially all the assets
+of an entity, or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
 
-**Your licenses** are all the licenses granted to you for the software under these terms.
+**Your licenses** are all the licenses granted to you for the software
+under these terms.
+
+**Use** means anything you do with the software requiring one of your
+licenses.
 
-**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -1,67 +1,98 @@
-# input
-[![tests](https://img.shields.io/github/actions/workflow/status/substrate-system/input/nodejs.yml?style=flat-square)](https://github.com/substrate-system/input/actions/workflows/nodejs.yml)
+# Input
+![tests](https://github.com/substrate-system/input/actions/workflows/nodejs.yml/badge.svg)
 [![types](https://img.shields.io/npm/types/@substrate-system/input?style=flat-square)](README.md)
 [![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)
-[![install size](https://flat.badgen.net/packagephobia/install/@substrate-system/input?cache-control=no-cache)](https://packagephobia.com/result?p=@substrate-system/input)
-[![GZip size](https://flat.badgen.net/bundlephobia/minzip/@substrate-system/input)](https://bundlephobia.com/package/@substrate-system/input)
+[![install size](https://flat.badgen.net/packagephobia/install/@bicycle-codes/keys?cache-control=no-cache)](https://packagephobia.com/result?p=@bicycle-codes/keys)
+[![GZip size](https://img.badgesize.io/https%3A%2F%2Fesm.sh%2F%40substrate-system%2Finput%2Fes2022%2Ffile.mjs?style=flat-square&compression=gzip)](https://esm.sh/@substrate-system/input/es2022/input.mjs)
 [![dependencies](https://img.shields.io/badge/dependencies-zero-brightgreen.svg?style=flat-square)](package.json)
 [![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&style=flat-square)](https://semver.org/)
 [![Common Changelog](https://nichoth.github.io/badge/common-changelog.svg)](./CHANGELOG.md)
 [![license](https://img.shields.io/badge/license-Big_Time-blue?style=flat-square)](LICENSE)
 
 
-A parent web component to inherit from.
+Inputs with style.
 
 [See a live demo](https://substrate-system.github.io/input/)
 
+<details><summary><h2>Contents</h2></summary>
+
 <!-- toc -->
 
 - [Install](#install)
-- [Modules](#modules)
-  * [ESM](#esm)
-  * [Common JS](#common-js)
-- [Use](#use)
+- [CSS](#css)
+  * [Import CSS](#import-css)
+  * [Customize CSS via some variables](#customize-css-via-some-variables)
+- [use](#use)
   * [JS](#js)
+  * [HTML](#html)
+  * [pre-built](#pre-built)
 
 <!-- tocstop -->
 
+</details>
+
 ## Install
 
+Installation instructions
+
 ```sh
 npm i -S @substrate-system/input
 ```
 
-## Modules
+## CSS
 
-This exposes ESM and common JS via [package.json `exports` field](https://nodejs.org/api/packages.html#exports).
+### Import CSS
 
-### ESM
 ```js
-import { Input } from '@substrate-system/input'
+import '@substrate-system/input/css'
 ```
 
-### Common JS
+Or minified:
 ```js
-const { Input } = require('@substrate-system/input')
+import '@substrate-system/input/min/css'
 ```
 
------------------
+### Customize CSS via some variables
+
+```css
+substrate-input {
+    --example: pink;
+}
+```
 
-## Use
-Inherit from this module.
+## use
+This calls the global function `customElements.define`. Just import, then use
+the tag in your HTML.
 
 ### JS
 ```js
-import { Input } from '@substrate-system/input'
+import '@substrate-system/input'
+```
 
-class FooBar extends Input {
-    static tag = 'foo-bar'
-}
+### HTML
+```html
+<div>
+    <substrate-input></substrate-input>
+</div>
+```
 
-// Use the static method `define`
-FooBar.define()
+### pre-built
+This package exposes minified JS and CSS files too. Copy them to a location that is
+accessible to your web server, then link to them in HTML.
+
+#### copy
+```sh
+cp ./node_modules/@substrate-system/input/dist/index.min.js ./public/substrate-input.min.js
+cp ./node_modules/@substrate-system/input/dist/style.min.css ./public/substrate-input.css
+```
 
-document.body.innerHTML += `
-    <foo-bar></foo-bar>
-`
+#### HTML
+```html
+<head>
+    <link rel="stylesheet" href="./substrate-input.css">
+</head>
+<body>
+    <!-- ... -->
+    <script type="module" src="./substrate-input.min.js"></script>
+</body>
 ```

package/dist/index.cjs

@@ -19,169 +19,153 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var index_exports = {};
 __export(index_exports, {
-  Input: () => Input
+  SubstrateInput: () => SubstrateInput
 });
 module.exports = __toCommonJS(index_exports);
-class Input extends HTMLElement {
+var import_web_component = require("@substrate-system/web-component");
+var import_util = require("@substrate-system/web-component/util");
+var import_util2 = require("./util");
+class SubstrateInput extends import_web_component.WebComponent.create("substrate-input") {
   static {
-    __name(this, "Input");
-  }
-  // for `attributeChangedCallback`
-  static observedAttributes = ["autofocus", "disabled"];
-  static TAG;
-  static define() {
-    if (!("customElements" in window)) return;
-    if (customElements.get(this.TAG)) return;
-    return customElements.define(this.TAG, this);
-  }
-  constructor() {
-    super();
-    const disabled = this.getAttribute("disabled");
-    if (disabled !== null) {
-      setTimeout(() => {
-        this.disabled = true;
-      }, 0);
-    }
-    setTimeout(() => {
-      const attr = this.getAttribute("value");
-      if (attr) this.value = attr;
-      const type = this.getAttribute("type");
-      if (type) this.type = type;
-    }, 0);
-  }
-  get input() {
-    return this.querySelector("input");
-  }
-  get tabindex() {
-    const i = this.input?.getAttribute("tabindex");
-    if (!i) return 0;
-    return parseInt(i);
-  }
-  get name() {
-    return this.getAttribute("name");
-  }
-  get placeholder() {
-    return this.getAttribute("placeholder");
-  }
-  get autocomplete() {
-    return this.getAttribute("autocomplete");
-  }
-  set name(newName) {
-    this.setAttribute("name", newName);
-  }
-  /**
-   * Remove from `this` element and also child.
-   */
-  _removeAttribute(name) {
-    this.removeAttribute(name);
-    this.input?.removeAttribute(name);
+    __name(this, "SubstrateInput");
+  }
+  static TAG = "substrate-input";
+  static INPUT_ATTRIBUTES = import_util2.INPUT_ATTRIBUTES;
+  static ARIA_ATTRIBUTES = import_util2.ARIA_ATTRIBUTES;
+  static observedAttributes = ["label", "id"].concat(SubstrateInput.INPUT_ATTRIBUTES).concat(SubstrateInput.ARIA_ATTRIBUTES);
+  inputId = null;
+  inputAriaAttributes = {};
+  ignoredAriaCallbackNames = /* @__PURE__ */ new Set();
+  ignoredIdCallback = false;
+  generatedInputId = `substrate-input-${Math.random().toString(36).slice(2, 10)}`;
+  handleChange_label(_oldValue, _newValue) {
+    this.render();
   }
-  get disabled() {
-    return !!this.input?.hasAttribute("disabled");
+  handleChange_aria(name, _oldValue, newValue) {
+    if (this.ignoredAriaCallbackNames.has(name)) {
+      this.ignoredAriaCallbackNames.delete(name);
+      return;
+    }
+    if (newValue === null) {
+      delete this.inputAriaAttributes[name];
+      this.querySelector("input")?.removeAttribute(name);
+      return;
+    }
+    this.inputAriaAttributes[name] = newValue;
+    this.querySelector("input")?.setAttribute(name, newValue);
+    if (this.hasAttribute(name)) {
+      this.ignoredAriaCallbackNames.add(name);
+      this.removeAttribute(name);
+    }
   }
-  set disabled(disabledValue) {
-    if (!disabledValue) {
-      this._removeAttribute("disabled");
-      this.input?.setAttribute("aria-disabled", "false");
-    } else {
-      this.input?.setAttribute("disabled", "");
-      this.input?.setAttribute("aria-disabled", "true");
+  handleChange_id(_oldValue, newValue) {
+    if (this.ignoredIdCallback) {
+      this.ignoredIdCallback = false;
+      return;
+    }
+    if (newValue === null) {
+      this.inputId = null;
+      this.querySelector("input")?.removeAttribute("id");
+      return;
+    }
+    this.inputId = newValue;
+    this.querySelector("input")?.setAttribute("id", newValue);
+    if (this.hasAttribute("id")) {
+      this.ignoredIdCallback = true;
+      this.removeAttribute("id");
     }
   }
-  /**
-   * Handle 'example' attribute changes
-   * @see {@link https://gomakethings.com/how-to-detect-when-attributes-change-on-a-web-component/#organizing-your-code Go Make Things article}
-   *
-   * @param  {string|null} _oldValue The old attribute value
-   * @param  {string|null} newValue The new attribute value
-   */
-  handleChange_disabled(_oldValue, newValue) {
-    if (!this.input) {
-      setTimeout(() => {
-        if (newValue === null || newValue === "null") {
-          this.disabled = false;
-        } else {
-          this.disabled = true;
-        }
-      }, 0);
-    } else {
-      if (newValue === null || newValue === "null") {
-        this.disabled = false;
-      } else {
-        this.disabled = true;
-      }
+  handleChange_inputAttribute(name, newValue) {
+    const input = this.querySelector("input");
+    if (!input) return;
+    if (newValue === null) {
+      input.removeAttribute(name);
+      return;
     }
+    input.setAttribute(name, newValue);
   }
-  /**
-   * Runs when the value of an attribute is changed
-   *
-   * @param  {string} name     The attribute name
-   * @param  {string} oldValue The old attribute value
-   * @param  {string} newValue The new attribute value
-   */
-  attributeChangedCallback(name, oldValue, newValue) {
-    const handler = this[`handleChange_${name}`];
-    handler && handler.call(this, oldValue, newValue);
-    this.render();
+  async attributeChangedCallback(name, oldValue, newValue) {
+    if (name === "id") {
+      this.handleChange_id(oldValue, newValue);
+      return;
+    }
+    if (name.startsWith("aria-")) {
+      this.handleChange_aria(name, oldValue, newValue);
+      return;
+    }
+    if (SubstrateInput.INPUT_ATTRIBUTES.includes(name)) {
+      this.handleChange_inputAttribute(name, newValue);
+      return;
+    }
+    if (this[`handleChange_${name}`]) {
+      this[`handleChange_${name}`](oldValue, newValue);
+    }
   }
   connectedCallback() {
     this.render();
   }
-  get type() {
-    return this.input?.getAttribute("type");
+  getInputIdForRender() {
+    return this.inputId || this.generatedInputId;
   }
-  set type(value) {
-    this._setAttribute("type", value);
+  set label(value) {
+    if (value === null) {
+      this.removeAttribute("label");
+      return;
+    }
+    this.setAttribute("label", value);
   }
-  get value() {
-    return this.input?.value;
+  get label() {
+    return this.getAttribute("label");
   }
-  set value(text) {
-    if (!text) this.input?.removeAttribute("value");
-    else {
-      this.input.value = text;
+  render() {
+    const label = this.getAttribute("label");
+    const hostId = this.getAttribute("id");
+    const hostAriaAttributes = Array.from(this.attributes).filter((attr) => attr.name.startsWith("aria-"));
+    if (hostId !== null) {
+      this.inputId = hostId;
     }
-  }
-  /**
-   * Set attributes on the internal input element.
-   */
-  _setAttribute(name, value) {
-    if (!value) {
-      return this._removeAttribute(name);
+    for (const attr of hostAriaAttributes) {
+      this.inputAriaAttributes[attr.name] = attr.value;
     }
-    if (value === true) {
-      return this.input?.setAttribute(name, "");
+    const name = this.getAttribute("name");
+    const attrs = Array.from(this.attributes).filter(
+      (attr) => attr.name !== "label" && attr.name !== "id" && !attr.name.startsWith("aria-")
+    ).map(
+      (attr) => attr.name + (attr.value === "" ? "" : `="${attr.value}"`)
+    ).join(" ");
+    const classes = (this.getAttribute("class") ?? "").split(" ").concat(["substrate", "input", name || ""]).filter(Boolean).join(" ");
+    const inputId = this.getInputIdForRender();
+    const renderedIdAttribute = `id="${inputId}"`;
+    const ariaAttributes = Object.entries(this.inputAriaAttributes).map(([attrName, attrValue]) => {
+      return attrName + (attrValue === "" ? "" : `="${attrValue}"`);
+    }).join(" ");
+    this.innerHTML = label ? `
+            <div class="${classes}">
+            <label class="label-content" for="${inputId}">${label}</label>
+            <input
+            ${renderedIdAttribute}
+            ${ariaAttributes}
+            ${attrs}
+            />
+            </div>
+        ` : `
+            <div class="${classes}">
+            <input
+            ${renderedIdAttribute}
+            ${ariaAttributes}
+            ${attrs}
+            />
+            </div>
+        `;
+    if (this.hasAttribute("id")) {
+      this.ignoredIdCallback = true;
+      this.removeAttribute("id");
+    }
+    for (const attr of hostAriaAttributes) {
+      this.ignoredAriaCallbackNames.add(attr.name);
+      this.removeAttribute(attr.name);
     }
-    this.input?.setAttribute(name, value);
-  }
-  render() {
-    const {
-      type,
-      autofocus,
-      tabindex,
-      disabled,
-      value,
-      name,
-      placeholder,
-      autocomplete
-    } = this;
-    if (!name) throw new Error("not name");
-    const classes = ["substrate-input"];
-    const btn = !!(this.type === "submit" || this.type === "button");
-    const props = [
-      `class="${classes.filter(Boolean).join(" ")}"`,
-      disabled ? "disabled" : "",
-      disabled ? 'aria-disabled="true"' : 'aria-disabled="false"',
-      autofocus ? "autofocus" : "",
-      type ? `type="${this.type}"` : "",
-      tabindex ? `tabindex="${tabindex}"` : 'tabindex="0"',
-      btn ? 'role="button"' : "",
-      value ? `value="${value}"` : "",
-      name ? `name="${name}"` : "",
-      autocomplete ? `autocomplete="${autocomplete}"` : "",
-      placeholder ? `placeholder="${placeholder}"` : ""
-    ].filter(Boolean).join(" ");
-    return `<input ${props} />`;
   }
 }
+(0, import_util.define)(SubstrateInput.TAG, SubstrateInput);
 //# sourceMappingURL=index.cjs.map