@spectrum-web-components/tray 0.3.3-express.9 → 0.3.3

package/README.md

@@ -26,70 +26,34 @@ import { Tray } from '@spectrum-web-components/tray';
 ## Dialog
 
 ```html
-<sp-button
-    variant="secondary"
-    onclick="
-    const trigger = this;
-    const interaction = 'modal';
-    const content = this.nextElementSibling;
-    const options = {
-        offset: 0,
-        placement: 'none',
-        receivesFocus: 'auto',
-    };
-    Overlay.open(
-        trigger, 
-        interaction,
-        content,
-        options
-    );
-"
->
-    Toggle tray
-</sp-button>
-<sp-tray>
-    <sp-dialog size="small" dismissable>
-        <h2 slot="heading">New Messages</h2>
-        You have 5 new messages.
-    </sp-dialog>
-</sp-tray>
+<overlay-trigger type="modal" placement="none">
+    <sp-button slot="trigger" variant="secondary">Toggle tray</sp-button>
+    <sp-tray slot="click-content">
+        <sp-dialog size="small" dismissable>
+            <h2 slot="heading">New Messages</h2>
+            You have 5 new messages.
+        </sp-dialog>
+    </sp-tray>
+</overlay-trigger>
 ```
 
 ## Menu
 
 ```html
-<sp-button
-    variant="secondary"
-    onclick="
-    const trigger = this;
-    const interaction = 'modal';
-    const content = this.nextElementSibling;
-    const options = {
-        offset: 0,
-        placement: 'none',
-        receivesFocus: 'auto',
-    };
-    Overlay.open(
-        trigger, 
-        interaction,
-        content,
-        options
-    );
-"
->
-    Toggle menu
-</sp-button>
-<sp-tray>
-    <sp-menu style="width: 100%">
-        <sp-menu-item selected>Deselect</sp-menu-item>
-        <sp-menu-item>Select Inverse</sp-menu-item>
-        <sp-menu-item focused>Feather...</sp-menu-item>
-        <sp-menu-item>Select and Mask...</sp-menu-item>
-        <sp-menu-divider></sp-menu-divider>
-        <sp-menu-item>Save Selection</sp-menu-item>
-        <sp-menu-item disabled>Make Work Path</sp-menu-item>
-    </sp-menu>
-</sp-tray>
+<overlay-trigger type="modal" placement="none">
+    <sp-button slot="trigger" variant="secondary">Toggle menu</sp-button>
+    <sp-tray slot="click-content">
+        <sp-menu style="width: 100%">
+            <sp-menu-item selected>Deselect</sp-menu-item>
+            <sp-menu-item>Select Inverse</sp-menu-item>
+            <sp-menu-item focused>Feather...</sp-menu-item>
+            <sp-menu-item>Select and Mask...</sp-menu-item>
+            <sp-menu-divider></sp-menu-divider>
+            <sp-menu-item>Save Selection</sp-menu-item>
+            <sp-menu-item disabled>Make Work Path</sp-menu-item>
+        </sp-menu>
+    </sp-tray>
+</overlay-trigger>
 ```
 
 ## Accessibility

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/tray",
-    "version": "0.3.3-express.9+abfee7409",
+    "version": "0.3.3",
     "publishConfig": {
         "access": "public"
     },
@@ -44,20 +44,20 @@
         "lit-html"
     ],
     "dependencies": {
-        "@spectrum-web-components/base": "^0.5.2",
-        "@spectrum-web-components/modal": "^0.6.2-express.9+abfee7409",
-        "@spectrum-web-components/reactive-controllers": "^0.2.0",
-        "@spectrum-web-components/shared": "^0.13.4",
-        "@spectrum-web-components/underlay": "^0.8.4-express.9+abfee7409",
+        "@spectrum-web-components/base": "^0.5.3",
+        "@spectrum-web-components/modal": "^0.6.2",
+        "@spectrum-web-components/reactive-controllers": "^0.2.1",
+        "@spectrum-web-components/shared": "^0.13.5",
+        "@spectrum-web-components/underlay": "^0.8.4",
         "tslib": "^2.0.0"
     },
     "devDependencies": {
-        "@spectrum-css/tray": "^1.0.17"
+        "@spectrum-css/tray": "^1.0.18"
     },
     "types": "./src/index.d.ts",
     "customElements": "custom-elements.json",
     "sideEffects": [
         "./sp-*.js"
     ],
