@spectrum-web-components/contextual-help 0.44.0 → 0.46.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/contextual-help",
-    "version": "0.44.0",
+    "version": "0.46.0",
     "publishConfig": {
         "access": "public"
     },
@@ -57,12 +57,12 @@
         "lit-html"
     ],
     "dependencies": {
-        "@spectrum-web-components/action-button": "^0.44.0",
-        "@spectrum-web-components/base": "^0.44.0",
-        "@spectrum-web-components/dialog": "^0.44.0",
-        "@spectrum-web-components/icons-workflow": "^0.44.0",
-        "@spectrum-web-components/overlay": "^0.44.0",
-        "@spectrum-web-components/popover": "^0.44.0"
+        "@spectrum-web-components/action-button": "^0.46.0",
+        "@spectrum-web-components/base": "^0.46.0",
+        "@spectrum-web-components/dialog": "^0.46.0",
+        "@spectrum-web-components/icons-workflow": "^0.46.0",
+        "@spectrum-web-components/overlay": "^0.46.0",
+        "@spectrum-web-components/popover": "^0.46.0"
     },
     "devDependencies": {
         "@spectrum-css/contextualhelp": "^2.1.5"
@@ -74,5 +74,5 @@
         "./**/*.dev.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "0002d42ce82463b85022e5aa5f7aba8484cba096"
+    "gitHead": "ab84b447210de593649b086a1605abf1be1d64f2"
 }

package/sp-contextual-help.d.ts

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

package/src/ContextualHelp.d.ts

@@ -0,0 +1,47 @@
+import { CSSResultArray, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
+import '@spectrum-web-components/action-button/sp-action-button.js';
+import '@spectrum-web-components/overlay/sp-overlay.js';
+import '@spectrum-web-components/icons-workflow/icons/sp-icon-help-outline.js';
+import '@spectrum-web-components/icons-workflow/icons/sp-icon-info-outline.js';
+import type { Placement } from '@spectrum-web-components/overlay/src/overlay-types.js';
+import { MatchMediaController } from '@spectrum-web-components/reactive-controllers/src/MatchMedia.js';
+/**
+ * Spectrum Contextual help provides additional information about
+ * the state of either an adjacent component or an entire view.
+ * @element sp-contextual-help
+ *
+ * @slot heading - content to display as the heading of the popover
+ * @slot Text content to display in the popover
+ * @slot link - link to additional informations
+ */
+export declare class ContextualHelp extends SpectrumElement {
+    protected isMobile: MatchMediaController;
+    static get styles(): CSSResultArray;
+    /**
+     * Provides an accessible name for the action button trigger.
+     * @param {String} label
+     */
+    label?: string;
+    /**
+     * The `variant` property applies specific styling on the action button trigger.
+     * @param {String} variant
+     */
+    variant: 'info' | 'help';
+    /**
+     * @type {"top" | "top-start" | "top-end" | "right" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end"}
+     * @attr
+     */
+    placement?: Placement;
+    /**
+     * The `offset` property accepts either a single number, to
+     * define the offset of the Popover along the main axis from
+     * the action button, or 2-tuple, to define the offset along the
+     * main axis and the cross axis.
+     */
+    offset: number | [number, number];
+    open: boolean;
+    private get buttonAriaLabel();
+    private renderOverlayContent;
+    private handleSlottableRequest;
+    protected render(): TemplateResult;
+}

package/src/contextual-help.css.d.ts

@@ -0,0 +1,2 @@
+declare const styles: import("@spectrum-web-components/base").CSSResult;
+export default styles;

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './ContextualHelp.js';

package/src/spectrum-contextual-help.css.d.ts

@@ -0,0 +1,2 @@
+declare const styles: import("@spectrum-web-components/base").CSSResult;
+export default styles;