Wondering what’s next for npm?Check out our public roadmap! »

    @angular-material-components/datetime-picker
    TypeScript icon, indicating that this package has built-in type declarations

    5.1.0 • Public • Published

    Angular Material DatetimePicker, Timepicker for @angular/material 7.x, 8.x, 9.x, 10.x, 11.x

    Build Status License npm version

    Description

    A DatetimePicker like @angular/material Datepicker by adding support for choosing time.

    button

    DEMO

    @see LIVE DEMO AND DOCUMENTATION

    @see DEMO stackblitz

    Alt Text

    Choose the version corresponding to your Angular version:

    Angular @angular-material-components/datetime-picker
    11 5.x+
    10 4.x+
    9 2.x+
    8 2.x+
    7 2.x+

    Getting started

    npm install --save  @angular-material-components/datetime-picker
    

    Setup

    Basically the same way the @angular/material Datepicker is configured and imported.

    import { NgxMatDatetimePickerModule, NgxMatTimepickerModule } from '@angular-material-components/datetime-picker';
    @NgModule({
       ...
       imports: [
          BrowserModule,
          HttpClientModule,
          BrowserAnimationsModule,
          MatDatepickerModule,
          MatInputModule,
          NgxMatTimepickerModule,
          FormsModule,
          ReactiveFormsModule,
          MatButtonModule,
          NgxMatDatetimePickerModule,
       ],
       ...
    })
    export class AppModule { }
    

    @see src/app/demo-datetime/demo-datetime.module.ts

    Using the component

    The same API as @angular/material Datepicker (@see API docs)

    Datetime Picker (ngx-mat-datetime-picker)

    <mat-form-field>
       <input matInput [ngxMatDatetimePicker]="picker" placeholder="Choose a date" [formControl]="dateControl"
          [min]="minDate" [max]="maxDate" [disabled]="disabled">
       <mat-datepicker-toggle matSuffix [for]="picker"></mat-datepicker-toggle>
       <ngx-mat-datetime-picker #picker [showSpinners]="showSpinners" [showSeconds]="showSeconds"
          [stepHour]="stepHour" [stepMinute]="stepMinute" [stepSecond]="stepSecond"
          [touchUi]="touchUi" [color]="color" [enableMeridian]="enableMeridian" 
          [disableMinute]="disableMinute" [hideTime]="hideTime">
       </ngx-mat-datetime-picker>
    </mat-form-field>
    

    Timepicker (ngx-mat-timepicker)

    <ngx-mat-timepicker [(ngModel)]="date"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [disabled]="disabled"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [stepHour]="2" [stepMinute]="5" [stepSecond]="10"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [showSpinners]="showSpinners"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [showSeconds]="showSeconds"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [disableMinute]="disableMinute"></ngx-mat-timepicker>
    <ngx-mat-timepicker [(ngModel)]="date" [defaultTime]="defaultTime"></ngx-mat-timepicker>
    <ngx-mat-timepicker [formControl]="formControl"></ngx-mat-timepicker>
    

    List of @Input of ngx-mat-timepicker

    You can use all @Input of ngx-mat-timepicker for ngx-mat-datetime-picker

    @Input Type Default value Description
    disabled boolean null If true, the picker is readonly and can't be modified
    showSpinners boolean true If true, the spinners above and below input are visible
    showSeconds boolean true If true, it is not possible to select seconds
    disableMinute boolean false If true, the minute (and second) is readonly
    defaultTime Array undefined An array [hour, minute, second] for default time when the date is not yet defined
    stepHour number 1 The number of hours to add/substract when clicking hour spinners
    stepMinute number 1 The number of minutes to add/substract when clicking minute spinners
    stepSecond number 1 The number of seconds to add/substract when clicking second spinners
    color ThemePalette undefined Color palette to use on the datepicker's calendar.
    enableMeridian boolean false Whether to display 12H or 24H mode.
    hideTime boolean false If true, the time is hidden.
    touchUi boolean false Whether the calendar UI is in touch mode. In touch mode the calendar opens in a dialog rather than a popup and elements have more padding to allow for bigger touch targets.

    Choosing a date implementation and date format settings

    The datepicker was built to be date implementation agnostic. This means that it can be made to work with a variety of different date implementations. However it also means that developers need to make sure to provide the appropriate pieces for the datepicker to work with their chosen implementation.

    The easiest way to ensure this is to import one of the provided date modules:

    NgxMatNativeDateModule NgxMatMomentModule
    Date type Date Moment
    Supported locales en-US See project for details
    Dependencies None Moment.js
    Import from @angular-material-components/datetime-picker @angular-material-components/moment-adapter

    To use NgxMatMomentModule:

    npm install --save  @angular-material-components/moment-adapter
    

    Please note: NgxMatNativeDateModule is based off the functionality available in JavaScript's native Date object. Thus it is not suitable for many locales. One of the biggest shortcomings of the native Date object is the inability to set the parse format.

    We highly recommend using the NgxMatMomentModule or a custom NgxMatDateAdapter that works with the formatting/parsing library of your choice.

    For example:

    Creating a custom date adapter:

    @Injectable()
    export class CustomDateAdapter extends NgxMatDateAdapter<D> {...}
    // D can be Date, Moment or customized type
    

    Creating a custom date adapter module

    @NgModule({
      providers: [
        {
          provide: NgxMatDateAdapter,
          useClass: CustomDateAdapter,
          deps: [MAT_DATE_LOCALE, NGX_MAT_MOMENT_DATE_ADAPTER_OPTIONS]
        }
      ],
    })
    export class CustomDateModule { }
    

    You can also customize the date format by providing your custom NGX_MAT_DATE_FORMATS in your module.

    // If using Moment
    const CUSTOM_DATE_FORMATS: NgxMatDateFormats = {
      parse: {
        dateInput: "l, LTS"
      },
      display: {
        dateInput: "l, LTS",
        monthYearLabel: "MMM YYYY",
        dateA11yLabel: "LL",
        monthYearA11yLabel: "MMMM YYYY"
      }
    };
    
    //and in the module providers 
    providers: [
        { provide: NGX_MAT_DATE_FORMATS, useValue: CUSTOM_MOMENT_FORMATS }
      ]
    

    Theming

    <link href="https://fonts.googleapis.com/icon?family=Material+Icons&display=block" rel="stylesheet">
    

    License

    MIT

    Install

    npm i @angular-material-components/datetime-picker

    DownloadsWeekly Downloads

    21,421

    Version

    5.1.0

    License

    MIT

    Unpacked Size

    1.98 MB

    Total Files

    48

    Last publish

    Collaborators

    • avatar