123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419 |
- /*!
- * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
- * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-beta.97
- */
- import { h, Host, Build } from "@stencil/core";
- import { getLocaleData, getValueAsDateRange } from "../date-picker/utils";
- import { dateFromRange, inRange, dateFromISO, dateToISO, parseDateString, sameDate, setEndOfDay } from "../../utils/date";
- import { TEXT } from "../date-picker/resources";
- import { CSS } from "./resources";
- import { connectLabel, disconnectLabel, getLabelText } from "../../utils/label";
- import { connectForm, disconnectForm, HiddenFormInputSlot, submitForm } from "../../utils/form";
- import { FloatingCSS, connectFloatingUI, disconnectFloatingUI, defaultMenuPlacement, filterComputedPlacements, reposition, updateAfterClose } from "../../utils/floating-ui";
- import { updateHostInteraction } from "../../utils/interactive";
- import { toAriaBoolean } from "../../utils/dom";
- import { connectOpenCloseComponent, disconnectOpenCloseComponent } from "../../utils/openCloseComponent";
- import { connectLocalized, disconnectLocalized, numberStringFormatter } from "../../utils/locale";
- import { numberKeys } from "../../utils/key";
- export class InputDatePicker {
- constructor() {
- //--------------------------------------------------------------------------
- //
- // Public Properties
- //
- //--------------------------------------------------------------------------
- /**
- * When `true`, interaction is prevented and the component is displayed with lower opacity.
- */
- this.disabled = false;
- /**
- * When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified.
- *
- * @mdn [readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)
- */
- this.readOnly = false;
- /**
- * When `true`, the component is active.
- *
- * @deprecated use `open` instead.
- */
- this.active = false;
- /** When `true`, displays the `calcite-date-picker` component. */
- this.open = false;
- /**
- * Accessible name for the component's previous month button.
- *
- * @default "Previous month"
- */
- this.intlPrevMonth = TEXT.prevMonth;
- /**
- * Accessible name for the component's next month button.
- *
- * @default "Next month"
- */
- this.intlNextMonth = TEXT.nextMonth;
- /**
- * Accessible name for the component's year input.
- *
- * @default "Year"
- */
- this.intlYear = TEXT.year;
- /** Specifies the size of the component. */
- this.scale = "m";
- /**
- * Specifies the placement of the `calcite-date-picker` relative to the component.
- *
- * @default "bottom-start"
- */
- this.placement = defaultMenuPlacement;
- /** When `true`, activates a range for the component. */
- this.range = false;
- /**
- * When `true`, the component must have a value in order for the form to submit.
- *
- * @internal
- */
- this.required = false;
- /**
- * Determines the type of positioning to use for the overlaid content.
- *
- * Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout.
- *
- * `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`.
- *
- */
- this.overlayPositioning = "absolute";
- /**
- * When `true`, disables the default behavior on the third click of narrowing or extending the range.
- * Instead starts a new range.
- */
- this.proximitySelectionDisabled = false;
- /** Defines the layout of the component. */
- this.layout = "horizontal";
- this.effectiveLocale = "";
- this.focusedInput = "start";
- this.globalAttributes = {};
- this.openTransitionProp = "opacity";
- //--------------------------------------------------------------------------
- //
- // Private Methods
- //
- //--------------------------------------------------------------------------
- this.setFilteredPlacements = () => {
- const { el, flipPlacements } = this;
- this.filteredFlipPlacements = flipPlacements
- ? filterComputedPlacements(flipPlacements, el)
- : null;
- };
- this.setTransitionEl = (el) => {
- this.transitionEl = el;
- connectOpenCloseComponent(this);
- };
- this.setStartInput = (el) => {
- this.startInput = el;
- };
- this.setEndInput = (el) => {
- this.endInput = el;
- };
- this.deactivate = () => {
- this.open = false;
- };
- this.keyDownHandler = (event) => {
- const { defaultPrevented, key } = event;
- if (key === "Enter" && !defaultPrevented) {
- if (submitForm(this)) {
- event.preventDefault();
- }
- }
- else if (key === "Escape" && !defaultPrevented) {
- this.active = false;
- this.open = false;
- event.preventDefault();
- }
- };
- this.inputBlur = (event) => {
- this.blur(event.currentTarget);
- };
- this.startInputFocus = () => {
- if (!this.readOnly) {
- this.open = true;
- }
- this.focusedInput = "start";
- };
- this.endInputFocus = () => {
- if (!this.readOnly) {
- this.open = true;
- }
- this.focusedInput = "end";
- };
- this.startInputInput = () => {
- const parsedValue = this.parseNumerals(this.startInput.value);
- const formattedValue = this.formatNumerals(parsedValue);
- this.startInput.value = formattedValue;
- this.input(parsedValue);
- };
- this.endInputInput = () => {
- const parsedValue = this.parseNumerals(this.endInput.value);
- const formattedValue = this.formatNumerals(parsedValue);
- this.endInput.value = formattedValue;
- this.input(parsedValue);
- };
- this.setFloatingEl = (el) => {
- if (el) {
- this.floatingEl = el;
- connectFloatingUI(this, this.referenceEl, this.floatingEl);
- }
- };
- this.setStartWrapper = (el) => {
- this.startWrapper = el;
- this.setReferenceEl();
- };
- this.setEndWrapper = (el) => {
- this.endWrapper = el;
- this.setReferenceEl();
- };
- /**
- * Event handler for when the selected date changes
- *
- * @param event
- */
- this.handleDateChange = (event) => {
- if (this.range) {
- return;
- }
- this.value = dateToISO(event.detail);
- };
- this.handleDateRangeChange = (event) => {
- var _a, _b;
- if (!this.range || !event.detail) {
- return;
- }
- const { startDate, endDate } = event.detail;
- this.start = dateToISO(startDate);
- this.end = dateToISO(endDate);
- this.value = [this.start, this.end];
- if (this.shouldFocusRangeEnd()) {
- (_a = this.endInput) === null || _a === void 0 ? void 0 : _a.setFocus();
- }
- else if (this.shouldFocusRangeStart()) {
- (_b = this.startInput) === null || _b === void 0 ? void 0 : _b.setFocus();
- }
- };
- this.commonDateSeparators = [".", "-", "/"];
- this.formatNumerals = (value) => value
- ? value
- .split("")
- .map((char) =>
- // convert common separators to the locale's
- this.commonDateSeparators.includes(char)
- ? this.localeData.separator
- : numberKeys.includes(char)
- ? numberStringFormatter.numberFormatter.format(Number(char))
- : char)
- .join("")
- : "";
- this.parseNumerals = (value) => value
- ? value
- .split("")
- .map((char) => numberKeys.includes(char) ? numberStringFormatter.delocalize(char) : char)
- .join("")
- : "";
- }
- handleDisabledAndReadOnlyChange(value) {
- if (!value) {
- this.open = false;
- }
- }
- valueHandler(value) {
- if (Array.isArray(value)) {
- this.valueAsDate = getValueAsDateRange(value);
- this.start = value[0];
- this.end = value[1];
- }
- else if (value) {
- this.valueAsDate = dateFromISO(value);
- this.start = "";
- this.end = "";
- }
- else {
- this.valueAsDate = undefined;
- this.start = undefined;
- this.end = undefined;
- }
- }
- flipPlacementsHandler() {
- this.setFilteredPlacements();
- this.reposition(true);
- }
- onMinChanged(min) {
- if (min) {
- this.minAsDate = dateFromISO(min);
- }
- }
- onMaxChanged(max) {
- if (max) {
- this.maxAsDate = dateFromISO(max);
- }
- }
- activeHandler(value) {
- this.open = value;
- }
- openHandler(value) {
- this.active = value;
- if (this.disabled || this.readOnly) {
- if (!value) {
- updateAfterClose(this.floatingEl);
- }
- this.open = false;
- return;
- }
- if (value) {
- this.reposition(true);
- }
- else {
- updateAfterClose(this.floatingEl);
- }
- }
- overlayPositioningHandler() {
- this.reposition(true);
- }
- //--------------------------------------------------------------------------
- //
- // Event Listeners
- //
- //--------------------------------------------------------------------------
- handleDateOrRangeChange() {
- this.calciteInputDatePickerChange.emit();
- }
- calciteDaySelectHandler() {
- if (this.shouldFocusRangeStart() || this.shouldFocusRangeEnd()) {
- return;
- }
- this.open = false;
- }
- // --------------------------------------------------------------------------
- //
- // Public Methods
- //
- // --------------------------------------------------------------------------
- /** Sets focus on the component. */
- async setFocus() {
- var _a;
- (_a = this.startInput) === null || _a === void 0 ? void 0 : _a.setFocus();
- }
- /**
- * Updates the position of the component.
- *
- * @param delayed
- */
- async reposition(delayed = false) {
- const { floatingEl, referenceEl, placement, overlayPositioning, filteredFlipPlacements } = this;
- return reposition(this, {
- floatingEl,
- referenceEl,
- overlayPositioning,
- placement,
- flipPlacements: filteredFlipPlacements,
- type: "menu"
- }, delayed);
- }
- // --------------------------------------------------------------------------
- //
- // Lifecycle
- //
- // --------------------------------------------------------------------------
- connectedCallback() {
- connectLocalized(this);
- const isOpen = this.active || this.open;
- isOpen && this.activeHandler(isOpen);
- isOpen && this.openHandler(isOpen);
- if (Array.isArray(this.value)) {
- this.valueAsDate = getValueAsDateRange(this.value);
- this.start = this.value[0];
- this.end = this.value[1];
- }
- else if (this.value) {
- this.valueAsDate = dateFromISO(this.value);
- this.start = "";
- this.end = "";
- }
- if (this.start) {
- this.startAsDate = dateFromISO(this.start);
- }
- if (this.end) {
- this.endAsDate = setEndOfDay(dateFromISO(this.end));
- }
- if (this.min) {
- this.minAsDate = dateFromISO(this.min);
- }
- if (this.max) {
- this.maxAsDate = dateFromISO(this.max);
- }
- connectLabel(this);
- connectForm(this);
- connectOpenCloseComponent(this);
- this.setFilteredPlacements();
- this.reposition(true);
- numberStringFormatter.numberFormatOptions = {
- numberingSystem: this.numberingSystem,
- locale: this.effectiveLocale,
- useGrouping: false
- };
- }
- async componentWillLoad() {
- await this.loadLocaleData();
- this.onMinChanged(this.min);
- this.onMaxChanged(this.max);
- }
- componentDidLoad() {
- this.reposition(true);
- }
- disconnectedCallback() {
- disconnectLabel(this);
- disconnectForm(this);
- disconnectFloatingUI(this, this.referenceEl, this.floatingEl);
- disconnectOpenCloseComponent(this);
- disconnectLocalized(this);
- }
- componentDidRender() {
- updateHostInteraction(this);
- }
- render() {
- var _a, _b;
- const { disabled, readOnly, numberingSystem, effectiveLocale } = this;
- numberStringFormatter.numberFormatOptions = {
- numberingSystem,
- locale: effectiveLocale,
- useGrouping: false
- };
- const date = dateFromRange(this.range ? this.startAsDate : this.valueAsDate, this.minAsDate, this.maxAsDate);
- const endDate = this.range
- ? dateFromRange(this.endAsDate, this.minAsDate, this.maxAsDate)
- : null;
- const formattedEndDate = endDate
- ? this.formatNumerals(endDate.toLocaleDateString(effectiveLocale))
- : "";
- const formattedDate = date ? this.formatNumerals(date.toLocaleDateString(effectiveLocale)) : "";
- return (h(Host, { onBlur: this.deactivate, onKeyDown: this.keyDownHandler, role: "application" }, this.localeData && (h("div", { "aria-expanded": toAriaBoolean(this.open), class: "input-container", role: "application" }, h("div", { class: "input-wrapper", ref: this.setStartWrapper }, h("calcite-input", { class: `input ${this.layout === "vertical" && this.range ? `no-bottom-border` : ``}`, disabled: disabled, icon: "calendar", label: getLabelText(this), lang: effectiveLocale, "number-button-type": "none", numberingSystem: numberingSystem, onCalciteInputInput: this.startInputInput, onCalciteInternalInputBlur: this.inputBlur, onCalciteInternalInputFocus: this.startInputFocus, placeholder: (_a = this.localeData) === null || _a === void 0 ? void 0 : _a.placeholder, readOnly: readOnly, ref: this.setStartInput, scale: this.scale, type: "text", value: formattedDate })), h("div", { "aria-hidden": toAriaBoolean(!this.open), class: {
- [CSS.menu]: true,
- [CSS.menuActive]: this.open
- }, ref: this.setFloatingEl }, h("div", { class: {
- ["calendar-picker-wrapper"]: true,
- ["calendar-picker-wrapper--end"]: this.focusedInput === "end",
- [FloatingCSS.animation]: true,
- [FloatingCSS.animationActive]: this.open
- }, ref: this.setTransitionEl }, h("calcite-date-picker", { activeRange: this.focusedInput, endAsDate: this.endAsDate, headingLevel: this.headingLevel, intlNextMonth: this.intlNextMonth, intlPrevMonth: this.intlPrevMonth, intlYear: this.intlYear, lang: effectiveLocale, max: this.max, maxAsDate: this.maxAsDate, min: this.min, minAsDate: this.minAsDate, numberingSystem: numberingSystem, onCalciteDatePickerChange: this.handleDateChange, onCalciteDatePickerRangeChange: this.handleDateRangeChange, proximitySelectionDisabled: this.proximitySelectionDisabled, range: this.range, scale: this.scale, startAsDate: this.startAsDate, tabIndex: 0, valueAsDate: this.valueAsDate }))), this.range && this.layout === "horizontal" && (h("div", { class: "horizontal-arrow-container" }, h("calcite-icon", { flipRtl: true, icon: "arrow-right", scale: "s" }))), this.range && this.layout === "vertical" && this.scale !== "s" && (h("div", { class: "vertical-arrow-container" }, h("calcite-icon", { icon: "arrow-down", scale: "s" }))), this.range && (h("div", { class: "input-wrapper", ref: this.setEndWrapper }, h("calcite-input", { class: {
- input: true,
- "border-top-color-one": this.layout === "vertical" && this.range
- }, disabled: disabled, icon: "calendar", lang: effectiveLocale, "number-button-type": "none", numberingSystem: numberingSystem, onCalciteInputInput: this.endInputInput, onCalciteInternalInputBlur: this.inputBlur, onCalciteInternalInputFocus: this.endInputFocus, placeholder: (_b = this.localeData) === null || _b === void 0 ? void 0 : _b.placeholder, readOnly: readOnly, ref: this.setEndInput, scale: this.scale, type: "text", value: formattedEndDate }))))), h(HiddenFormInputSlot, { component: this })));
- }
- setReferenceEl() {
- const { focusedInput, layout, endWrapper, startWrapper } = this;
- this.referenceEl =
- focusedInput === "end" || layout === "vertical"
- ? endWrapper || startWrapper
- : startWrapper || endWrapper;
- connectFloatingUI(this, this.referenceEl, this.floatingEl);
- }
- onLabelClick() {
- this.setFocus();
- }
- onBeforeOpen() {
- this.calciteInputDatePickerBeforeOpen.emit();
- }
- onOpen() {
- this.calciteInputDatePickerOpen.emit();
- }
- onBeforeClose() {
- this.calciteInputDatePickerBeforeClose.emit();
- }
- onClose() {
- this.calciteInputDatePickerClose.emit();
- }
- startWatcher(start) {
- this.startAsDate = dateFromISO(start);
- }
- endWatcher(end) {
- this.endAsDate = end ? setEndOfDay(dateFromISO(end)) : dateFromISO(end);
- }
- async loadLocaleData() {
- if (!Build.isBrowser) {
- return;
- }
- this.localeData = await getLocaleData(this.effectiveLocale);
- }
- clearCurrentValue() {
- if (!this.range) {
- if (typeof this.value === "string" && this.value) {
- this.calciteDatePickerChange.emit();
- }
- this.value = "";
- return;
- }
- const { focusedInput } = this;
- if (focusedInput === "start") {
- if (this.start) {
- this.calciteDatePickerRangeChange.emit();
- }
- this.value = Array.isArray(this.value) ? ["", this.value[1] || ""] : [""];
- this.start = undefined;
- }
- else if (focusedInput === "end") {
- if (this.end) {
- this.calciteDatePickerRangeChange.emit();
- }
- this.value = Array.isArray(this.value) ? [this.value[0] || "", ""] : ["", ""];
- this.end = undefined;
- }
- }
- /**
- * If inputted string is a valid date, update value/active
- *
- * @param value
- */
- input(value) {
- const date = this.getDateFromInput(value);
- if (!date) {
- this.clearCurrentValue();
- return;
- }
- if (!this.range) {
- this.value = dateToISO(date);
- this.calciteDatePickerChange.emit(date);
- return;
- }
- const { focusedInput } = this;
- if (focusedInput === "start") {
- if (!this.startAsDate || !sameDate(date, this.startAsDate)) {
- const startDateISO = dateToISO(date);
- this.value = Array.isArray(this.value)
- ? [startDateISO, this.value[1] || ""]
- : [startDateISO];
- this.start = startDateISO;
- this.calciteDatePickerRangeChange.emit({
- startDate: date,
- endDate: this.endAsDate
- });
- }
- }
- else if (focusedInput === "end") {
- if (!this.endAsDate || !sameDate(date, this.endAsDate)) {
- const endDateISO = dateToISO(date);
- this.value = Array.isArray(this.value)
- ? [this.value[0] || "", endDateISO]
- : ["", endDateISO];
- this.end = endDateISO;
- this.calciteDatePickerRangeChange.emit({
- startDate: this.startAsDate,
- endDate: setEndOfDay(date)
- });
- }
- }
- }
- /**
- * Clean up invalid date from input on blur
- *
- * @param target
- */
- blur(target) {
- const { focusedInput, endAsDate, range, startAsDate, valueAsDate } = this;
- const locale = this.effectiveLocale;
- const date = this.getDateFromInput(target.value);
- if (!date) {
- if (!range && valueAsDate) {
- target.value = this.formatNumerals(Array.isArray(valueAsDate)
- ? valueAsDate[focusedInput === "end" ? 1 : 0].toLocaleDateString(locale)
- : valueAsDate.toLocaleDateString(locale));
- }
- else if (focusedInput === "start" && startAsDate) {
- target.value = this.formatNumerals(startAsDate.toLocaleDateString(locale));
- }
- else if (focusedInput === "end" && endAsDate) {
- target.value = this.formatNumerals(endAsDate.toLocaleDateString(locale));
- }
- }
- }
- shouldFocusRangeStart() {
- return !!(this.endAsDate &&
- !this.startAsDate &&
- this.focusedInput === "end" &&
- this.startInput);
- }
- shouldFocusRangeEnd() {
- return !!(this.startAsDate &&
- !this.endAsDate &&
- this.focusedInput === "start" &&
- this.endInput);
- }
- /**
- * Find a date from input string
- * return false if date is invalid, or out of range
- *
- * @param value
- */
- getDateFromInput(value) {
- if (!this.localeData) {
- return false;
- }
- const { separator } = this.localeData;
- const { day, month, year } = parseDateString(value, this.localeData);
- const validDay = day > 0;
- const validMonth = month > -1;
- const date = new Date(year, month, day);
- date.setFullYear(year);
- const validDate = !isNaN(date.getTime());
- const validLength = value.split(separator).filter((c) => c).length > 2;
- const validYear = year.toString().length > 0;
- if (validDay &&
- validMonth &&
- validDate &&
- validLength &&
- validYear &&
- inRange(date, this.min, this.max)) {
- return date;
- }
- return false;
- }
- static get is() { return "calcite-input-date-picker"; }
- static get encapsulation() { return "shadow"; }
- static get originalStyleUrls() {
- return {
- "$": ["input-date-picker.scss"]
- };
- }
- static get styleUrls() {
- return {
- "$": ["input-date-picker.css"]
- };
- }
- static get properties() {
- return {
- "disabled": {
- "type": "boolean",
- "mutable": false,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
- },
- "attribute": "disabled",
- "reflect": true,
- "defaultValue": "false"
- },
- "readOnly": {
- "type": "boolean",
- "mutable": false,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [{
- "name": "mdn",
- "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)"
- }],
- "text": "When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified."
- },
- "attribute": "read-only",
- "reflect": true,
- "defaultValue": "false"
- },
- "value": {
- "type": "string",
- "mutable": true,
- "complexType": {
- "original": "string | string[]",
- "resolved": "string | string[]",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "The component's value."
- },
- "attribute": "value",
- "reflect": false
- },
- "flipPlacements": {
- "type": "unknown",
- "mutable": false,
- "complexType": {
- "original": "EffectivePlacement[]",
- "resolved": "Placement[]",
- "references": {
- "EffectivePlacement": {
- "location": "import",
- "path": "../../utils/floating-ui"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Defines the available placements that can be used when a flip occurs."
- }
- },
- "headingLevel": {
- "type": "number",
- "mutable": false,
- "complexType": {
- "original": "HeadingLevel",
- "resolved": "1 | 2 | 3 | 4 | 5 | 6",
- "references": {
- "HeadingLevel": {
- "location": "import",
- "path": "../functional/Heading"
- }
- }
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "Specifies the number at which section headings should start."
- },
- "attribute": "heading-level",
- "reflect": true
- },
- "valueAsDate": {
- "type": "unknown",
- "mutable": true,
- "complexType": {
- "original": "Date | Date[]",
- "resolved": "Date | Date[]",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "The component's value as a full date object."
- }
- },
- "startAsDate": {
- "type": "unknown",
- "mutable": true,
- "complexType": {
- "original": "Date",
- "resolved": "Date",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `valueAsDate` instead."
- }],
- "text": "The component's start date as a full date object."
- }
- },
- "endAsDate": {
- "type": "unknown",
- "mutable": true,
- "complexType": {
- "original": "Date",
- "resolved": "Date",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `valueAsDate` instead."
- }],
- "text": "The component's end date as a full date object."
- }
- },
- "minAsDate": {
- "type": "unknown",
- "mutable": true,
- "complexType": {
- "original": "Date",
- "resolved": "Date",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Specifies the earliest allowed date as a full date object."
- }
- },
- "maxAsDate": {
- "type": "unknown",
- "mutable": true,
- "complexType": {
- "original": "Date",
- "resolved": "Date",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Specifies the latest allowed date as a full date object."
- }
- },
- "min": {
- "type": "string",
- "mutable": true,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Specifies the earliest allowed date (\"yyyy-mm-dd\")."
- },
- "attribute": "min",
- "reflect": false
- },
- "max": {
- "type": "string",
- "mutable": true,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Specifies the latest allowed date (\"yyyy-mm-dd\")."
- },
- "attribute": "max",
- "reflect": false
- },
- "active": {
- "type": "boolean",
- "mutable": true,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `open` instead."
- }],
- "text": "When `true`, the component is active."
- },
- "attribute": "active",
- "reflect": true,
- "defaultValue": "false"
- },
- "open": {
- "type": "boolean",
- "mutable": true,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "When `true`, displays the `calcite-date-picker` component."
- },
- "attribute": "open",
- "reflect": true,
- "defaultValue": "false"
- },
- "name": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "Specifies the name of the component on form submission."
- },
- "attribute": "name",
- "reflect": true
- },
- "intlPrevMonth": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "default",
- "text": "\"Previous month\""
- }],
- "text": "Accessible name for the component's previous month button."
- },
- "attribute": "intl-prev-month",
- "reflect": false,
- "defaultValue": "TEXT.prevMonth"
- },
- "intlNextMonth": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "default",
- "text": "\"Next month\""
- }],
- "text": "Accessible name for the component's next month button."
- },
- "attribute": "intl-next-month",
- "reflect": false,
- "defaultValue": "TEXT.nextMonth"
- },
- "intlYear": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "default",
- "text": "\"Year\""
- }],
- "text": "Accessible name for the component's year input."
- },
- "attribute": "intl-year",
- "reflect": false,
- "defaultValue": "TEXT.year"
- },
- "locale": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "set the global `lang` attribute on the element instead."
- }, {
- "name": "mdn",
- "text": "[lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)"
- }],
- "text": "Specifies the BCP 47 language tag for the desired language and country format."
- },
- "attribute": "locale",
- "reflect": false
- },
- "numberingSystem": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "NumberingSystem",
- "resolved": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"",
- "references": {
- "NumberingSystem": {
- "location": "import",
- "path": "../../utils/locale"
- }
- }
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [],
- "text": "Specifies the Unicode numeral system used by the component for localization. This property cannot be dynamically changed."
- },
- "attribute": "numbering-system",
- "reflect": true
- },
- "scale": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "\"s\" | \"m\" | \"l\"",
- "resolved": "\"l\" | \"m\" | \"s\"",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "Specifies the size of the component."
- },
- "attribute": "scale",
- "reflect": true,
- "defaultValue": "\"m\""
- },
- "placement": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "MenuPlacement",
- "resolved": "\"bottom\" | \"bottom-end\" | \"bottom-leading\" | \"bottom-start\" | \"bottom-trailing\" | \"top\" | \"top-end\" | \"top-leading\" | \"top-start\" | \"top-trailing\"",
- "references": {
- "MenuPlacement": {
- "location": "import",
- "path": "../../utils/floating-ui"
- }
- }
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [{
- "name": "default",
- "text": "\"bottom-start\""
- }],
- "text": "Specifies the placement of the `calcite-date-picker` relative to the component."
- },
- "attribute": "placement",
- "reflect": true,
- "defaultValue": "defaultMenuPlacement"
- },
- "range": {
- "type": "boolean",
- "mutable": false,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "When `true`, activates a range for the component."
- },
- "attribute": "range",
- "reflect": true,
- "defaultValue": "false"
- },
- "required": {
- "type": "boolean",
- "mutable": false,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [{
- "name": "internal",
- "text": undefined
- }],
- "text": "When `true`, the component must have a value in order for the form to submit."
- },
- "attribute": "required",
- "reflect": true,
- "defaultValue": "false"
- },
- "start": {
- "type": "string",
- "mutable": true,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `value` instead."
- }],
- "text": "The component's start date."
- },
- "attribute": "start",
- "reflect": true
- },
- "end": {
- "type": "string",
- "mutable": true,
- "complexType": {
- "original": "string",
- "resolved": "string",
- "references": {}
- },
- "required": false,
- "optional": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `value` instead."
- }],
- "text": "The component's end date."
- },
- "attribute": "end",
- "reflect": true
- },
- "overlayPositioning": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "OverlayPositioning",
- "resolved": "\"absolute\" | \"fixed\"",
- "references": {
- "OverlayPositioning": {
- "location": "import",
- "path": "../../utils/floating-ui"
- }
- }
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "Determines the type of positioning to use for the overlaid content.\n\nUsing `\"absolute\"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout.\n\n`\"fixed\"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `\"fixed\"`."
- },
- "attribute": "overlay-positioning",
- "reflect": true,
- "defaultValue": "\"absolute\""
- },
- "proximitySelectionDisabled": {
- "type": "boolean",
- "mutable": false,
- "complexType": {
- "original": "boolean",
- "resolved": "boolean",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "When `true`, disables the default behavior on the third click of narrowing or extending the range.\nInstead starts a new range."
- },
- "attribute": "proximity-selection-disabled",
- "reflect": false,
- "defaultValue": "false"
- },
- "layout": {
- "type": "string",
- "mutable": false,
- "complexType": {
- "original": "\"horizontal\" | \"vertical\"",
- "resolved": "\"horizontal\" | \"vertical\"",
- "references": {}
- },
- "required": false,
- "optional": false,
- "docs": {
- "tags": [],
- "text": "Defines the layout of the component."
- },
- "attribute": "layout",
- "reflect": true,
- "defaultValue": "\"horizontal\""
- }
- };
- }
- static get states() {
- return {
- "effectiveLocale": {},
- "focusedInput": {},
- "globalAttributes": {},
- "localeData": {}
- };
- }
- static get events() {
- return [{
- "method": "calciteDatePickerChange",
- "name": "calciteDatePickerChange",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [{
- "name": "deprecated",
- "text": "use `calciteInputDatePickerChange` instead."
- }],
- "text": "Fires when a user changes the date."
- },
- "complexType": {
- "original": "Date",
- "resolved": "Date",
- "references": {
- "Date": {
- "location": "global"
- }
- }
- }
- }, {
- "method": "calciteDatePickerRangeChange",
- "name": "calciteDatePickerRangeChange",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [{
- "name": "see",
- "text": "[DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/date-picker/interfaces.ts#L1)"
- }, {
- "name": "deprecated",
- "text": "use `calciteInputDatePickerChange` instead."
- }],
- "text": "Fires when a user changes the date range."
- },
- "complexType": {
- "original": "DateRangeChange",
- "resolved": "DateRangeChange",
- "references": {
- "DateRangeChange": {
- "location": "import",
- "path": "../date-picker/interfaces"
- }
- }
- }
- }, {
- "method": "calciteInputDatePickerChange",
- "name": "calciteInputDatePickerChange",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [],
- "text": "Fires when the component's value changes."
- },
- "complexType": {
- "original": "void",
- "resolved": "void",
- "references": {}
- }
- }, {
- "method": "calciteInputDatePickerBeforeClose",
- "name": "calciteInputDatePickerBeforeClose",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [],
- "text": "Fires when the component is requested to be closed and before the closing transition begins."
- },
- "complexType": {
- "original": "void",
- "resolved": "void",
- "references": {}
- }
- }, {
- "method": "calciteInputDatePickerClose",
- "name": "calciteInputDatePickerClose",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [],
- "text": "Fires when the component is closed and animation is complete."
- },
- "complexType": {
- "original": "void",
- "resolved": "void",
- "references": {}
- }
- }, {
- "method": "calciteInputDatePickerBeforeOpen",
- "name": "calciteInputDatePickerBeforeOpen",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [],
- "text": "Fires when the component is added to the DOM but not rendered, and before the opening transition begins."
- },
- "complexType": {
- "original": "void",
- "resolved": "void",
- "references": {}
- }
- }, {
- "method": "calciteInputDatePickerOpen",
- "name": "calciteInputDatePickerOpen",
- "bubbles": true,
- "cancelable": false,
- "composed": true,
- "docs": {
- "tags": [],
- "text": "Fires when the component is open and animation is complete."
- },
- "complexType": {
- "original": "void",
- "resolved": "void",
- "references": {}
- }
- }];
- }
- static get methods() {
- return {
- "setFocus": {
- "complexType": {
- "signature": "() => Promise<void>",
- "parameters": [],
- "references": {
- "Promise": {
- "location": "global"
- }
- },
- "return": "Promise<void>"
- },
- "docs": {
- "text": "Sets focus on the component.",
- "tags": []
- }
- },
- "reposition": {
- "complexType": {
- "signature": "(delayed?: boolean) => Promise<void>",
- "parameters": [{
- "tags": [{
- "name": "param",
- "text": "delayed"
- }],
- "text": ""
- }],
- "references": {
- "Promise": {
- "location": "global"
- }
- },
- "return": "Promise<void>"
- },
- "docs": {
- "text": "Updates the position of the component.",
- "tags": [{
- "name": "param",
- "text": "delayed"
- }]
- }
- }
- };
- }
- static get elementRef() { return "el"; }
- static get watchers() {
- return [{
- "propName": "disabled",
- "methodName": "handleDisabledAndReadOnlyChange"
- }, {
- "propName": "readOnly",
- "methodName": "handleDisabledAndReadOnlyChange"
- }, {
- "propName": "value",
- "methodName": "valueHandler"
- }, {
- "propName": "flipPlacements",
- "methodName": "flipPlacementsHandler"
- }, {
- "propName": "min",
- "methodName": "onMinChanged"
- }, {
- "propName": "max",
- "methodName": "onMaxChanged"
- }, {
- "propName": "active",
- "methodName": "activeHandler"
- }, {
- "propName": "open",
- "methodName": "openHandler"
- }, {
- "propName": "overlayPositioning",
- "methodName": "overlayPositioningHandler"
- }, {
- "propName": "layout",
- "methodName": "setReferenceEl"
- }, {
- "propName": "focusedInput",
- "methodName": "setReferenceEl"
- }, {
- "propName": "start",
- "methodName": "startWatcher"
- }, {
- "propName": "end",
- "methodName": "endWatcher"
- }, {
- "propName": "effectiveLocale",
- "methodName": "loadLocaleData"
- }];
- }
- static get listeners() {
- return [{
- "name": "calciteDatePickerChange",
- "method": "handleDateOrRangeChange",
- "target": undefined,
- "capture": false,
- "passive": false
- }, {
- "name": "calciteDatePickerRangeChange",
- "method": "handleDateOrRangeChange",
- "target": undefined,
- "capture": false,
- "passive": false
- }, {
- "name": "calciteDaySelect",
- "method": "calciteDaySelectHandler",
- "target": undefined,
- "capture": false,
- "passive": false
- }];
- }
- }
|