-    "gitHead": "abfee740957976448a3e4cf90df17d6165f857d6"
+    "gitHead": "57aba8030b6af96af4015a0aa830e342a17dc219"
 }

package/stories/tray.stories.js

@@ -1,64 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-import { html } from '@spectrum-web-components/base';
-import '@spectrum-web-components/dialog/sp-dialog.js';
-import '@spectrum-web-components/menu/sp-menu.js';
-import '@spectrum-web-components/menu/sp-menu-item.js';
-import '@spectrum-web-components/menu/sp-menu-divider.js';
-import '../sp-tray.js';
-export default {
-    title: 'Tray',
-    component: 'sp-tray',
-    args: {
-        open: true,
-    },
-    argTypes: {
-        open: {
-            name: 'open',
-            type: { name: 'boolean', required: false },
-            description: 'Whether the tray is open.',
-            table: {
-                type: { summary: 'boolean' },
-                defaultValue: { summary: false },
-            },
-            control: {
-                type: 'boolean',
-            },
-        },
-    },
-};
-export const Default = (args) => {
-    return html `
-        <sp-tray ?open=${args.open}>
-            <sp-dialog size="s">
-                <h2 slot="heading">New Messages</h2>
-                You have 5 new messages.
-            </sp-dialog>
-        </sp-tray>
-    `;
-};
-export const menu = (args) => {
-    return html `
-        <sp-tray ?open=${args.open}>
-            <sp-menu style="width: 100%">
-                <sp-menu-item>Deselect</sp-menu-item>
-                <sp-menu-item selected>Select Inverse</sp-menu-item>
-                <sp-menu-item>Feather...</sp-menu-item>
-                <sp-menu-item>Select and Mask...</sp-menu-item>
-                <sp-menu-divider></sp-menu-divider>
-                <sp-menu-item>Save Selection</sp-menu-item>
-                <sp-menu-item disabled>Make Work Path</sp-menu-item>
-            </sp-menu>
-        </sp-tray>
-    `;
-};
-//# sourceMappingURL=tray.stories.js.map

