@spectrum-web-components/menu 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/menu",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "publishConfig": {
         "access": "public"
     },
@@ -90,15 +90,15 @@
     ],
     "dependencies": {
         "@lit-labs/observers": "^2.0.2",
-        "@spectrum-web-components/action-button": "^1.1.0",
-        "@spectrum-web-components/base": "^1.1.0",
-        "@spectrum-web-components/divider": "^1.1.0",
-        "@spectrum-web-components/icon": "^1.1.0",
-        "@spectrum-web-components/icons-ui": "^1.1.0",
-        "@spectrum-web-components/overlay": "^1.1.0",
-        "@spectrum-web-components/popover": "^1.1.0",
-        "@spectrum-web-components/reactive-controllers": "^1.1.0",
-        "@spectrum-web-components/shared": "^1.1.0"
+        "@spectrum-web-components/action-button": "^1.1.1",
+        "@spectrum-web-components/base": "^1.1.1",
+        "@spectrum-web-components/divider": "^1.1.1",
+        "@spectrum-web-components/icon": "^1.1.1",
+        "@spectrum-web-components/icons-ui": "^1.1.1",
+        "@spectrum-web-components/overlay": "^1.1.1",
+        "@spectrum-web-components/popover": "^1.1.1",
+        "@spectrum-web-components/reactive-controllers": "^1.1.1",
+        "@spectrum-web-components/shared": "^1.1.1"
     },
     "devDependencies": {
         "@spectrum-css/menu": "8.0.0-s2-foundations.16"
@@ -109,5 +109,5 @@
         "./sp-*.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "e3c6e52501451acc6fa85b10dd718267b80a01ab"
+    "gitHead": "44870aa95001c1b995456d994ae31bbe7277fac9"
 }

package/sp-menu-divider.d.ts

@@ -0,0 +1,6 @@
+import { MenuDivider } from './src/MenuDivider.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-menu-divider': MenuDivider;
+    }
+}

package/sp-menu-divider.dev.js

@@ -0,0 +1,5 @@
+"use strict";
+import { MenuDivider } from "./src/MenuDivider.dev.js";
+import { defineElement } from "@spectrum-web-components/base/src/define-element.js";
+defineElement("sp-menu-divider", MenuDivider);
+//# sourceMappingURL=sp-menu-divider.dev.js.map

package/sp-menu-divider.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-divider.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*/\nimport { MenuDivider } from './src/MenuDivider.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-divider', MenuDivider);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-divider': MenuDivider;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,mBAAmB;AAC5B,SAAS,qBAAqB;AAE9B,cAAc,mBAAmB,WAAW;",
+  "names": []
+}

package/sp-menu-divider.js

@@ -0,0 +1,2 @@
+"use strict";import{MenuDivider as e}from"./src/MenuDivider.js";import{defineElement as i}from"@spectrum-web-components/base/src/define-element.js";i("sp-menu-divider",e);
+//# sourceMappingURL=sp-menu-divider.js.map

package/sp-menu-divider.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-divider.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*/\nimport { MenuDivider } from './src/MenuDivider.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-divider', MenuDivider);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-divider': MenuDivider;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,eAAAA,MAAmB,uBAC5B,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,kBAAmBD,CAAW",
+  "names": ["MenuDivider", "defineElement"]
+}

package/sp-menu-group.d.ts

@@ -0,0 +1,6 @@
+import { MenuGroup } from './src/MenuGroup.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-menu-group': MenuGroup;
+    }
+}

package/sp-menu-group.dev.js

@@ -0,0 +1,5 @@
+"use strict";
+import { MenuGroup } from "./src/MenuGroup.dev.js";
+import { defineElement } from "@spectrum-web-components/base/src/define-element.js";
+defineElement("sp-menu-group", MenuGroup);
+//# sourceMappingURL=sp-menu-group.dev.js.map

package/sp-menu-group.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-group.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*/\nimport { MenuGroup } from './src/MenuGroup.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-group', MenuGroup);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-group': MenuGroup;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,iBAAiB;AAC1B,SAAS,qBAAqB;AAE9B,cAAc,iBAAiB,SAAS;",
+  "names": []
+}

