/angularx-flatpickr

An angular 4.0+ wrapper for flatpickr

Primary LanguageTypeScriptMIT LicenseMIT

angularx flatpickr

Build Status codecov npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

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

Table of contents

About

An angular 4.0+ wrapper for flatpickr

Installation

Install through npm:

npm install --save angularx-flatpickr

Then include in your apps module:

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

@NgModule({
  imports: [
    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.

Usage without a module bundler

<script src="node_modules/angularx-flatpickr/bundles/angularx-flatpickr.umd.js"></script>
<script>
    // everything is exported angularxFlatpickr namespace
</script>

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 and yarn
  • Install local dev dependencies: yarn while current directory is this repo

Development server

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

Testing

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

Release

yarn run release

License

MIT