README.md

angularx flatpickr

Demo

https://mattlewis92.github.io/angularx-flatpickr/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

An angular 17.0+ wrapper for flatpickr

Installation

Install through npm:

npm install flatpickr angularx-flatpickr

Next, in your angular.json add "node_modules/flatpickr/dist/flatpickr.css" to the styles array of your application

Then include in your apps module:

import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { FlatpickrModule } from 'angularx-flatpickr';

@NgModule({
  imports: [FormsModule, FlatpickrModule.forRoot()],
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: ` <input type="text" mwlFlatpickr [(ngModel)]="selectedDate" [altInput]="true" [convertModelValue]="true" /> `,
})
export class MyComponent {}

You may also find it useful to view the demo source.

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://mattlewis92.github.io/angularx-flatpickr/docs/

Development

Prepare your environment

• Install Node.js (>=14.19.0 or >=16.9.0)
• Install pnpm: corepack enable
• Install local dev dependencies: pnpm install while current directory is this repo

Development server

Run pnpm start to start a development server on port 8000 with auto reload + tests.

Testing

Run pnpm test to run tests once or pnpm test:watch to continually run tests.

Release

pnpm run release

License

MIT