@salla.sa/twilight-components 1.5.6 → 1.5.8

package/dist/collection/components/salla-loyalty/salla-loyalty.js

@@ -167,7 +167,7 @@ export class SallaLoyalty {
       .catch(e => console.log(e));
   }
   /**
-   *
+   * Exchange loyalty points with the selected prize item
    * @param {number} loyalty_prize_id
    *
    */
@@ -452,7 +452,7 @@ export class SallaLoyalty {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Exchange loyalty points with the selected prize item",
         "tags": [{
             "name": "param",
             "text": "loyalty_prize_id"

package/dist/collection/components/salla-modal/salla-modal.js

@@ -11,6 +11,9 @@ import CheckCircleIcon from '../../assets/svg/check-circle2.svg';
  */
 export class SallaModal {
   constructor() {
+    /**
+     * Sets the modal to be closable. Defaults to `true`
+     */
     this.isClosable = true; //todo::rename unclude. Suggestion => persistent
     /**
      * The size of the modal
@@ -32,10 +35,25 @@ export class SallaModal {
      * Show loading in the middle
      */
     this.isLoading = false;
+    /**
+     * Show subtitle before the title or not, defaults to `false` (after the title)
+     */
     this.subTitleFirst = false; //todo:: choose better name
+    /**
+     * Avoid padding in the modal body or not, defaults to `false`
+     */
     this.noPadding = false; //todo:: choose better name
+    /**
+     * Set modal sub title.
+     */
     this.subTitle = '';
+    /**
+     * Align modal content to center, defaults to `false`
+     */
     this.centered = false;
+    /**
+     * Set the style of the header icon.
+     */
     this.iconStyle = undefined;
     Helper.setHost(this.host);
     salla.event.on('modal::open', target => target == this.host.id && this.open());
@@ -177,7 +195,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Sets the modal to be closable. Defaults to `true`"
       },
       "attribute": "is-closable",
       "reflect": false,
@@ -285,7 +303,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Show subtitle before the title or not, defaults to `false` (after the title)"
       },
       "attribute": "sub-title-first",
       "reflect": false,
@@ -303,7 +321,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Avoid padding in the modal body or not, defaults to `false`"
       },
       "attribute": "no-padding",
       "reflect": false,
@@ -321,7 +339,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Set modal sub title."
       },
       "attribute": "sub-title",
       "reflect": false,
@@ -339,7 +357,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Align modal content to center, defaults to `false`"
       },
       "attribute": "centered",
       "reflect": false,
@@ -357,7 +375,7 @@ export class SallaModal {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Set the style of the header icon."
       },
       "attribute": "icon-style",
       "reflect": false,

package/dist/collection/components/salla-rating-stars/salla-rating-stars.js

@@ -6,7 +6,13 @@ import Helper from "../../Helpers/Helper";
 import Star2 from "../../assets/svg/star2.svg";
 export class SallaRatingStars {
   constructor() {
+    /**
+     * Sets input name.
+     */
     this.name = 'rating';
+    /**
+     * Sets the height and width of the component. Defaults to medium.
+     */
     this.size = 'medium';
   }
   initiateRating() {
@@ -88,7 +94,7 @@ export class SallaRatingStars {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Sets input name."
       },
       "attribute": "name",
       "reflect": false,
@@ -98,15 +104,15 @@ export class SallaRatingStars {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "string",
-        "resolved": "string",
+        "original": "\"large\" | \"medium\" | \"small\" | \"mini\"",
+        "resolved": "\"large\" | \"medium\" | \"mini\" | \"small\"",
         "references": {}
       },
       "required": false,
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Sets the height and width of the component. Defaults to medium."
       },
       "attribute": "size",
       "reflect": false,
@@ -124,7 +130,7 @@ export class SallaRatingStars {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "The rating value."
       },
       "attribute": "value",
       "reflect": false

package/dist/collection/components/salla-scopes/salla-scopes.js

@@ -40,10 +40,16 @@ export class SallaScopees {
       this.scopeSearchPlaceholder = salla.lang.get('blocks.scope.searching_for_a_branch');
     });
   }
+  /**
+   * Closes the scope modal.
+   */
   async close() {
     var _a;
     return await ((_a = this.modal) === null || _a === void 0 ? void 0 : _a.close());
   }
