@rededor/cura 1.7.1 → 1.8.0

package/dist/collection/components/cura-calendar/cura-calendar.js

@@ -4,36 +4,165 @@ import enAU from "date-fns/locale/en-AU";
 import ptBR from "date-fns/locale/pt-BR";
 export class CuraCalendar {
     constructor() {
-        this.theme = window.CuraAPI.theme;
-        this.weights = this.theme.fonts.getWeights();
-        this.optionsLocale = { 'pt-BR': ptBR, 'en-US': enAU };
+        /**
+         * An array of specific dates to be highlighted or processed.
+         *
+         * @type {string[] | string}
+         * @default []
+         * @example
+         * // Example usage
+         * period = ["2024-08-01", "2024-08-30"];
+         */
         this.period = null;
+        /**
+         * Width of the component.
+         *
+         * @type {string}
+         * @default '268px'
+         */
         this.width = '268px';
+        /**
+         * Minimum Width of the component.
+         *
+         * @type {string}
+         * @default '268px'
+         */
         this.minWidth = '268px';
+        /**
+         * Maximum Width of the component.
+         *
+         * @type {string}
+         * @default '400px'
+         */
         this.maxWidth = '400px';
+        /**
+         * Selection mode of the date picker.
+         *
+         * @type {'single' | 'multiple' | 'range'}
+         * @default 'single'
+         */
         this.mode = 'single';
+        /**
+         * Date format used for display and parsing.
+         *
+         * @type {string}
+         * @default 'yyyy-MM-dd'
+         */
         this.dateFormat = 'yyyy-MM-dd';
+        /**
+         * Locale for date formatting.
+         *
+         * @type {'pt-BR' | 'en-US'}
+         * @default 'pt-BR'
+         */
         this.locale = 'pt-BR';
+        /**
+         * Display type of the date picker.
+         *
+         * @type {'dropdown' | 'static'}
+         * @default 'dropdown'
+         */
         this.type = 'dropdown';
+        /**
+         * List of dates to disable.
+         *
+         * @type {string[]}
+         * @default []
+         */
         this.disable = [];
+        /**
+         * List of dates to enable.
+         *
+         * @type {string[]}
+         * @default []
+         */
         this.enable = [];
+        /**
+         * Default dates selected on initialization.
+         *
+         * @type {string[]}
+         * @default []
+         * @example
+         * // Example usage
+         * defaultDate = ["2024-08-01", "2024-08-30"];
+         * defaultDate = '["2024-08-01", "2024-08-30"]'
+         */
         this.defaultDate = [];
+        /**
+         * Hide today mark.
+         *
+         * @type {boolean}
+         * @default true
+         */
         this.showToday = true;
+        /**
+         * Array of dates chosen by the user, can be updated dynamically.
+         *
+         * @type {Date[]}
+         * @default []
+         */
         this.customDates = [];
+        /**
+         * Limits the selectable date range.
+         *
+         * @type {Date | null}
+         * @default null
+         */
         this.limitRange = null;
-        this.disablePassDates = undefined;
-        this.disableFutureDates = undefined;
         this.collapsed = null;
-        this.floating = undefined;
-        this.embedded = undefined;
         this.selectLabelColorMode = 'light';
+        /**
+         * Array of currently selected dates.
+         *
+         * @type {Date[]}
+         * @default []
+         */
         this.selectedDates = [];
+        /**
+         * The start date of the range selection, if applicable.
+         *
+         * @type {Date | null}
+         * @default null
+         */
         this.rangeStart = null;
+        /**
+         * Array of default dates that are initially selected.
+         *
+         * @type {Date[]}
+         * @default []
+         */
         this.defaultDates = [];
+        /**
+         * The current month being viewed in the date picker.
+         *
+         * @type {Date}
+         * @default new Date()
+         */
         this.currentDate = new Date();
+        /**
+         * Selected months on dropdown.
+         *
+         * @type {string}
+         * @default ''
+         */
         this.selectMonth = '';
+        /**
+         * Selected year on dropdown.
+         *
+         * @type {string}
+         * @default ''
+         */
         this.selectYear = '';
+        /**
+         * CSS styles applied to the component.
+         *
+         * @type {Object}
+         * @default {}
+         */
         this.styles = {};
+        this.theme = window.CuraAPI.theme;
+        this.weights = this.theme.fonts.getWeights();
+        this.optionsLocale = { 'pt-BR': ptBR, 'en-US': enAU };
     }
     connectedCallback() {
         this.setFontProperties();
@@ -484,6 +613,7 @@ export class CuraCalendar {
         return {
             "period": {
                 "type": "string",
+                "attribute": "period",
                 "mutable": false,
                 "complexType": {
                     "original": "null | string[] | string",
@@ -505,12 +635,14 @@ export class CuraCalendar {
                         }],
                     "text": "An array of specific dates to be highlighted or processed."
                 },
-                "attribute": "period",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "null"
             },
             "width": {
                 "type": "string",
+                "attribute": "width",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -529,12 +661,14 @@ export class CuraCalendar {
                         }],
                     "text": "Width of the component."
                 },
-                "attribute": "width",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'268px'"
             },
             "minWidth": {
                 "type": "string",
+                "attribute": "min-width",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -553,12 +687,14 @@ export class CuraCalendar {
                         }],
                     "text": "Minimum Width of the component."
                 },
