npm - @esri/calcite-components - Versions diffs - 1.9.0-next.1 → 1.9.0-next.11 - Mend

@esri/calcite-components 1.9.0-next.1 → 1.9.0-next.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1155) hide show

package/dist/collection/components/panel/assets/panel/t9n/messages.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Close",
-  "options": "Options"
+  "options": "Options",
+  "collapse": "Collapse",
+  "expand": "Expand"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ar.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "إغلاق",
-  "options": "خيارات"
+  "options": "خيارات",
+  "collapse": "طي",
+  "expand": "توسيع"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_bg.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Затваряне",
-  "options": "Опции"
+  "options": "Опции",
+  "collapse": "Сгъване",
+  "expand": "Разгъване"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_bs.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zatvori",
-  "options": "Opcije"
+  "options": "Opcije",
+  "collapse": "Sažmi",
+  "expand": "Proširi"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ca.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Tanca",
-  "options": "Opcions"
+  "options": "Opcions",
+  "collapse": "Redueix",
+  "expand": "Amplia"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_cs.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zavřít",
-  "options": "Možnosti"
+  "options": "Možnosti",
+  "collapse": "Sbalit",
+  "expand": "Rozbalit"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_da.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Luk",
-  "options": "Indstillinger"
+  "options": "Indstillinger",
+  "collapse": "Skjul",
+  "expand": "Udvid"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_de.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Schließen",
-  "options": "Optionen"
+  "options": "Optionen",
+  "collapse": "Ausblenden",
+  "expand": "Einblenden"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_el.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Κλείσιμο",
-  "options": "Επιλογές"
+  "options": "Επιλογές",
+  "collapse": "Σύμπτυξη",
+  "expand": "Ανάπτυξη"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_en.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Close",
-  "options": "Options"
+  "options": "Options",
+  "collapse": "Collapse",
+  "expand": "Expand"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_es.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Cerrar",
-  "options": "Opciones"
+  "options": "Opciones",
+  "collapse": "Contraer",
+  "expand": "Expandir"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_et.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Sule",
-  "options": "Valikud"
+  "options": "Valikud",
+  "collapse": "Ahenda",
+  "expand": "Laienda"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_fi.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Sulje",
-  "options": "Asetukset"
+  "options": "Asetukset",
+  "collapse": "Kutista",
+  "expand": "Laajenna"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_fr.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Fermer",
-  "options": "Options"
+  "options": "Options",
+  "collapse": "Réduire",
+  "expand": "Développer"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_he.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "סגירה",
-  "options": "אפשרויות"
+  "options": "אפשרויות",
+  "collapse": "צמצם",
+  "expand": "הרחב"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_hr.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zatvori",
-  "options": "Opcije"
+  "options": "Opcije",
+  "collapse": "Sažmi",
+  "expand": "Proširi"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_hu.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Bezárás",
-  "options": "Beállítási lehetőségek"
+  "options": "Beállítási lehetőségek",
+  "collapse": "Összecsukás",
+  "expand": "Kibontás"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_id.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Tutup",
-  "options": "Opsi"
+  "options": "Opsi",
+  "collapse": "Tutup",
+  "expand": "Bentang"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_it.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Chiudi",
-  "options": "Opzioni"
+  "options": "Opzioni",
+  "collapse": "Comprimi",
+  "expand": "Espandi"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ja.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "閉じる",
-  "options": "オプション"
+  "options": "オプション",
+  "collapse": "折りたたむ",
+  "expand": "展開"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ko.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "닫기",
-  "options": "옵션"
+  "options": "옵션",
+  "collapse": "축소",
+  "expand": "확장"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_lt.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Uždaryti",
-  "options": "Parinktys"
+  "options": "Parinktys",
+  "collapse": "Suskleisti",
+  "expand": "Išskleisti"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_lv.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Aizvērt",
-  "options": "Opcijas"
+  "options": "Opcijas",
+  "collapse": "Sakļaut",
+  "expand": "Izvērst"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_nl.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Sluiten",
-  "options": "Opties"
+  "options": "Opties",
+  "collapse": "Inklappen",
+  "expand": "Uitklappen"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_no.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Lukk",
-  "options": "Alternativer"
+  "options": "Alternativer",
+  "collapse": "Skjul",
+  "expand": "Utvid"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_pl.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zamknij",
-  "options": "Opcje"
+  "options": "Opcje",
+  "collapse": "Zwiń",
+  "expand": "Rozwiń"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_pt-BR.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Fechar",
-  "options": "Opções"
+  "options": "Opções",
+  "collapse": "Recolher",
+  "expand": "Expandir"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_pt-PT.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Fechar",
-  "options": "Opções"
+  "options": "Opções",
+  "collapse": "Recolher",
+  "expand": "Expandir"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ro.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Închidere",
-  "options": "Opţiuni"
+  "options": "Opţiuni",
+  "collapse": "Restrângere",
+  "expand": "Extindere"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_ru.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Закрыть",
-  "options": "Опции"
+  "options": "Опции",
+  "collapse": "Свернуть",
+  "expand": "Развернуть"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_sk.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zatvoriť",
-  "options": "Možnosti"
+  "options": "Možnosti",
+  "collapse": "Zbaliť",
+  "expand": "Rozbaliť"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_sl.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zapri",
-  "options": "Možnosti"
+  "options": "Možnosti",
+  "collapse": "Strni",
+  "expand": "Razširi"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_sr.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Zatvori",
-  "options": "Opcije"
+  "options": "Opcije",
+  "collapse": "Skupi",
+  "expand": "Proširi"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_sv.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Stäng",
-  "options": "Alternativ"
+  "options": "Alternativ",
+  "collapse": "Dölj",
+  "expand": "Expandera"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_th.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "ปิด",
-  "options": "ตัวเลือก"
+  "options": "ตัวเลือก",
+  "collapse": "ย่อลงมา",
+  "expand": "ขยาย"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_tr.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Kapat",
-  "options": "Seçenekler"
+  "options": "Seçenekler",
+  "collapse": "Daralt",
+  "expand": "Genişlet"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_uk.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Закрити",
-  "options": "Опції"
+  "options": "Опції",
+  "collapse": "Згорнути",
+  "expand": "Розширити"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_vi.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "Đóng",
-  "options": "Tùy chọn"
+  "options": "Tùy chọn",
+  "collapse": "Thu gọn",
+  "expand": "Mở rộng"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_zh-CN.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "关闭",
-  "options": "选项"
+  "options": "选项",
+  "collapse": "折叠",
+  "expand": "展开"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_zh-HK.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "關閉",
-  "options": "選項"
+  "options": "選項",
+  "collapse": "摺疊",
+  "expand": "展開"
 }