+  /**
+   * Opens the scope modal.
+   */
   async open(mode = ModeType.DEFAULT, product_id = null) {
     this.setScopeValues([]);
     if (typeof mode !== 'undefined' && [ModeType.AVAILABILITY, ModeType.DEFAULT].includes(mode)) {
@@ -67,14 +73,23 @@ export class SallaScopees {
       this.modal.stopLoading();
     });
   }
+  /**
+   * Submit form to change exsiting scope.
+   */
   async handleSubmit() {
-    let payload = { 'scope_id': this.current_scope.id };
+    let payload = { 'id': this.current_scope.id };
     this.changeBtn.load();
     return await salla.scope.change(payload)
       .then(() => {
       salla.storage.set("branch-choosed-before", true);
-      salla.storage.set("scope", this.current_scope.id);
-      window.location.search += "&scope=" + this.current_scope.id;
+      salla.storage.set("scope", {
+        'type': this.current_scope.type,
+        'id': this.current_scope.id
+      });
+      if (window.location.search.includes("?")) {
+        window.location.search += "&";
+      }
+      window.location.search += "scope=" + this.current_scope.id;
     }).catch(e => console.log(e))
       .finally(() => {
       this.changeBtn.stop();
@@ -252,7 +267,7 @@ export class SallaScopees {
         "return": "Promise<HTMLElement>"
       },
       "docs": {
-        "text": "",
+        "text": "Closes the scope modal.",
         "tags": []
       }
     },
@@ -274,7 +289,7 @@ export class SallaScopees {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Opens the scope modal.",
         "tags": []
       }
     },
@@ -290,7 +305,7 @@ export class SallaScopees {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Submit form to change exsiting scope.",
         "tags": []
       }
     }

package/dist/collection/components/salla-search/salla-search.js

@@ -14,8 +14,17 @@ export class SallaSearch {
     this.loading = false;
     this.typing = false;
     this.debounce = setTimeout(() => '', 1000);
+    /**
+     * Set the component display without modal window. Defaults to `false`
+     */
     this.inline = false;
+    /**
+     * Adds a border radius to the input. Half of the height.
+     */
     this.oval = false;
+    /**
+     * Sets the height of the input
+     */
     this.height = 60;
     Helper.setHost(this.host);
     this.productSlot = ((_a = Helper.getElement('[slot="product"]')) === null || _a === void 0 ? void 0 : _a.innerHTML) || this.getDefaultProductSlot();
@@ -124,7 +133,7 @@ export class SallaSearch {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Set the component display without modal window. Defaults to `false`"
       },
       "attribute": "inline",
       "reflect": false,
@@ -142,7 +151,7 @@ export class SallaSearch {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Adds a border radius to the input. Half of the height."
       },
       "attribute": "oval",
       "reflect": false,
@@ -160,7 +169,7 @@ export class SallaSearch {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Sets the height of the input"
       },
       "attribute": "height",
       "reflect": false,

package/dist/collection/components/salla-social-share/salla-social-share.js

@@ -50,6 +50,9 @@ export class SallaSocialShare {
       window.a2a_config.locale = salla.lang.locale;
     });
   }