package/stories/tray.stories.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tray.stories.js","sourceRoot":"","sources":["tray.stories.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAkB,MAAM,+BAA+B,CAAC;AAErE,OAAO,8CAA8C,CAAC;AACtD,OAAO,0CAA0C,CAAC;AAClD,OAAO,+CAA+C,CAAC;AACvD,OAAO,kDAAkD,CAAC;AAC1D,OAAO,eAAe,CAAC;AAEvB,eAAe;IACX,KAAK,EAAE,MAAM;IACb,SAAS,EAAE,SAAS;IACpB,IAAI,EAAE;QACF,IAAI,EAAE,IAAI;KACb;IACD,QAAQ,EAAE;QACN,IAAI,EAAE;YACF,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;YAC1C,WAAW,EAAE,2BAA2B;YACxC,KAAK,EAAE;gBACH,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;gBAC5B,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;aACnC;YACD,OAAO,EAAE;gBACL,IAAI,EAAE,SAAS;aAClB;SACJ;KACJ;CACJ,CAAC;AAMF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAe,EAAkB,EAAE;IACvD,OAAO,IAAI,CAAA;yBACU,IAAI,CAAC,IAAI;;;;;;KAM7B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAe,EAAkB,EAAE;IACpD,OAAO,IAAI,CAAA;yBACU,IAAI,CAAC,IAAI;;;;;;;;;;;KAW7B,CAAC;AACN,CAAC,CAAC","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 { html, TemplateResult } from '@spectrum-web-components/base';\n\nimport '@spectrum-web-components/dialog/sp-dialog.js';\nimport '@spectrum-web-components/menu/sp-menu.js';\nimport '@spectrum-web-components/menu/sp-menu-item.js';\nimport '@spectrum-web-components/menu/sp-menu-divider.js';\nimport '../sp-tray.js';\n\nexport default {\n    title: 'Tray',\n    component: 'sp-tray',\n    args: {\n        open: true,\n    },\n    argTypes: {\n        open: {\n            name: 'open',\n            type: { name: 'boolean', required: false },\n            description: 'Whether the tray is open.',\n            table: {\n                type: { summary: 'boolean' },\n                defaultValue: { summary: false },\n            },\n            control: {\n                type: 'boolean',\n            },\n        },\n    },\n};\n\ntype StoryArgs = {\n    open?: boolean;\n};\n\nexport const Default = (args: StoryArgs): TemplateResult => {\n    return html`\n        <sp-tray ?open=${args.open}>\n            <sp-dialog size=\"s\">\n                <h2 slot=\"heading\">New Messages</h2>\n                You have 5 new messages.\n            </sp-dialog>\n        </sp-tray>\n    `;\n};\n\nexport const menu = (args: StoryArgs): TemplateResult => {\n    return html`\n        <sp-tray ?open=${args.open}>\n            <sp-menu style=\"width: 100%\">\n                <sp-menu-item>Deselect</sp-menu-item>\n                <sp-menu-item selected>Select Inverse</sp-menu-item>\n                <sp-menu-item>Feather...</sp-menu-item>\n                <sp-menu-item>Select and Mask...</sp-menu-item>\n                <sp-menu-divider></sp-menu-divider>\n                <sp-menu-item>Save Selection</sp-menu-item>\n                <sp-menu-item disabled>Make Work Path</sp-menu-item>\n            </sp-menu>\n        </sp-tray>\n    `;\n};\n"]}

package/test/tray.test-vrt.js

@@ -1,15 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-import * as stories from '../stories/tray.stories.js';
-import { regressVisuals } from '../../../test/visual/test.js';
-regressVisuals('TrayStories', stories);
-//# sourceMappingURL=tray.test-vrt.js.map

package/test/tray.test-vrt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tray.test-vrt.js","sourceRoot":"","sources":["tray.test-vrt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,cAAc,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC","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 * as stories from '../stories/tray.stories.js';\nimport { regressVisuals } from '../../../test/visual/test.js';\n\nregressVisuals('TrayStories', stories);\n"]}

package/test/tray.test.js

@@ -1,60 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-import { elementUpdated, expect, fixture, html, nextFrame, oneEvent, } from '@open-wc/testing';
-import '../sp-tray.js';
-import '@spectrum-web-components/theme/sp-theme.js';
-import '@spectrum-web-components/theme/src/themes.js';
-describe('Tray', () => {
-    it('loads default tray accessibly', async () => {
-        const el = await fixture(html `
-                <sp-tray></sp-tray>
-            `);
-        await elementUpdated(el);
-        await expect(el).to.be.accessible();
-    });
-    it('focuses focusable light DOM element', async () => {
-        const el = await fixture(html `
-                <sp-tray open>
-                    <div>
-                        <a href="#">Test element</a>
-                    </div>
-                </sp-tray>
-            `);
-        const anchor = el.querySelector('a');
-        await elementUpdated(el);
-        el.focus();
-        await elementUpdated(el);
-        expect(document.activeElement).to.equal(anchor);
-    });
-    it('closes', async () => {
-        const test = await fixture(html `
-                <sp-theme scale="medium" color="dark">
-                    <sp-tray></sp-tray>
-                </sp-theme>
-            `);
-        const el = test.querySelector('sp-tray');
-        // Ensure closed styles are set before opening so that
-        // the `transitionend` event will be met below.
-        await nextFrame();
-        await nextFrame();
-        expect(el.open).to.be.false;
-        el.open = true;
-        await elementUpdated(el);
-        expect(el.open).to.be.true;
-        const closed = oneEvent(el, 'close');
-        const overlay = el.shadowRoot.querySelector('sp-underlay');
-        overlay.click();
-        await closed;
-        expect(el.open).to.be.false;
-    });
-});
-//# sourceMappingURL=tray.test.js.map

