@spectrum-web-components/coachmark 0.40.4 → 0.41.0

package/custom-elements.json

@@ -2,6 +2,21 @@
   "schemaVersion": "1.0.0",
   "readme": "",
   "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "sp-coach-indicator.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "sp-coach-indicator",
+          "declaration": {
+            "name": "CoachIndicator",
+            "module": "/src/CoachIndicator.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "sp-coachmark.js",
@@ -19,12 +34,12 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/Coachmark.js",
+      "path": "src/CoachIndicator.js",
       "declarations": [
         {
           "kind": "class",
           "description": "",
-          "name": "Coachmark",
+          "name": "CoachIndicator",
           "members": [
             {
               "kind": "field",
@@ -37,14 +52,23 @@
               "attribute": "quiet",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "static",
+              "type": {
+                "text": "'white' | 'black' | undefined"
+              },
+              "privacy": "public",
+              "attribute": "static",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "variant",
               "type": {
-                "text": "'dark' | 'light' | ''"
+                "text": "'white' | 'black' | undefined"
               },
               "privacy": "public",
-              "default": "''",
               "attribute": "variant",
               "reflects": true
             }
@@ -58,12 +82,18 @@
               "default": "false",
               "fieldName": "quiet"
             },
+            {
+              "name": "static",
+              "type": {
+                "text": "'white' | 'black' | undefined"
+              },
+              "fieldName": "static"
+            },
             {
               "name": "variant",
               "type": {
-                "text": "'dark' | 'light' | ''"
+                "text": "'white' | 'black' | undefined"
               },
-              "default": "''",
               "fieldName": "variant"
             }
           ],
@@ -71,6 +101,425 @@
             "name": "SpectrumElement",
             "package": "@spectrum-web-components/base"
           },
+          "tagName": "sp-coach-indicator",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "CoachIndicator",
+          "declaration": {
+            "name": "CoachIndicator",
+            "module": "src/CoachIndicator.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/Coachmark.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "Coachmark",
+          "slots": [
+            {
+              "description": "This is the cover photo for Default and Quiet Coachmark",
+              "name": "cover-photo"
+            },
+            {
+              "description": "HTML content to be listed as the heading",
+              "name": "heading"
+            },
+            {
+              "description": "A description of the card",
+              "name": "description"
+            },
+            {
+              "description": "an `sp-action-menu` element outlining actions to take on the represened object",
+              "name": "actions"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "item",
+              "type": {
+                "text": "CoachmarkItem | undefined"
+              },
+              "privacy": "public",
+              "attribute": "item"
+            },
+            {
+              "kind": "field",
+              "name": "placement",
+              "type": {
+                "text": "Placement"
+              },
+              "privacy": "public",
+              "default": "'right'",
+              "attribute": "placement"
+            },
+            {
+              "kind": "field",
+              "name": "content",
+              "type": {
+                "text": "{\n        title?: string;\n        description?: string;\n        imageAlt?: string;\n    } | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "shortcutKey",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "private",
+              "attribute": "shortcut-key"
+            },
+            {
+              "kind": "field",
+              "name": "modifierKeys",
+              "type": {
+                "text": "string[] | undefined"
+              },
+              "privacy": "public",
+              "default": "[]",
+              "attribute": "modifierKeys"
+            },
+            {
+              "kind": "field",
+              "name": "source",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "private",
+              "attribute": "src"
+            },
+            {
+              "kind": "field",
+              "name": "mediaType",
+              "type": {
+                "text": "MediaType | undefined"
+              },
+              "privacy": "private",
+              "attribute": "media-type"
+            },
+            {
+              "kind": "field",
+              "name": "hasAsset",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false",
+              "attribute": "has-asset",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "asset",
+              "type": {
+                "text": "'file' | 'folder' | undefined"
+              },
+              "privacy": "public",
+              "attribute": "asset"
+            },
+            {
+              "kind": "field",
+              "name": "currentStep",
+              "type": {
+                "text": "number | undefined"
+              },
+              "privacy": "public",
+              "attribute": "current-step"
+            },
+            {
+              "kind": "field",
+              "name": "totalSteps",
+              "type": {
+                "text": "number | undefined"
+              },
+              "privacy": "public",
+              "attribute": "total-steps"
+            },
+            {
+              "kind": "field",
+              "name": "primaryCTA",
+              "type": {
+                "text": "string | undefined"
+              },
+              "attribute": "primary-cta"
+            },
+            {
+              "kind": "field",
+              "name": "secondaryCTA",
+              "type": {
+                "text": "string | undefined"
+              },
+              "attribute": "secondary-cta"
+            },
+            {
+              "kind": "method",
+              "name": "renderMedia",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "renderModifier",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "modifierKey",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "type",
+                  "default": "'modifier'",
+                  "type": {
+                    "text": "'modifier' | 'shortcut'"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "renderJoiner",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "renderHeader",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "renderContent",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "stopPropagationOnHref",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "handlePrimaryCTA",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "handleSecondaryCTA",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "renderSecondaryButton",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "renderPrimaryButton",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "renderSecondaryButtonMobile",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "renderPrimaryButtonMobile",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "renderButtons",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "renderSteps",
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "renderActionMenu",
+              "privacy": "protected"
+            }
+          ],
+          "events": [
+            {
+              "name": "primary",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Announces that the \"primary\" button has been clicked."
+            },
+            {
+              "name": "secondary",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Announces that the \"secondary\" button has been clicked."
+            }
+          ],
+          "attributes": [
+            {
+              "name": "item",
+              "type": {
+                "text": "CoachmarkItem | undefined"
+              },
+              "fieldName": "item"
+            },
+            {
+              "name": "placement",
+              "type": {
+                "text": "Placement"
+              },
+              "default": "'right'",
+              "fieldName": "placement"
+            },
+            {
+              "name": "shortcut-key",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "shortcutKey"
+            },
+            {
+              "name": "modifierKeys",
+              "type": {
+                "text": "string[] | undefined"
+              },
+              "default": "[]",
+              "fieldName": "modifierKeys"
+            },
+            {
+              "name": "src",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "source"
+            },
+            {
+              "name": "media-type",
+              "type": {
+                "text": "MediaType | undefined"
+              },
+              "fieldName": "mediaType"
+            },
+            {
+              "name": "has-asset",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "hasAsset"
+            },
+            {
+              "name": "asset",
+              "type": {
+                "text": "'file' | 'folder' | undefined"
+              },
+              "fieldName": "asset"
+            },
+            {
+              "name": "current-step",
+              "type": {
+                "text": "number | undefined"
+              },
+              "fieldName": "currentStep"
+            },
+            {
+              "name": "total-steps",
+              "type": {
+                "text": "number | undefined"
+              },
+              "fieldName": "totalSteps"
+            },
+            {
+              "name": "primary-cta",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "primaryCTA"
+            },
+            {
+              "name": "secondary-cta",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "secondaryCTA"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "LikeAnchor",
+              "package": "@spectrum-web-components/shared/src/like-anchor.js"
+            }
+          ],
+          "superclass": {
+            "name": "Popover",
+            "package": "@spectrum-web-components/popover"
+          },
           "tagName": "sp-coachmark",
           "customElement": true
         }
@@ -85,6 +534,12 @@
           }
         }
       ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/CoachmarkItem.js",
+      "declarations": [],
+      "exports": []
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/coachmark",
-    "version": "0.40.4",
+    "version": "0.41.0",
     "publishConfig": {
         "access": "public"
     },
@@ -25,10 +25,19 @@
             "default": "./src/index.js"
         },
         "./package.json": "./package.json",
