@spectrum-web-components/underlay 0.40.5 → 0.41.0

package/custom-elements.json

@@ -26,6 +26,15 @@
           "description": "",
           "name": "Underlay",
           "members": [
+            {
+              "kind": "field",
+              "name": "canClick",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
             {
               "kind": "field",
               "name": "open",
@@ -36,6 +45,45 @@
               "default": "false",
               "attribute": "open",
               "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "click",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "handlePointerdown",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "handlePointerup",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "close",
+              "type": {
+                "text": "Event"
+              },
+              "description": "When the underlay is \"clicked\" and the consuming pattern should chose whether to close based on that interaction"
             }
           ],
           "attributes": [

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/underlay",
-    "version": "0.40.5",
+    "version": "0.41.0",
     "publishConfig": {
         "access": "public"
     },
@@ -57,7 +57,7 @@
         "lit-html"
     ],
     "dependencies": {
-        "@spectrum-web-components/base": "^0.40.5"
+        "@spectrum-web-components/base": "^0.41.0"
     },
     "devDependencies": {
         "@spectrum-css/underlay": "^3.2.0"
@@ -68,5 +68,5 @@
         "./sp-*.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "2e0006478841b07af63c19a0167a136bf724d064"
+    "gitHead": "0bf38fd427adc39804b228a4c61de623e5ebb82e"
 }

package/src/Underlay.d.ts

@@ -1,9 +1,16 @@
 import { CSSResultArray, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
 /**
  * @element sp-underlay
+ *
+ * @fires close - When the underlay is "clicked" and the consuming pattern should chose whether to close based on that interaction
  */
 export declare class Underlay extends SpectrumElement {
     static get styles(): CSSResultArray;
+    private canClick;
     open: boolean;
+    click(): void;
+    protected handlePointerdown(): void;
+    protected handlePointerup(): void;
     protected render(): TemplateResult;
+    protected firstUpdated(): void;
 }

package/src/Underlay.dev.js

@@ -19,14 +19,31 @@ import styles from "./underlay.css.js";
 export class Underlay extends SpectrumElement {
   constructor() {
     super(...arguments);
+    this.canClick = false;
     this.open = false;
   }
   static get styles() {
     return [styles];
   }
+  click() {
+    this.dispatchEvent(new Event("close"));
+  }
+  handlePointerdown() {
+    this.canClick = true;
+  }
+  handlePointerup() {
+    if (this.canClick) {
+      this.click();
+    }
+    this.canClick = false;
+  }
   render() {
     return html``;
   }
+  firstUpdated() {
+    this.addEventListener("pointerdown", this.handlePointerdown);
+    this.addEventListener("pointerup", this.handlePointerup);
+  }
 }
 __decorateClass([
   property({ type: Boolean, reflect: true })

package/src/Underlay.dev.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["Underlay.ts"],
-  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    SpectrumElement,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\n\nimport styles from './underlay.css.js';\n\n/**\n * @element sp-underlay\n */\nexport class Underlay extends SpectrumElement {\n    public static override get styles(): CSSResultArray {\n        return [styles];\n    }\n\n    @property({ type: Boolean, reflect: true })\n    public open = false;\n\n    protected override render(): TemplateResult {\n        return html``;\n    }\n}\n"],
-  "mappings": ";;;;;;;;;;;;AAYA;AAAA,EAEI;AAAA,EACA;AAAA,OAEG;AACP,SAAS,gBAAgB;AAEzB,OAAO,YAAY;AAKZ,aAAM,iBAAiB,gBAAgB;AAAA,EAAvC;AAAA;AAMH,SAAO,OAAO;AAAA;AAAA,EALd,WAA2B,SAAyB;AAChD,WAAO,CAAC,MAAM;AAAA,EAClB;AAAA,EAKmB,SAAyB;AACxC,WAAO;AAAA,EACX;AACJ;AALW;AAAA,EADN,SAAS,EAAE,MAAM,SAAS,SAAS,KAAK,CAAC;AAAA,GALjC,SAMF;",
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    SpectrumElement,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\n\nimport styles from './underlay.css.js';\n\n/**\n * @element sp-underlay\n *\n * @fires close - When the underlay is \"clicked\" and the consuming pattern should chose whether to close based on that interaction\n */\nexport class Underlay extends SpectrumElement {\n    public static override get styles(): CSSResultArray {\n        return [styles];\n    }\n\n    private canClick = false;\n\n    @property({ type: Boolean, reflect: true })\n    public open = false;\n\n    public override click(): void {\n        this.dispatchEvent(new Event('close'));\n    }\n\n    protected handlePointerdown(): void {\n        this.canClick = true;\n    }\n\n    protected handlePointerup(): void {\n        if (this.canClick) {\n            this.click();\n        }\n        this.canClick = false;\n    }\n\n    protected override render(): TemplateResult {\n        return html``;\n    }\n\n    protected override firstUpdated(): void {\n        this.addEventListener('pointerdown', this.handlePointerdown);\n        this.addEventListener('pointerup', this.handlePointerup);\n    }\n}\n"],
+  "mappings": ";;;;;;;;;;;;AAYA;AAAA,EAEI;AAAA,EACA;AAAA,OAEG;AACP,SAAS,gBAAgB;AAEzB,OAAO,YAAY;AAOZ,aAAM,iBAAiB,gBAAgB;AAAA,EAAvC;AAAA;AAKH,SAAQ,WAAW;AAGnB,SAAO,OAAO;AAAA;AAAA,EAPd,WAA2B,SAAyB;AAChD,WAAO,CAAC,MAAM;AAAA,EAClB;AAAA,EAOgB,QAAc;AAC1B,SAAK,cAAc,IAAI,MAAM,OAAO,CAAC;AAAA,EACzC;AAAA,EAEU,oBAA0B;AAChC,SAAK,WAAW;AAAA,EACpB;AAAA,EAEU,kBAAwB;AAC9B,QAAI,KAAK,UAAU;AACf,WAAK,MAAM;AAAA,IACf;AACA,SAAK,WAAW;AAAA,EACpB;AAAA,EAEmB,SAAyB;AACxC,WAAO;AAAA,EACX;AAAA,EAEmB,eAAqB;AACpC,SAAK,iBAAiB,eAAe,KAAK,iBAAiB;AAC3D,SAAK,iBAAiB,aAAa,KAAK,eAAe;AAAA,EAC3D;AACJ;AAzBW;AAAA,EADN,SAAS,EAAE,MAAM,SAAS,SAAS,KAAK,CAAC;AAAA,GAPjC,SAQF;",
   "names": []
 }

package/src/Underlay.js

@@ -1,2 +1,2 @@
-"use strict";var u=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var m=(l,r,o,t)=>{for(var e=t>1?void 0:t?a(r,o):r,p=l.length-1,s;p>=0;p--)(s=l[p])&&(e=(t?s(r,o,e):s(e))||e);return t&&e&&u(r,o,e),e};import{html as i,SpectrumElement as c}from"@spectrum-web-components/base";import{property as n}from"@spectrum-web-components/base/src/decorators.js";import y from"./underlay.css.js";export class Underlay extends c{constructor(){super(...arguments);this.open=!1}static get styles(){return[y]}render(){return i``}}m([n({type:Boolean,reflect:!0})],Underlay.prototype,"open",2);
+"use strict";var d=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var s=(i,t,o,r)=>{for(var e=r>1?void 0:r?p(t,o):t,n=i.length-1,l;n>=0;n--)(l=i[n])&&(e=(r?l(t,o,e):l(e))||e);return r&&e&&d(t,o,e),e};import{html as c,SpectrumElement as a}from"@spectrum-web-components/base";import{property as h}from"@spectrum-web-components/base/src/decorators.js";import u from"./underlay.css.js";export class Underlay extends a{constructor(){super(...arguments);this.canClick=!1;this.open=!1}static get styles(){return[u]}click(){this.dispatchEvent(new Event("close"))}handlePointerdown(){this.canClick=!0}handlePointerup(){this.canClick&&this.click(),this.canClick=!1}render(){return c``}firstUpdated(){this.addEventListener("pointerdown",this.handlePointerdown),this.addEventListener("pointerup",this.handlePointerup)}}s([h({type:Boolean,reflect:!0})],Underlay.prototype,"open",2);
 //# sourceMappingURL=Underlay.js.map

package/src/Underlay.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["Underlay.ts"],
-  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    SpectrumElement,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\n\nimport styles from './underlay.css.js';\n\n/**\n * @element sp-underlay\n */\nexport class Underlay extends SpectrumElement {\n    public static override get styles(): CSSResultArray {\n        return [styles];\n    }\n\n    @property({ type: Boolean, reflect: true })\n    public open = false;\n\n    protected override render(): TemplateResult {\n        return html``;\n    }\n}\n"],
-  "mappings": "qNAYA,OAEI,QAAAA,EACA,mBAAAC,MAEG,gCACP,OAAS,YAAAC,MAAgB,kDAEzB,OAAOC,MAAY,oBAKZ,aAAM,iBAAiBF,CAAgB,CAAvC,kCAMH,KAAO,KAAO,GALd,WAA2B,QAAyB,CAChD,MAAO,CAACE,CAAM,CAClB,CAKmB,QAAyB,CACxC,OAAOH,GACX,CACJ,CALWI,EAAA,CADNF,EAAS,CAAE,KAAM,QAAS,QAAS,EAAK,CAAC,GALjC,SAMF",
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport {\n    CSSResultArray,\n    html,\n    SpectrumElement,\n    TemplateResult,\n} from '@spectrum-web-components/base';\nimport { property } from '@spectrum-web-components/base/src/decorators.js';\n\nimport styles from './underlay.css.js';\n\n/**\n * @element sp-underlay\n *\n * @fires close - When the underlay is \"clicked\" and the consuming pattern should chose whether to close based on that interaction\n */\nexport class Underlay extends SpectrumElement {\n    public static override get styles(): CSSResultArray {\n        return [styles];\n    }\n\n    private canClick = false;\n\n    @property({ type: Boolean, reflect: true })\n    public open = false;\n\n    public override click(): void {\n        this.dispatchEvent(new Event('close'));\n    }\n\n    protected handlePointerdown(): void {\n        this.canClick = true;\n    }\n\n    protected handlePointerup(): void {\n        if (this.canClick) {\n            this.click();\n        }\n        this.canClick = false;\n    }\n\n    protected override render(): TemplateResult {\n        return html``;\n    }\n\n    protected override firstUpdated(): void {\n        this.addEventListener('pointerdown', this.handlePointerdown);\n        this.addEventListener('pointerup', this.handlePointerup);\n    }\n}\n"],
+  "mappings": "qNAYA,OAEI,QAAAA,EACA,mBAAAC,MAEG,gCACP,OAAS,YAAAC,MAAgB,kDAEzB,OAAOC,MAAY,oBAOZ,aAAM,iBAAiBF,CAAgB,CAAvC,kCAKH,KAAQ,SAAW,GAGnB,KAAO,KAAO,GAPd,WAA2B,QAAyB,CAChD,MAAO,CAACE,CAAM,CAClB,CAOgB,OAAc,CAC1B,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC,CACzC,CAEU,mBAA0B,CAChC,KAAK,SAAW,EACpB,CAEU,iBAAwB,CAC1B,KAAK,UACL,KAAK,MAAM,EAEf,KAAK,SAAW,EACpB,CAEmB,QAAyB,CACxC,OAAOH,GACX,CAEmB,cAAqB,CACpC,KAAK,iBAAiB,cAAe,KAAK,iBAAiB,EAC3D,KAAK,iBAAiB,YAAa,KAAK,eAAe,CAC3D,CACJ,CAzBWI,EAAA,CADNF,EAAS,CAAE,KAAM,QAAS,QAAS,EAAK,CAAC,GAPjC,SAQF",
   "names": ["html", "SpectrumElement", "property", "styles", "__decorateClass"]
 }