123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455 |
- import { AfterContentInit, ElementRef, EventEmitter, OnDestroy, Renderer } from '@angular/core';
- import { ControlValueAccessor } from '@angular/forms';
- import { Config } from '../../config/config';
- import { Picker } from '../picker/picker';
- import { PickerController } from '../picker/picker-controller';
- import { Form } from '../../util/form';
- import { BaseInput } from '../../util/base-input';
- import { Item } from '../item/item';
- import { DateTimeData, LocaleData } from '../../util/datetime-util';
- /**
- * @name DateTime
- * @description
- * The DateTime component is used to present an interface which makes it easy for
- * users to select dates and times. Tapping on `<ion-datetime>` will display a picker
- * interface that slides up from the bottom of the page. The picker then displays
- * scrollable columns that can be used to individually select years, months, days,
- * hours and minute values. The DateTime component is similar to the native
- * `<input type="datetime-local">` element, however, Ionic's DateTime component makes
- * it easy to display the date and time in a preferred format, and manage the datetime
- * values.
- *
- * ```html
- * <ion-item>
- * <ion-label>Date</ion-label>
- * <ion-datetime displayFormat="MM/DD/YYYY" [(ngModel)]="myDate"></ion-datetime>
- * </ion-item>
- * ```
- *
- *
- * ## Display and Picker Formats
- *
- * The DateTime component displays the values in two places: in the `<ion-datetime>`
- * component, and in the interface that is presented from the bottom of the screen.
- * The following chart lists all of the formats that can be used.
- *
- * | Format | Description | Example |
- * |---------|--------------------------------|-------------------------|
- * | `YYYY` | Year, 4 digits | `2018` |
- * | `YY` | Year, 2 digits | `18` |
- * | `M` | Month | `1` ... `12` |
- * | `MM` | Month, leading zero | `01` ... `12` |
- * | `MMM` | Month, short name | `Jan` |
- * | `MMMM` | Month, full name | `January` |
- * | `D` | Day | `1` ... `31` |
- * | `DD` | Day, leading zero | `01` ... `31` |
- * | `DDD` | Day, short name | `Fri` |
- * | `DDDD` | Day, full name | `Friday` |
- * | `H` | Hour, 24-hour | `0` ... `23` |
- * | `HH` | Hour, 24-hour, leading zero | `00` ... `23` |
- * | `h` | Hour, 12-hour | `1` ... `12` |
- * | `hh` | Hour, 12-hour, leading zero | `01` ... `12` |
- * | `a` | 12-hour time period, lowercase | `am` `pm` |
- * | `A` | 12-hour time period, uppercase | `AM` `PM` |
- * | `m` | Minute | `1` ... `59` |
- * | `mm` | Minute, leading zero | `01` ... `59` |
- * | `s` | Second | `1` ... `59` |
- * | `ss` | Second, leading zero | `01` ... `59` |
- * | `Z` | UTC Timezone Offset | `Z or +HH:mm or -HH:mm` |
- *
- * **Important**: See the [Month Names and Day of the Week Names](#month-names-and-day-of-the-week-names)
- * section below on how to use different names for the month and day.
- *
- * ### Display Format
- *
- * The `displayFormat` input property specifies how a datetime's value should be
- * printed, as formatted text, within the `ion-datetime` component.
- *
- * In the following example, the display in the `<ion-datetime>` will use the
- * month's short name, the numerical day with a leading zero, a comma and the
- * four-digit year. In addition to the date, it will display the time with the hours
- * in the 24-hour format and the minutes. Any character can be used as a separator.
- * An example display using this format is: `Jun 17, 2005 11:06`.
- *
- * ```html
- * <ion-item>
- * <ion-label>Date</ion-label>
- * <ion-datetime displayFormat="MMM DD, YYYY HH:mm" [(ngModel)]="myDate"></ion-datetime>
- * </ion-item>
- * ```
- *
- * ### Picker Format
- *
- * The `pickerFormat` input property determines which columns should be shown in the
- * interface, the order of the columns, and which format to use within each column.
- * If the `pickerFormat` input is not provided then it will default to the `displayFormat`.
- *
- * In the following example, the display in the `<ion-datetime>` will use the
- * `MM/YYYY` format, such as `06/2020`. However, the picker interface
- * will display two columns with the month's long name, and the four-digit year.
- *
- * ```html
- * <ion-item>
- * <ion-label>Date</ion-label>
- * <ion-datetime displayFormat="MM/YYYY" pickerFormat="MMMM YYYY" [(ngModel)]="myDate"></ion-datetime>
- * </ion-item>
- * ```
- *
- * ### Datetime Data
- *
- * Historically, handling datetime values within JavaScript, or even within HTML
- * inputs, has always been a challenge. Specifically, JavaScript's `Date` object is
- * notoriously difficult to correctly parse apart datetime strings or to format
- * datetime values. Even worse is how different browsers and JavaScript versions
- * parse various datetime strings differently, especially per locale.
- *
- * But no worries, all is not lost! Ionic's datetime input has been designed so
- * developers can avoid the common pitfalls, allowing developers to easily format
- * datetime values within the input, and give the user a simple datetime picker for a
- * great user experience.
- *
- * ##### ISO 8601 Datetime Format: YYYY-MM-DDTHH:mmZ
- *
- * Ionic uses the [ISO 8601 datetime format](https://www.w3.org/TR/NOTE-datetime)
- * for its value. The value is simply a string, rather than using JavaScript's `Date`
- * object. Additionally, when using the ISO datetime format, it makes it easier
- * to serialize and pass within JSON objects, and sending databases a standardized
- * format which it can be easily parsed if need be.
- *
- * To create an ISO datetime string for the current date and time, e.g. use `const currentDate = (new Date()).toISOString();`.
- *
- * An ISO format can be used as a simple year, or just the hour and minute, or get more
- * detailed down to the millisecond and timezone. Any of the ISO formats below can be used,
- * and after a user selects a new value, Ionic will continue to use the same ISO format
- * which datetime value was originally given as.
- *
- * | Description | Format | Datetime Value Example |
- * |----------------------|------------------------|------------------------------|
- * | Year | YYYY | 1994 |
- * | Year and Month | YYYY-MM | 1994-12 |
- * | Complete Date | YYYY-MM-DD | 1994-12-15 |
- * | Date and Time | YYYY-MM-DDTHH:mm | 1994-12-15T13:47 |
- * | UTC Timezone | YYYY-MM-DDTHH:mm:ssTZD | 1994-12-15T13:47:20.789Z |
- * | Timezone Offset | YYYY-MM-DDTHH:mm:ssTZD | 1994-12-15T13:47:20.789+5:00 |
- * | Hour and Minute | HH:mm | 13:47 |
- * | Hour, Minute, Second | HH:mm:ss | 13:47:20 |
- *
- * Note that the year is always four-digits, milliseconds (if it's added) is always
- * three-digits, and all others are always two-digits. So the number representing
- * January always has a leading zero, such as `01`. Additionally, the hour is always
- * in the 24-hour format, so `00` is `12am` on a 12-hour clock, `13` means `1pm`,
- * and `23` means `11pm`.
- *
- * It's also important to note that neither the `displayFormat` or `pickerFormat` can
- * set the datetime value's output, which is the value that is set by the component's
- * `ngModel`. The format's are merely for displaying the value as text and the picker's
- * interface, but the datetime's value is always persisted as a valid ISO 8601 datetime
- * string.
- *
- *
- * ## Min and Max Datetimes
- *
- * Dates are infinite in either direction, so for a user's selection there should be at
- * least some form of restricting the dates that can be selected. By default, the maximum
- * date is to the end of the current year, and the minimum date is from the beginning
- * of the year that was 100 years ago.
- *
- * To customize the minimum and maximum datetime values, the `min` and `max` component
- * inputs can be provided which may make more sense for the app's use-case, rather
- * than the default of the last 100 years. Following the same IS0 8601 format listed
- * in the table above, each component can restrict which dates can be selected by the
- * user. Below is an example of restricting the date selection between the beginning
- * of 2016, and October 31st of 2020:
- *
- * ```html
- * <ion-item>
- * <ion-label>Date</ion-label>
- * <ion-datetime displayFormat="MMMM YYYY" min="2016" max="2020-10-31" [(ngModel)]="myDate">
- * </ion-datetime>
- * </ion-item>
- * ```
- *
- *
- * ## Month Names and Day of the Week Names
- *
- * At this time, there is no one-size-fits-all standard to automatically choose the correct
- * language/spelling for a month name, or day of the week name, depending on the language
- * or locale. Good news is that there is an
- * [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat)
- * standard which *most* browsers have adopted. However, at this time the standard has not
- * been fully implemented by all popular browsers so Ionic is unavailable to take advantage
- * of it *yet*. Additionally, Angular also provides an internationalization service, but it
- * is still under heavy development so Ionic does not depend on it at this time.
- *
- * All things considered, the by far easiest solution is to just provide an array of names
- * if the app needs to use names other than the default English version of month and day
- * names. The month names and day names can be either configured at the app level, or
- * individual `ion-datetime` level.
- *
- * ### App Config Level
- *
- * ```ts
- * //app.module.ts
- * @NgModule({
- * ...,
- * imports: [
- * IonicModule.forRoot(MyApp, {
- * monthNames: ['janeiro', 'fevereiro', 'mar\u00e7o', ... ],
- * monthShortNames: ['jan', 'fev', 'mar', ... ],
- * dayNames: ['domingo', 'segunda-feira', 'ter\u00e7a-feira', ... ],
- * dayShortNames: ['dom', 'seg', 'ter', ... ],
- * })
- * ],
- * ...
- * })
- * ```
- *
- * ### Component Input Level
- *
- * ```html
- * <ion-item>
- * <ion-label>Período</ion-label>
- * <ion-datetime displayFormat="DDDD MMM D, YYYY" [(ngModel)]="myDate"
- * monthNames="janeiro, fevereiro, mar\u00e7o, ..."
- * monthShortNames="jan, fev, mar, ..."
- * dayNames="domingo, segunda-feira, ter\u00e7a-feira, ..."
- * dayShortNames="dom, seg, ter, ..."></ion-datetime>
- * </ion-item>
- * ```
- *
- *
- * ### Advanced Datetime Validation and Manipulation
- *
- * The datetime picker provides the simplicity of selecting an exact format, and persists
- * the datetime values as a string using the standardized
- * [ISO 8601 datetime format](https://www.w3.org/TR/NOTE-datetime).
- * However, it's important to note that `ion-datetime` does not attempt to solve all
- * situtations when validating and manipulating datetime values. If datetime values need
- * to be parsed from a certain format, or manipulated (such as adding 5 days to a date,
- * subtracting 30 minutes, etc.), or even formatting data to a specific locale, then we highly
- * recommend using [moment.js](http://momentjs.com/) to "Parse, validate, manipulate, and
- * display dates in JavaScript". [Moment.js](http://momentjs.com/) has quickly become
- * our goto standard when dealing with datetimes within JavaScript, but Ionic does not
- * prepackage this dependency since most apps will not require it, and its locale
- * configuration should be decided by the end-developer.
- *
- *
- * @usage
- * ```html
- * <ion-item>
- * <ion-label>Date</ion-label>
- * <ion-datetime displayFormat="MM/DD/YYYY" [(ngModel)]="myDate">
- * </ion-datetime>
- * </ion-item>
- * ```
- *
- *
- * @demo /docs/demos/src/datetime/
- */
- export declare class DateTime extends BaseInput<DateTimeData> implements AfterContentInit, ControlValueAccessor, OnDestroy {
- private _pickerCtrl;
- _text: string;
- _min: DateTimeData;
- _max: DateTimeData;
- _locale: LocaleData;
- _picker: Picker;
- /**
- * @input {string} The minimum datetime allowed. Value must be a date string
- * following the
- * [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),
- * such as `1996-12-19`. The format does not have to be specific to an exact
- * datetime. For example, the minimum could just be the year, such as `1994`.
- * Defaults to the beginning of the year, 100 years ago from today.
- */
- min: string;
- /**
- * @input {string} The maximum datetime allowed. Value must be a date string
- * following the
- * [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),
- * `1996-12-19`. The format does not have to be specific to an exact
- * datetime. For example, the maximum could just be the year, such as `1994`.
- * Defaults to the end of this year.
- */
- max: string;
- /**
- * @input {string} The display format of the date and time as text that shows
- * within the item. When the `pickerFormat` input is not used, then the
- * `displayFormat` is used for both display the formatted text, and determining
- * the datetime picker's columns. See the `pickerFormat` input description for
- * more info. Defaults to `MMM D, YYYY`.
- */
- displayFormat: string;
- /**
- * @input {string} The default datetime selected in picker modal if field value is empty.
- * Value must be a date string following the
- * [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),
- * `1996-12-19`.
- */
- initialValue: string;
- /**
- * @input {string} The format of the date and time picker columns the user selects.
- * A datetime input can have one or many datetime parts, each getting their
- * own column which allow individual selection of that particular datetime part. For
- * example, year and month columns are two individually selectable columns which help
- * choose an exact date from the datetime picker. Each column follows the string
- * parse format. Defaults to use `displayFormat`.
- */
- pickerFormat: string;
- /**
- * @input {string} The text to display on the picker's cancel button. Default: `Cancel`.
- */
- cancelText: string;
- /**
- * @input {string} The text to display on the picker's "Done" button. Default: `Done`.
- */
- doneText: string;
- /**
- * @input {array | string} Values used to create the list of selectable years. By default
- * the year values range between the `min` and `max` datetime inputs. However, to
- * control exactly which years to display, the `yearValues` input can take either an array
- * of numbers, or string of comma separated numbers. For example, to show upcoming and
- * recent leap years, then this input's value would be `yearValues="2024,2020,2016,2012,2008"`.
- */
- yearValues: any;
- /**
- * @input {array | string} Values used to create the list of selectable months. By default
- * the month values range from `1` to `12`. However, to control exactly which months to
- * display, the `monthValues` input can take either an array of numbers, or string of
- * comma separated numbers. For example, if only summer months should be shown, then this
- * input value would be `monthValues="6,7,8"`. Note that month numbers do *not* have a
- * zero-based index, meaning January's value is `1`, and December's is `12`.
- */
- monthValues: any;
- /**
- * @input {array | string} Values used to create the list of selectable days. By default
- * every day is shown for the given month. However, to control exactly which days of
- * the month to display, the `dayValues` input can take either an array of numbers, or
- * string of comma separated numbers. Note that even if the array days have an invalid
- * number for the selected month, like `31` in February, it will correctly not show
- * days which are not valid for the selected month.
- */
- dayValues: any;
- /**
- * @input {array | string} Values used to create the list of selectable hours. By default
- * the hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However,
- * to control exactly which hours to display, the `hourValues` input can take either an
- * array of numbers, or string of comma separated numbers.
- */
- hourValues: any;
- /**
- * @input {array | string} Values used to create the list of selectable minutes. By default
- * the mintues range from `0` to `59`. However, to control exactly which minutes to display,
- * the `minuteValues` input can take either an array of numbers, or string of comma separated
- * numbers. For example, if the minute selections should only be every 15 minutes, then
- * this input value would be `minuteValues="0,15,30,45"`.
- */
- minuteValues: any;
- /**
- * @input {array} Full names for each month name. This can be used to provide
- * locale month names. Defaults to English.
- */
- monthNames: any;
- /**
- * @input {array} Short abbreviated names for each month name. This can be used to provide
- * locale month names. Defaults to English.
- */
- monthShortNames: any;
- /**
- * @input {array} Full day of the week names. This can be used to provide
- * locale names for each day in the week. Defaults to English.
- */
- dayNames: any;
- /**
- * @input {array} Short abbreviated day of the week names. This can be used to provide
- * locale names for each day in the week. Defaults to English.
- */
- dayShortNames: any;
- /**
- * @input {any} Any additional options that the picker interface can accept.
- * See the [Picker API docs](../../picker/Picker) for the picker options.
- */
- pickerOptions: any;
- /**
- * @input {string} The text to display when there's no date selected yet.
- * Using lowercase to match the input attribute
- */
- placeholder: string;
- /**
- * @output {any} Emitted when the datetime selection was cancelled.
- */
- ionCancel: EventEmitter<any>;
- constructor(form: Form, config: Config, elementRef: ElementRef, renderer: Renderer, item: Item, _pickerCtrl: PickerController);
- /**
- * @hidden
- */
- ngAfterContentInit(): void;
- /**
- * @hidden
- */
- _inputNormalize(val: any): DateTimeData;
- /**
- * @hidden
- */
- _inputUpdated(): void;
- /**
- * @hidden
- */
- _inputShouldChange(): boolean;
- /**
- * TODO: REMOVE THIS
- * @hidden
- */
- _inputChangeEvent(): any;
- /**
- * @hidden
- */
- _inputNgModelEvent(): any;
- _click(ev: UIEvent): void;
- _keyup(): void;
- /**
- * @hidden
- */
- open(): void;
- /**
- * @hidden
- */
- generate(): void;
- /**
- * @hidden
- */
- validateColumn(name: string, index: number, min: number, max: number, lowerBounds: number[], upperBounds: number[]): number;
- /**
- * @private
- */
- validate(): void;
- /**
- * @hidden
- */
- divyColumns(): void;
- /**
- * @hidden
- */
- updateText(): void;
- /**
- * @hidden
- */
- getValue(): DateTimeData;
- /**
- * @hidden
- */
- getValueOrDefault(): DateTimeData;
- /**
- * Get the default value as a date string
- * @hidden
- */
- getDefaultValueDateString(): string;
- /**
- * @hidden
- */
- hasValue(): boolean;
- /**
- * @hidden
- */
- calcMinMax(now?: Date): void;
- }
|