+  /**
+   * Activate or open the share menu.
+   */
   async open() {
     this.opened = !this.opened;
     if (this.opened) {
@@ -179,7 +182,7 @@ export class SallaSocialShare {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Activate or open the share menu.",
         "tags": []
       }
     }

package/dist/collection/components/salla-swiper/salla-swiper.js

@@ -7,12 +7,22 @@ import ArrowRightIcon from "../../assets/svg/arrow-right.svg";
 import ArrowLeftIcon from "../../assets/svg/arrow-left.svg";
 export class SallaSwiper {
   constructor() {
-    // slider-options
+    /**
+     * Set to true to enable continuous loop mode. Defaults to false.
+     */
     this.loop = false;
+    /**
+     * Duration of transition between slides (in ms). Defaults to 300ms.
+     */
     this.speed = 300;
+    /**
+     * Number of slides per view (slides visible at the same time on slider's container).
+     */
     this.itemPerView = "auto";
+    /**
+     * Distance between slide items in px. Defaults to 8px
+     */
     this.spaceBetweenItems = 8;
-    this.direction = 'ltr';
     // States
     this.currentIndex = undefined;
     this.isLastSlideItem = false;
@@ -37,7 +47,7 @@ export class SallaSwiper {
   }
   render() {
     var _a, _b;
-    return (h("div", { class: "s-swiper", dir: this.direction },
+    return (h("div", { class: "s-swiper" },
       h("div", { class: "s-swiper-button-prev" },
         h("salla-button", { disabled: (_a = this.swiper) === null || _a === void 0 ? void 0 : _a.isBeginning, shape: "icon", color: "light", onClick: () => this.swiper.slidePrev() },
           h("span", { class: "s-swiper-button-icon", innerHTML: ArrowLeftIcon }))),
@@ -69,7 +79,7 @@ export class SallaSwiper {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Set to true to enable continuous loop mode. Defaults to false."
       },
       "attribute": "loop",
       "reflect": false,
@@ -87,7 +97,7 @@ export class SallaSwiper {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Duration of transition between slides (in ms). Defaults to 300ms."
       },
       "attribute": "speed",
       "reflect": false,
@@ -105,7 +115,7 @@ export class SallaSwiper {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Number of slides per view (slides visible at the same time on slider's container)."
       },
       "attribute": "item-per-view",
       "reflect": false,
@@ -123,29 +133,11 @@ export class SallaSwiper {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Distance between slide items in px. Defaults to 8px"
       },
       "attribute": "space-between-items",
       "reflect": false,
       "defaultValue": "8"
-    },
-    "direction": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "direction",
-      "reflect": false,
-      "defaultValue": "'ltr'"
     }
   }; }
   static get states() { return {

package/dist/collection/components/salla-tabs/salla-tab-content.js

@@ -6,6 +6,9 @@ export class SallaTabContent {
   constructor() {
     this.isSelected = false;
   }
+  /**
+   * Expose self for the parent.
+   */
   async getChild() {
     return {
       select: this.select.bind(this),
@@ -47,7 +50,7 @@ export class SallaTabContent {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Set name of the tab content. Mainly used as a key to s\nynchronize the content with it's respective header."
       },
       "attribute": "name",
       "reflect": false
@@ -69,7 +72,7 @@ export class SallaTabContent {
         "return": "Promise<{ select: any; unselect: any; name: string; }>"
       },
       "docs": {
-        "text": "",
+        "text": "Expose self for the parent.",
         "tags": []
       }
     }

package/dist/collection/components/salla-tabs/salla-tab-header.js

@@ -20,9 +20,12 @@ export class SallaTabHeader {
     this.centered = false;
     this.isSelected = false;
   }
+  /**
+   * Expose self for the parent.
+   */
   async getChild() {
     return {
-      select: this.select.bind(this),
+      select: this.selected.bind(this),
       unselect: this.unselect.bind(this),
       name: this.name,
       id: this.id
@@ -31,12 +34,12 @@ export class SallaTabHeader {
   unselect() {
     this.isSelected = false;
   }
-  select() {
+  selected() {
     this.isSelected = true;
   }
   onClick() {
     this.getChild().then(child => {
-      this.onSelect.emit(child);
+      this.tabSelected.emit(child);
     });
   }
   render() {
@@ -70,7 +73,7 @@ export class SallaTabHeader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Header identifier name to sync with the"
+        "text": "Header identifier name to sync with the content."
       },
       "attribute": "name",
       "reflect": false
@@ -134,14 +137,14 @@ export class SallaTabHeader {
     "isSelected": {}
   }; }
   static get events() { return [{
-      "method": "onSelect",
-      "name": "onSelect",
+      "method": "tabSelected",
+      "name": "tabSelected",
       "bubbles": true,
       "cancelable": true,
       "composed": true,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Emits event object when clicked or selected."
       },
       "complexType": {
         "original": "any",
@@ -162,7 +165,7 @@ export class SallaTabHeader {
         "return": "Promise<{ select: any; unselect: any; name: string; id: string; }>"
       },
       "docs": {
-        "text": "",
+        "text": "Expose self for the parent.",
         "tags": []
       }
     }

package/dist/collection/components/salla-tabs/salla-tabs.js

@@ -100,7 +100,7 @@ export class SallaTabs {
   }; }
   static get elementRef() { return "host"; }
   static get listeners() { return [{
-      "name": "onSelect",
+      "name": "onTabSelected",
       "method": "onSelectedTab",
       "target": undefined,
       "capture": false,

package/dist/collection/components/salla-tel-input/salla-tel-input.js

@@ -177,7 +177,7 @@ export class SallaTelInput {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Event Emitter"
       },
       "complexType": {
         "original": "any",

package/dist/components/salla-add-product-button.js

@@ -14,14 +14,29 @@ const SallaAddProductButton$1 = /*@__PURE__*/ proxyCustomElement(class extends H
   constructor() {
     super();
     this.__registerHost();
-    this.success = createEvent(this, "success", 7);
-    this.failed = createEvent(this, "failed", 7);
+    this.onSuccess = createEvent(this, "onSuccess", 7);
+    this.onFailed = createEvent(this, "onFailed", 7);
     this.hostAttributes = {};
     this.hasLabel = false;
+    /**
+     * Channels.
+     */
     this.channels = null;
+    /**
+     * Product Quantity
+     */
     this.quantity = 0;
+    /**
+     * Donating amount.
+     */
     this.donatingAmount = 0;
+    /**
+     *  Product Status.Defaults to `sale`
+     */
     this.productStatus = 'sale';
+    /**
+     * Product type. Defaults to `product`
+     */
     this.productType = 'product';
   }
   getLabel() {
@@ -52,10 +67,10 @@ const SallaAddProductButton$1 = /*@__PURE__*/ proxyCustomElement(class extends H
     }).reduce((a, [k, v]) => (v ? (a[k] = v, a) : a), {});
     return salla.cart.quickAdd(data)
       .then((response) => {
-      return this.success.emit(response);
+      return this.onSuccess.emit(response);
     })
       .catch((error) => {
-      return this.failed.emit(error);
+      return this.onFailed.emit(error);
     });
   }
   getBtnAttributes() {

package/dist/components/salla-list-tile2.js

@@ -9,7 +9,13 @@ const SallaListTile = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
   constructor() {
     super();
     this.__registerHost();
+    /**
+     * Designates the component as anchor and applies the `href` attribute.
+     */
     this.href = undefined;
+    /**
+     * Designates the target attribute. This should only be applied when using the `href` prop.
+     */
     this.target = "_self";
   }
   generateClass() {

package/dist/components/salla-localization-modal.js

@@ -18,7 +18,13 @@ const SallaLocalizationModal$1 = /*@__PURE__*/ proxyCustomElement(class extends
     this.languages = [];
     this.currencies = [];
     this.isLoading = true;
+    /**
+     * Current language (existing or newly selected)
+     */
     this.language = salla.config.get('user.language_code');
+    /**
+     * Current currency (existing or newly selected)
+     */
     this.currency = salla.config.get('user.currency_code');
     Helper.setHost(this.host);
     salla.event.on('localization::open', () => this.open());
@@ -69,6 +75,9 @@ const SallaLocalizationModal$1 = /*@__PURE__*/ proxyCustomElement(class extends
   onChangeLanguage(event) {
     this.language = event.target.value;
   }
+  /**
+   * Change currency and language to the selected ones.
+   */
   async submit() {
     let url;
     this.btn.load()

package/dist/components/salla-loyalty.js

@@ -203,7 +203,7 @@ const SallaLoyalty$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
       .catch(e => console.log(e));
   }
   /**
-   *
+   * Exchange loyalty points with the selected prize item
    * @param {number} loyalty_prize_id
    *
    */

package/dist/components/salla-modal2.js

@@ -26,6 +26,9 @@ const SallaModal = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
   constructor() {
     super();
     this.__registerHost();
+    /**
+     * Sets the modal to be closable. Defaults to `true`
+     */
     this.isClosable = true; //todo::rename unclude. Suggestion => persistent
     /**
      * The size of the modal
@@ -47,10 +50,25 @@ const SallaModal = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
      * Show loading in the middle
      */
     this.isLoading = false;
+    /**
+     * Show subtitle before the title or not, defaults to `false` (after the title)
+     */
     this.subTitleFirst = false; //todo:: choose better name
+    /**
+     * Avoid padding in the modal body or not, defaults to `false`
+     */
     this.noPadding = false; //todo:: choose better name
+    /**
+     * Set modal sub title.
+     */
     this.subTitle = '';
+    /**
+     * Align modal content to center, defaults to `false`
+     */
     this.centered = false;
+    /**
+     * Set the style of the header icon.
+     */
     this.iconStyle = undefined;
     Helper.setHost(this.host);
     salla.event.on('modal::open', target => target == this.host.id && this.open());

package/dist/components/salla-rating-stars2.js

@@ -11,7 +11,13 @@ const SallaRatingStars = /*@__PURE__*/ proxyCustomElement(class extends HTMLElem
   constructor() {
     super();
     this.__registerHost();
+    /**
+     * Sets input name.
+     */
     this.name = 'rating';
+    /**
+     * Sets the height and width of the component. Defaults to medium.
+     */
     this.size = 'medium';
   }
   initiateRating() {