package/sp-menu-group.js

@@ -0,0 +1,2 @@
+"use strict";import{MenuGroup as e}from"./src/MenuGroup.js";import{defineElement as r}from"@spectrum-web-components/base/src/define-element.js";r("sp-menu-group",e);
+//# sourceMappingURL=sp-menu-group.js.map

package/sp-menu-group.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-group.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*/\nimport { MenuGroup } from './src/MenuGroup.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-group', MenuGroup);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-group': MenuGroup;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,aAAAA,MAAiB,qBAC1B,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,gBAAiBD,CAAS",
+  "names": ["MenuGroup", "defineElement"]
+}

package/sp-menu-item.d.ts

@@ -0,0 +1,6 @@
+import { MenuItem } from './src/MenuItem.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-menu-item': MenuItem;
+    }
+}

package/sp-menu-item.dev.js

@@ -0,0 +1,5 @@
+"use strict";
+import { MenuItem } from "./src/MenuItem.dev.js";
+import { defineElement } from "@spectrum-web-components/base/src/define-element.js";
+defineElement("sp-menu-item", MenuItem);
+//# sourceMappingURL=sp-menu-item.dev.js.map

package/sp-menu-item.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-item.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*/\nimport { MenuItem } from './src/MenuItem.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-item', MenuItem);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-item': MenuItem;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,gBAAgB;AACzB,SAAS,qBAAqB;AAE9B,cAAc,gBAAgB,QAAQ;",
+  "names": []
+}

package/sp-menu-item.js

@@ -0,0 +1,2 @@
+"use strict";import{MenuItem as e}from"./src/MenuItem.js";import{defineElement as m}from"@spectrum-web-components/base/src/define-element.js";m("sp-menu-item",e);
+//# sourceMappingURL=sp-menu-item.js.map

package/sp-menu-item.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu-item.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*/\nimport { MenuItem } from './src/MenuItem.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-item', MenuItem);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu-item': MenuItem;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,YAAAA,MAAgB,oBACzB,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,eAAgBD,CAAQ",
+  "names": ["MenuItem", "defineElement"]
+}

package/sp-menu.d.ts

@@ -0,0 +1,6 @@
+import { Menu } from './src/Menu.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-menu': Menu;
+    }
+}

package/sp-menu.dev.js

@@ -0,0 +1,5 @@
+"use strict";
+import { Menu } from "./src/Menu.dev.js";
+import { defineElement } from "@spectrum-web-components/base/src/define-element.js";
+defineElement("sp-menu", Menu);
+//# sourceMappingURL=sp-menu.dev.js.map

package/sp-menu.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu.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*/\nimport { Menu } from './src/Menu.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu', Menu);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu': Menu;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,YAAY;AACrB,SAAS,qBAAqB;AAE9B,cAAc,WAAW,IAAI;",
+  "names": []
+}

package/sp-menu.js

@@ -0,0 +1,2 @@
+"use strict";import{Menu as e}from"./src/Menu.js";import{defineElement as m}from"@spectrum-web-components/base/src/define-element.js";m("sp-menu",e);
+//# sourceMappingURL=sp-menu.js.map

package/sp-menu.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-menu.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*/\nimport { Menu } from './src/Menu.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu', Menu);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-menu': Menu;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,QAAAA,MAAY,gBACrB,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,UAAWD,CAAI",
+  "names": ["Menu", "defineElement"]
+}

package/src/Menu.d.ts

