Primitives

Date Picker

A date picker is a component that allows users to select a date from a calendar and navigate through months and years.

May 2025

SMTWTFS

Import

Import the DatePicker primitives from ng-primitives/date-picker.

import {
  NgpDatePicker,
  NgpDatePickerLabel,
  NgpDatePickerNextMonth,
  NgpDatePickerPreviousMonth,
  NgpDatePickerGrid,
  NgpDatePickerCell,
  NgpDatePickerRowRender,
  NgpDatePickerCellRender,
  NgpDatePickerDateButton,
} from 'ng-primitives/date-picker';

Usage

Assemble the date-picker directives in your template.

<div ngpDatePicker>
  <div>
    <button ngpDatePickerPreviousMonth>...</button>
    <h2 ngpDatePickerLabel>...</h2>
    <button ngpDatePickerNextMonth>...</button>
  </div>
  <table ngpDatePickerGrid>
    <thead>
      <tr>
        <th scope="col" abbr="Sunday">S</th>
        ...
      </tr>
    </thead>
    <tbody>
      <tr *ngpDatePickerRowRender>
        <td *ngpDatePickerCellRender="let date" ngpDatePickerCell>
          <button ngpDatePickerDateButton>...</button>
        </td>
      </tr>
    </tbody>
  </table>
</div>

Reusable Component

Create a reusable component that uses the date picker directives.

import { Component } from '@angular/core';
import { DatePicker } from './date-picker';

@Component({
  selector: 'app-root',
  imports: [DatePicker],
  template: `
    <app-date-picker />
  `,
})
export default class App {}

Schematics

Generate a reusable date-picker component using the Angular CLI.

ng g ng-primitives:primitive date-picker

Options

  • path: The path at which to create the component file.
  • prefix: The prefix to apply to the generated component selector.
  • componentSuffix: The suffix to apply to the generated component class name.
  • fileSuffix: The suffix to apply to the generated component file name. Defaults to component.
  • exampleStyles: Whether to include example styles in the generated component file. Defaults to true.

API Reference

By default, the date picker uses the native JavaScript Date object, however the date picker is designed to work with any date library. To use a date library, such as Luxon, you need to specify the appropriate date adapter. The date adapter is an abstraction layer that allows components to use date objects from any date library, ensuring compatibility and easy integration. To learn more about the date adapter, see the Date Adapter documentation.

The following directives are available to import from the ng-primitives/date-picker package:

NgpDatePicker

The outermost container for the date picker.

  • Selector: [ngpDatePicker]
  • Exported As: ngpDatePicker
ngpDatePickerMin
T | undefined

The minimum date that can be selected.

ngpDatePickerMax
T | undefined

The maximum date that can be selected.

ngpDatePickerDisabled
boolean

Determine if the date picker is disabled.

ngpDatePickerDateDisabled
(date: T) => boolean

A function that is called to determine if a specific date should be disabled.

ngpDatePickerDate
T | undefined

The selected value.

ngpDatePickerFocusedDate
T

The focused value.

ngpDatePickerDateChange
T | undefined

Emit when the date changes.

ngpDatePickerFocusedDateChange
T

Emit when the focused date changes.

Data Attributes

The following data attributes are available on the ngpDatePicker directive:

Attribute Description
data-disabled Applied when the date picker is disabled.

NgpDatePickerLabel

The label that displays the current month and year typically in the header of the date picker. This will be announced by screen readers when the date changes.

  • Selector: [ngpDatePickerLabel]
  • Exported As: ngpDatePickerLabel
aria-live
string

Define the aria live attribute.

Data Attributes

The following data attributes are available on the ngpDatePickerLabel directive:

Attribute Description
data-disabled Applied when the date picker is disabled.

NgpDatePickerPreviousMonth

A button that navigates to the previous month.

  • Selector: [ngpDatePickerPreviousMonth]
  • Exported As: ngpDatePickerPreviousMonth

Data Attributes

The following data attributes are available on the ngpDatePickerPreviousMonth directive:

Attribute Description
data-hover Applied when the button is hovered.
data-focus-visible Applied when the button is focused.
data-press Applied when the button is pressed.
data-disabled Applied when the button is disabled.

NgpDatePickerNextMonth

A button that navigates to the next month.

  • Selector: [ngpDatePickerNextMonth]
  • Exported As: ngpDatePickerNextMonth

Data Attributes

The following data attributes are available on the ngpDatePickerNextMonth directive:

Attribute Description
data-hover Applied when the button is hovered.
data-focus-visible Applied when the button is focused.
data-press Applied when the button is pressed.
data-disabled Applied when the button is disabled.

NgpDatePickerGrid

The grid that contains the days of the month.

  • Selector: [ngpDatePickerGrid]
  • Exported As: ngpDatePickerGrid

Data Attributes

The following data attributes are available on the ngpDatePickerGrid directive:

Attribute Description
data-disabled Applied when the date picker is disabled.

NgpDatePickerRowRender

A structural directive that renders a row of weekdays in the date picker grid.

  • Selector: [ngpDatePickerRowRender]
  • Exported As: ngpDatePickerRowRender

NgpDatePickerCellRender

A structural directive that renders a cell in the date picker grid.

  • Selector: *ngpDatePickerCellRender
  • Exported As: ngpDatePickerCellRender

The following context fields are available on the ngpDatePickerCellRender directive:

$implicit
T

The date value for the cell.

NgpDatePickerCell

A cell in the date picker grid.

  • Selector: [ngpDatePickerCell]
  • Exported As: ngpDatePickerCell

Data Attributes

The following data attributes are available on the ngpDatePickerCell directive:

Attribute Description
data-disabled Applied when the cell is disabled.
data-selected Applied when the cell is selected.

NgpDatePickerDateButton

A button that represents a date in the date picker grid.

  • Selector: [ngpDatePickerDateButton]
  • Exported As: ngpDatePickerDateButton

Data Attributes

The following data attributes are available on the ngpDatePickerDateButton directive:

Attribute Description
data-selected Applied when the button is selected.
data-outside-month Applied when the button is outside the current month.
data-today Applied when the button represents the current date.
data-hover Applied when the button is hovered.
data-focus-visible Applied when the button is focused.
data-press Applied when the button is pressed.
data-disabled Applied when the button is disabled.

Accessibility

Adheres to the WAI-ARIA design pattern.

Keyboard Interactions

  • Space - Selects the focused date.
  • Enter - Selects the focused date.
  • ArrowUp - Moves focus to the same day of the previous week.
  • ArrowDown - Moves focus to the same day of the next week.
  • ArrowLeft - Moves focus to the previous day.
  • ArrowRight - Moves focus to the next day.
  • Home - Moves focus to the first day of the month.
  • End - Moves focus to the last day of the month.
  • PageUp - Moves focus to the same date in the previous month.
  • PageDown - Moves focus to the same date in the next month.

Copyright © 2025 Angular Primitives