package/dist/collection/components/panel/assets/panel/t9n/messages_zh-TW.json CHANGED Viewed

@@ -1,4 +1,6 @@
 {
   "close": "關閉",
-  "options": "選項"
+  "options": "選項",
+  "collapse": "摺疊",
+  "expand": "展開"
 }

package/dist/collection/components/panel/panel.css CHANGED Viewed

@@ -36,6 +36,7 @@
 * These properties can be overridden using the component's tag as selector.
 *
 * @prop --calcite-panel-footer-padding: Specifies the padding of the component's footer.
+* @prop --calcite-panel-header-border-block-end: Specifies the component header's block end border.
 */
 :host {
   position: relative;
@@ -45,8 +46,6 @@
   flex: 1 1 auto;
   overflow: hidden;
   --calcite-min-header-height: calc(var(--calcite-icon-size) * 3);
-  --calcite-panel-footer-padding: 0.5rem;
-  --calcite-internal-panel-header-border-block-end: 1px solid var(--calcite-ui-border-3);
 }
 :host([disabled]) ::slotted([calcite-hydrated][disabled]),
@@ -97,7 +96,7 @@
   display: flex;
   flex-direction: column;
   background-color: var(--calcite-ui-foreground-1);
-  border-block-end: var(--calcite-internal-panel-header-border-block-end);
+  border-block-end: var(--calcite-panel-header-border-block-end, 1px solid var(--calcite-ui-border-3));
 }
 .header-container {
@@ -186,7 +185,7 @@
   justify-content: space-evenly;
   background-color: var(--calcite-ui-foreground-1);
   flex: 0 0 auto;
-  padding: var(--calcite-panel-footer-padding);
+  padding: var(--calcite-panel-footer-padding, 0.5rem);
   border-block-start: 1px solid var(--calcite-ui-border-3);
 }

package/dist/collection/components/panel/panel.js CHANGED Viewed

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-design-system/blob/main/LICENSE.md for details.
- * v1.9.0-next.1
+ * v1.9.0-next.11
  */
 import { Fragment, h, } from "@stencil/core";
 import { focusFirstTabbable, slotChangeGetAssignedElements, slotChangeHasAssignedElement, toAriaBoolean, } from "../../utils/dom";