@@ -0,0 +1,118 @@
+import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
+import { MenuItem } from './MenuItem.js';
+export interface MenuChildItem {
+    menuItem: MenuItem;
+    managed: boolean;
+    active: boolean;
+    focusable: boolean;
+    focusRoot: Menu;
+}
+declare const Menu_base: typeof SpectrumElement & {
+    new (...args: any[]): import("@spectrum-web-components/base").SizedElementInterface;
+    prototype: import("@spectrum-web-components/base").SizedElementInterface;
+};
+/**
+ * Spectrum Menu Component
+ * @element sp-menu
+ *
+ * @slot - menu items to be listed in the menu
+ * @fires change - Announces that the `value` of the element has changed
+ * @attr selects - whether the element has a specific selection algorithm that it applies
+ *   to its item descendants. `single` allows only one descendent to be selected at a time.
+ *   `multiple` allows many descendants to be selected. `inherit` will be applied dynamically
+ *   when an ancestor of this element is actively managing the selection of its descendents.
+ *   When the `selects` attribute is not present a `value` will not be maintained and the Menu
+ *   Item children of this Menu will not have their `selected` state managed.
+ */
+export declare class Menu extends Menu_base {
+    static get styles(): CSSResultArray;
+    private get isSubmenu();
+    label: string;
+    ignore: boolean;
+    selects: undefined | 'inherit' | 'single' | 'multiple';
+    value: string;
+    valueSeparator: string;
+    get selected(): string[];
+    set selected(selected: string[]);
+    protected _selected: string[];
+    selectedItems: MenuItem[];
+    menuSlot: HTMLSlotElement;
+    private childItemSet;
+    focusedItemIndex: number;
+    focusInItemIndex: number;
+    private selectedItemsMap;
+    get childItems(): MenuItem[];
+    private cachedChildItems;
+    private updateCachedMenuItems;
+    /**
+     * Hide this getter from web-component-analyzer until
+     * https://github.com/runem/web-component-analyzer/issues/131
+     * has been addressed.
+     *
+     * @private
+     */
+    get childRole(): string;
+    protected get ownRole(): string;
+    private resolvedSelects?;
+    private resolvedRole?;
+    /**
+     * When a descendant `<sp-menu-item>` element is added or updated it will dispatch
+     * this event to announce its presence in the DOM. During the CAPTURE phase the first
+     * Menu based element that the event encounters will manage the focus state of the
+     * dispatching `<sp-menu-item>` element.
+     * @param event
+     */
+    private onFocusableItemAddedOrUpdated;
+    /**
+     * When a descendant `<sp-menu-item>` element is added or updated it will dispatch
+     * this event to announce its presence in the DOM. During the BUBBLE phase the first
+     * Menu based element that the event encounters that does not inherit selection will
+     * manage the selection state of the dispatching `<sp-menu-item>` element.
+     * @param event
+     */
+    private onSelectableItemAddedOrUpdated;
+    private addChildItem;
+    private removeChildItem;
+    constructor();
+    focus({ preventScroll }?: FocusOptions): void;
+    private pointerUpTarget;
+    private handleClick;
+    private handlePointerup;
+    private handlePointerBasedSelection;
+    handleFocusin(event: FocusEvent): void;
+    startListeningToKeyboard(): void;
+    handleBlur(event: FocusEvent): void;
+    stopListeningToKeyboard(): void;
+    private descendentOverlays;
+    protected handleDescendentOverlayOpened(event: Event): void;
+    protected handleDescendentOverlayClosed(event: Event): void;
+    handleSubmenuClosed: (event: Event) => void;
+    handleSubmenuOpened: (event: Event) => void;
+    selectOrToggleItem(targetItem: MenuItem): Promise<void>;
+    protected navigateWithinMenu(event: KeyboardEvent): void;
+    protected navigateBetweenRelatedMenus(event: KeyboardEvent): void;
+    handleKeydown(event: KeyboardEvent): void;
+    focusMenuItemByOffset(offset: number): MenuItem;
+    private prepareToCleanUp;
+    private _hasUpdatedSelectedItemIndex;
+    updateSelectedItemIndex(): void;
+    private _willUpdateItems;
+    private handleItemsChanged;
+    private updateCache;
+    private updateItemFocus;
+    closeDescendentOverlays(): void;
+    private forwardFocusVisibleToItem;
+    private handleSlotchange;
+    protected renderMenuItemSlot(): TemplateResult;
+    render(): TemplateResult;
+    protected firstUpdated(changed: PropertyValues): void;
+    protected updated(changes: PropertyValues<this>): void;
+    protected selectsChanged(): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected childItemsUpdated: Promise<unknown[]>;
+    protected cacheUpdated: Promise<void>;
+    protected resolveCacheUpdated: () => void;
+    protected getUpdateComplete(): Promise<boolean>;
+}
+export {};