+        "./src/CoachIndicator.js": {
+            "development": "./src/CoachIndicator.dev.js",
+            "default": "./src/CoachIndicator.js"
+        },
         "./src/Coachmark.js": {
             "development": "./src/Coachmark.dev.js",
             "default": "./src/Coachmark.js"
         },
+        "./src/CoachmarkItem.js": {
+            "development": "./src/CoachmarkItem.dev.js",
+            "default": "./src/CoachmarkItem.js"
+        },
+        "./src/coach-indicator.css.js": "./src/coach-indicator.css.js",
         "./src/coachmark.css.js": "./src/coachmark.css.js",
         "./src/index.js": {
             "development": "./src/index.dev.js",
@@ -37,6 +46,10 @@
         "./sp-coachmark.js": {
             "development": "./sp-coachmark.dev.js",
             "default": "./sp-coachmark.js"
+        },
+        "./sp-coach-indicator.js": {
+            "development": "./sp-coach-indicator.dev.js",
+            "default": "./sp-coach-indicator.js"
         }
     },
     "scripts": {
@@ -57,10 +70,19 @@
         "lit-html"
     ],
     "dependencies": {
-        "@spectrum-web-components/base": "^0.40.4"
+        "@spectrum-web-components/asset": "^0.41.0",
+        "@spectrum-web-components/base": "^0.41.0",
+        "@spectrum-web-components/button": "^0.41.0",
+        "@spectrum-web-components/button-group": "^0.41.0",
+        "@spectrum-web-components/icon": "^0.41.0",
+        "@spectrum-web-components/icons-ui": "^0.41.0",
+        "@spectrum-web-components/quick-actions": "^0.41.0",
+        "@spectrum-web-components/reactive-controllers": "^0.41.0",
+        "@spectrum-web-components/shared": "^0.41.0"
     },
     "devDependencies": {
-        "@spectrum-css/coachmark": "^5.0.75"
+        "@spectrum-css/coachindicator": "1.0.0",
+        "@spectrum-css/coachmark": "6.0.0"
     },
     "types": "./src/index.d.ts",
     "customElements": "custom-elements.json",