@@ -44,12 +44,6 @@ export class Panel {
     this.setContainerRef = (node) => {
       this.containerEl = node;
     };
-    this.setCloseRef = (node) => {
-      this.closeButtonEl = node;
-    };
-    this.setBackRef = (node) => {
-      this.backButtonEl = node;
-    };
     this.panelKeyDownHandler = (event) => {
       if (this.closable && event.key === "Escape" && !event.defaultPrevented) {
         this.close();
@@ -60,6 +54,10 @@ export class Panel {
       this.closed = true;
       this.calcitePanelClose.emit();
     };
+    this.collapse = () => {
+      this.collapsed = !this.collapsed;
+      this.calcitePanelToggle.emit();
+    };
     this.panelScrollHandler = () => {
       this.calcitePanelScroll.emit();
     };
@@ -100,6 +98,9 @@ export class Panel {
     this.closed = false;
     this.disabled = false;
     this.closable = false;
+    this.collapsed = false;
+    this.collapseDirection = "down";
+    this.collapsible = false;
     this.headingLevel = undefined;
     this.loading = false;
     this.heading = undefined;
@@ -172,7 +173,8 @@ export class Panel {
    *   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element
    *   behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).
    * });
-   * @param options
+   * @param options - allows specific coordinates to be defined.
+   * @returns - promise that resolves once the content is scrolled to.
    */
   async scrollContentTo(options) {
     this.panelScrollEl?.scrollTo(options);
@@ -191,9 +193,6 @@ export class Panel {
   renderActionBar() {
     return (h("div", { class: CSS.actionBarContainer, hidden: !this.hasActionBar }, h("slot", { name: SLOTS.actionBar, onSlotchange: this.handleActionBarSlotChange })));
   }
-  /**
-   * Allows user to override the entire header-content node.
-   */
   renderHeaderSlottedContent() {
     return (h("div", { class: CSS.headerContent, hidden: !this.hasHeaderContent, key: "slotted-header-content" }, h("slot", { name: SLOTS.headerContent, onSlotchange: this.handleHeaderContentSlotChange })));
   }
@@ -202,26 +201,30 @@ export class Panel {
     return (h("div", { class: { [CSS.headerActionsStart]: true, [CSS.headerActions]: true }, hidden: !hasStartActions, key: "header-actions-start" }, h("slot", { name: SLOTS.headerActionsStart, onSlotchange: this.handleHeaderActionsStartSlotChange })));
   }
   renderHeaderActionsEnd() {
-    const { close, hasEndActions, messages, closable, hasMenuItems } = this;
-    const text = messages.close;
-    const closableNode = closable ? (h("calcite-action", { "aria-label": text, "data-test": "close", icon: ICONS.close, onClick: close, text: text, title: text,
-      // eslint-disable-next-line react/jsx-sort-props -- ref should be last so node attrs/props are in sync (see https://github.com/Esri/calcite-design-system/pull/6530)
-      ref: this.setCloseRef })) : null;
+    const { hasEndActions, messages, closable, collapsed, collapseDirection, collapsible, hasMenuItems, } = this;
+    const { collapse, expand, close } = messages;
+    const icons = [ICONS.expand, ICONS.collapse];
+    if (collapseDirection === "up") {
+      icons.reverse();
+    }
+    const collapseNode = collapsible ? (h("calcite-action", { "aria-expanded": toAriaBoolean(!collapsed), "aria-label": collapse, "data-test": "collapse", icon: collapsed ? icons[0] : icons[1], onClick: this.collapse, text: collapse, title: !collapsed ? expand : collapse })) : null;
+    const closeNode = closable ? (h("calcite-action", { "aria-label": close, "data-test": "close", icon: ICONS.close, onClick: this.close, text: close, title: close })) : null;
     const slotNode = (h("slot", { name: SLOTS.headerActionsEnd, onSlotchange: this.handleHeaderActionsEndSlotChange }));
-    const showContainer = hasEndActions || closableNode || hasMenuItems;
-    return (h("div", { class: { [CSS.headerActionsEnd]: true, [CSS.headerActions]: true }, hidden: !showContainer, key: "header-actions-end" }, slotNode, this.renderMenu(), closableNode));
+    const showContainer = hasEndActions || collapseNode || closeNode || hasMenuItems;
+    return (h("div", { class: { [CSS.headerActionsEnd]: true, [CSS.headerActions]: true }, hidden: !showContainer, key: "header-actions-end" }, slotNode, this.renderMenu(), collapseNode, closeNode));
   }
   renderMenu() {
     const { hasMenuItems, messages, menuOpen } = this;
     return (h("calcite-action-menu", { flipPlacements: ["top", "bottom"], hidden: !hasMenuItems, key: "menu", label: messages.options, open: menuOpen, placement: "bottom-end" }, h("calcite-action", { icon: ICONS.menu, slot: ACTION_MENU_SLOTS.trigger, text: messages.options }), h("slot", { name: SLOTS.headerMenuActions, onSlotchange: this.handleHeaderMenuActionsSlotChange })));
   }
   renderHeaderNode() {
-    const { hasHeaderContent, hasStartActions, hasEndActions, closable, hasMenuItems, hasActionBar, } = this;
+    const { hasHeaderContent, hasStartActions, hasEndActions, closable, collapsible, hasMenuItems, hasActionBar, } = this;
     const headerContentNode = this.renderHeaderContent();
     const showHeaderContent = hasHeaderContent ||
       !!headerContentNode ||
       hasStartActions ||
       hasEndActions ||
+      collapsible ||
       closable ||
       hasMenuItems;
     this.showHeaderContent = showHeaderContent;
@@ -233,7 +236,7 @@ export class Panel {
     return (h("footer", { class: CSS.footer, hidden: !showFooter }, h("slot", { key: "footer-slot", name: SLOTS.footer, onSlotchange: this.handleFooterSlotChange }), h("slot", { key: "footer-actions-slot", name: SLOTS.footerActions, onSlotchange: this.handleFooterActionsSlotChange })));
   }
   renderContent() {
-    return (h("div", { class: CSS.contentWrapper, onScroll: this.panelScrollHandler,
+    return (h("div", { class: CSS.contentWrapper, hidden: this.collapsible && this.collapsed, onScroll: this.panelScrollHandler,
       // eslint-disable-next-line react/jsx-sort-props -- ref should be last so node attrs/props are in sync (see https://github.com/Esri/calcite-design-system/pull/6530)
       ref: this.setPanelScrollEl }, h("slot", null), this.renderFab()));
   }
@@ -316,6 +319,63 @@ export class Panel {
         "reflect": true,
         "defaultValue": "false"
       },
+      "collapsed": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "When `true`, hides the component's content area."
+        },
+        "attribute": "collapsed",
+        "reflect": true,
+        "defaultValue": "false"
+      },
+      "collapseDirection": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "\"down\" | \"up\"",
+          "resolved": "\"down\" | \"up\"",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "internal",
+              "text": undefined
+            }],
+          "text": "Specifies the direction of the collapse."
+        },
+        "attribute": "collapse-direction",
+        "reflect": false,
+        "defaultValue": "\"down\""
+      },
+      "collapsible": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "When `true`, the component is collapsible."
+        },
+        "attribute": "collapsible",
+        "reflect": true,
+        "defaultValue": "false"
+      },
       "headingLevel": {
         "type": "number",
         "mutable": false,
@@ -413,7 +473,7 @@ export class Panel {
         "mutable": true,
         "complexType": {
           "original": "Partial<PanelMessages>",
-          "resolved": "{ close?: string; options?: string; }",
+          "resolved": "{ close?: string; options?: string; collapse?: string; expand?: string; }",
           "references": {
             "Partial": {
               "location": "global"
@@ -436,7 +496,7 @@ export class Panel {
         "mutable": true,
         "complexType": {
           "original": "PanelMessages",
-          "resolved": "{ close: string; options: string; }",
+          "resolved": "{ close: string; options: string; collapse: string; expand: string; }",
           "references": {
             "PanelMessages": {
               "location": "import",
@@ -487,6 +547,21 @@ export class Panel {
           "resolved": "void",
           "references": {}
         }
+      }, {
+        "method": "calcitePanelToggle",
+        "name": "calcitePanelToggle",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Fires when the collapse button is clicked."
+        },
+        "complexType": {
+          "original": "void",
+          "resolved": "void",
+          "references": {}
+        }
       }, {
         "method": "calcitePanelScroll",
         "name": "calcitePanelScroll",
@@ -528,9 +603,9 @@ export class Panel {
           "parameters": [{
               "tags": [{
                   "name": "param",
-                  "text": "options"
+                  "text": "options - allows specific coordinates to be defined."
                 }],
-              "text": ""
+              "text": "- allows specific coordinates to be defined."
             }],
           "references": {
             "Promise": {
@@ -549,7 +624,10 @@ export class Panel {
               "text": "myCalciteFlowItem.scrollContentTo({\n  left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n  top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n  behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n});"
             }, {
               "name": "param",
-              "text": "options"
+              "text": "options - allows specific coordinates to be defined."
+            }, {
+              "name": "returns",
+              "text": "- promise that resolves once the content is scrolled to."
             }]
         }
       }