-                "attribute": "min-width",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'268px'"
             },
             "maxWidth": {
                 "type": "string",
+                "attribute": "max-width",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -577,12 +713,14 @@ export class CuraCalendar {
                         }],
                     "text": "Maximum Width of the component."
                 },
-                "attribute": "max-width",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'400px'"
             },
             "mode": {
                 "type": "string",
+                "attribute": "mode",
                 "mutable": false,
                 "complexType": {
                     "original": "'single' | 'multiple' | 'range'",
@@ -601,12 +739,14 @@ export class CuraCalendar {
                         }],
                     "text": "Selection mode of the date picker."
                 },
-                "attribute": "mode",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'single'"
             },
             "dateFormat": {
                 "type": "string",
+                "attribute": "date-format",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -625,12 +765,14 @@ export class CuraCalendar {
                         }],
                     "text": "Date format used for display and parsing."
                 },
-                "attribute": "date-format",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'yyyy-MM-dd'"
             },
             "locale": {
                 "type": "string",
+                "attribute": "locale",
                 "mutable": false,
                 "complexType": {
                     "original": "'pt-BR' | 'en-US'",
@@ -649,12 +791,14 @@ export class CuraCalendar {
                         }],
                     "text": "Locale for date formatting."
                 },
-                "attribute": "locale",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'pt-BR'"
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "'dropdown' | 'static'",
@@ -673,12 +817,14 @@ export class CuraCalendar {
                         }],
                     "text": "Display type of the date picker."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'dropdown'"
             },
             "disable": {
                 "type": "unknown",
+                "attribute": "disable",
                 "mutable": false,
                 "complexType": {
                     "original": "string[] | null",
@@ -697,10 +843,13 @@ export class CuraCalendar {
                         }],
                     "text": "List of dates to disable."
                 },
+                "getter": false,
+                "setter": false,
                 "defaultValue": "[]"
             },
             "enable": {
                 "type": "unknown",
+                "attribute": "enable",
                 "mutable": false,
                 "complexType": {
                     "original": "string[] | null",
@@ -719,10 +868,13 @@ export class CuraCalendar {
                         }],
                     "text": "List of dates to enable."
                 },
+                "getter": false,
+                "setter": false,
                 "defaultValue": "[]"
             },
             "defaultDate": {
                 "type": "string",
+                "attribute": "default-date",
                 "mutable": true,
                 "complexType": {
                     "original": "string[] | string",
@@ -744,12 +896,14 @@ export class CuraCalendar {
                         }],
                     "text": "Default dates selected on initialization."
                 },
-                "attribute": "default-date",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "[]"
             },
             "showToday": {
                 "type": "boolean",
+                "attribute": "show-today",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -768,12 +922,14 @@ export class CuraCalendar {
                         }],
                     "text": "Hide today mark."
                 },
-                "attribute": "show-today",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "true"
             },
             "customDates": {
                 "type": "unknown",
+                "attribute": "custom-dates",
                 "mutable": false,
                 "complexType": {
                     "original": "Date[]",
@@ -797,10 +953,13 @@ export class CuraCalendar {
                         }],
                     "text": "Array of dates chosen by the user, can be updated dynamically."
                 },
+                "getter": false,
+                "setter": false,
                 "defaultValue": "[]"
             },
             "limitRange": {
                 "type": "number",
+                "attribute": "limit-range",
                 "mutable": false,
                 "complexType": {
                     "original": "number | null",
@@ -819,12 +978,14 @@ export class CuraCalendar {
                         }],
                     "text": "Limits the selectable date range."
                 },
-                "attribute": "limit-range",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "null"
             },
             "disablePassDates": {
                 "type": "boolean",
+                "attribute": "disable-pass-dates",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -837,11 +998,13 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "disable-pass-dates",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "disableFutureDates": {
                 "type": "boolean",
+                "attribute": "disable-future-dates",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -854,11 +1017,13 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "disable-future-dates",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "collapsed": {
                 "type": "boolean",
+                "attribute": "collapsed",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean | null",
@@ -871,12 +1036,14 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "collapsed",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "null"
             },
             "floating": {
                 "type": "boolean",
+                "attribute": "floating",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -889,11 +1056,13 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "floating",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "embedded": {
                 "type": "boolean",
+                "attribute": "embedded",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -906,11 +1075,13 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "embedded",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "selectLabelColorMode": {
                 "type": "string",
+                "attribute": "select-label-color-mode",
                 "mutable": true,
                 "complexType": {
                     "original": "'dark' | 'light' | string",
@@ -923,7 +1094,8 @@ export class CuraCalendar {
                     "tags": [],
                     "text": ""
                 },
-                "attribute": "select-label-color-mode",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'light'"
             }