@@ -68,5 +90,5 @@
         "./sp-*.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "e7bca020d0da71c4d92e95044bf58780d2e8e603"
+    "gitHead": "0bf38fd427adc39804b228a4c61de623e5ebb82e"
 }

package/sp-coach-indicator.d.ts

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

package/sp-coach-indicator.dev.js

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

package/sp-coach-indicator.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-coach-indicator.ts"],
+  "sourcesContent": ["/*\nCopyright 2023 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 { CoachIndicator } from './src/CoachIndicator.dev.js'\n\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\ndefineElement('sp-coach-indicator', CoachIndicator);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-coach-indicator': CoachIndicator;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,sBAAsB;AAE/B,SAAS,qBAAqB;AAC9B,cAAc,sBAAsB,cAAc;",
+  "names": []
+}

package/sp-coach-indicator.js

@@ -0,0 +1,2 @@
+"use strict";import{CoachIndicator as a}from"./src/CoachIndicator.js";import{defineElement as o}from"@spectrum-web-components/base/src/define-element.js";o("sp-coach-indicator",a);
+//# sourceMappingURL=sp-coach-indicator.js.map

package/sp-coach-indicator.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-coach-indicator.ts"],
+  "sourcesContent": ["/*\nCopyright 2023 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 { CoachIndicator } from './src/CoachIndicator.js';\n\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\ndefineElement('sp-coach-indicator', CoachIndicator);\n\ndeclare global {\n    interface HTMLElementTagNameMap {\n        'sp-coach-indicator': CoachIndicator;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,kBAAAA,MAAsB,0BAE/B,OAAS,iBAAAC,MAAqB,sDAC9BA,EAAc,qBAAsBD,CAAc",
+  "names": ["CoachIndicator", "defineElement"]
+}

package/src/CoachIndicator.d.ts

@@ -0,0 +1,12 @@
+import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
+/**
+ * @element sp-coach-indicator
+ */
+export declare class CoachIndicator extends SpectrumElement {
+    static get styles(): CSSResultArray;
+    quiet: boolean;
+    static?: 'white' | 'black';
+    variant?: 'white' | 'black';
+    protected render(): TemplateResult;
+    protected updated(changes: PropertyValues): void;
+}