package/test/tray.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tray.test.js","sourceRoot":"","sources":["tray.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EACH,cAAc,EACd,MAAM,EACN,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,GACX,MAAM,kBAAkB,CAAC;AAE1B,OAAO,eAAe,CAAC;AAEvB,OAAO,4CAA4C,CAAC;AACpD,OAAO,8CAA8C,CAAC;AAEtD,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IAClB,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,EAAE,GAAG,MAAM,OAAO,CACpB,IAAI,CAAA;;aAEH,CACJ,CAAC;QAEF,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,EAAE,GAAG,MAAM,OAAO,CACpB,IAAI,CAAA;;;;;;aAMH,CACJ,CAAC;QACF,MAAM,MAAM,GAAG,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,EAAE,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;QACpB,MAAM,IAAI,GAAG,MAAM,OAAO,CACtB,IAAI,CAAA;;;;aAIH,CACJ,CAAC;QAEF,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAS,CAAC;QACjD,sDAAsD;QACtD,+CAA+C;QAC/C,MAAM,SAAS,EAAE,CAAC;QAClB,MAAM,SAAS,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAE5B,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;QACf,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC3B,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CACvC,aAAa,CACD,CAAC;QACjB,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IAChC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC","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    elementUpdated,\n    expect,\n    fixture,\n    html,\n    nextFrame,\n    oneEvent,\n} from '@open-wc/testing';\n\nimport '../sp-tray.js';\nimport { Tray } from '..';\nimport '@spectrum-web-components/theme/sp-theme.js';\nimport '@spectrum-web-components/theme/src/themes.js';\n\ndescribe('Tray', () => {\n    it('loads default tray accessibly', async () => {\n        const el = await fixture<Tray>(\n            html`\n                <sp-tray></sp-tray>\n            `\n        );\n\n        await elementUpdated(el);\n\n        await expect(el).to.be.accessible();\n    });\n    it('focuses focusable light DOM element', async () => {\n        const el = await fixture<Tray>(\n            html`\n                <sp-tray open>\n                    <div>\n                        <a href=\"#\">Test element</a>\n                    </div>\n                </sp-tray>\n            `\n        );\n        const anchor = el.querySelector('a');\n        await elementUpdated(el);\n\n        el.focus();\n        await elementUpdated(el);\n\n        expect(document.activeElement).to.equal(anchor);\n    });\n    it('closes', async () => {\n        const test = await fixture<HTMLElement>(\n            html`\n                <sp-theme scale=\"medium\" color=\"dark\">\n                    <sp-tray></sp-tray>\n                </sp-theme>\n            `\n        );\n\n        const el = test.querySelector('sp-tray') as Tray;\n        // Ensure closed styles are set before opening so that\n        // the `transitionend` event will be met below.\n        await nextFrame();\n        await nextFrame();\n        expect(el.open).to.be.false;\n\n        el.open = true;\n        await elementUpdated(el);\n\n        expect(el.open).to.be.true;\n        const closed = oneEvent(el, 'close');\n        const overlay = el.shadowRoot.querySelector(\n            'sp-underlay'\n        ) as HTMLElement;\n        overlay.click();\n        await closed;\n\n        expect(el.open).to.be.false;\n    });\n});\n"]}