ngx-cron-jobs
This repository contains an Angular > 2 version of angular-cron-jobs.
Installation
🎉 ngx-cron-jobs supports Angular 15 🎉
To install the latest version (15.2.1) of ngx-cron-jobs
$ npm install ngx-cron-jobs --save
or
$ yarn add ngx-cron-jobs
🎃
This is a hacktoberfest friendly repository Here are the following current enhancements
- [X] Upgrade to Angular version 14
- [X] UI support for every nth intervals (see https://github.com/yp2/ngx-cron-jobs/issues/54)
- [ ] Supporting the year field (see https://github.com/yp2/ngx-cron-jobs/issues/32)
Other enhancements are very, very welcome as well!
🥳
- Happy hacking! To install this library for Angular <=5, run:
$ npm install ngx-cron-jobs@0.x.x --save
$ yarn add ngx-cron-jobs@0.x.x
where x.x is 4.9. Is should look like this 0.4.9. Line for Angular 5 will have major set to 0.
To install this library for Angular 6, run:
$ npm install ngx-cron-jobs@6.x.x --save
$ yarn add ngx-cron-jobs@6.x.x
where x.x is 4.10. Is should look like this 6.4.10. Line for Angular 6 will have major set to 6.
To install this library for Angular 7, run:
$ npm install ngx-cron-jobs@7.x.x --save
$ yarn add ngx-cron-jobs@7.x.x
where x.x is 4.10. Is should look like this 7.4.10 Line for Angular 6 will have major set to 6.
Consuming your library
and then from your Angular AppModule
:
import { CronJobsModule } from 'ngx-cron-jobs';
@NgModule({
imports: [
...,
CronJobsModule,
...
]
})
export class AppModule { }
Once your library is imported, you can use its components, directives and pipes in your Angular application:
<!-- To insert to in your component minimal config with ngModel -->
<cron-jobs [(ngModel)]="hero.frequency"></cron-jobs>
<!-- To insert to in your component minimal config with reactive forms -->
<cron-jobs [formControl]="freqControl"></cron-jobs>
<!-- To insert to in your component minimal config with reactive forms -->
<!-- additional parameters -->
<cron-jobs [formControl]="freqControl" [config]="cronConfig" [validate]="cronValidate"></cron-jobs>
Configuration:
The component takes an input of [config]
and [validate]
Options
Plugin maybe configured by config object to which should be pass in [config]
input.
List of options:
Option | Type | Description |
---|---|---|
quartz | boolean (false) | Use quartz syntax rather then cron syntax in control output |
multiple | boolean (false) | Enable multi select in plugin selects |
bootstrap | boolean (true) | Use bootstrap 4 html and css classes to build plugin forms |
option | object | Additional options |
option.minute | boolean (true) | remove (false) or add minute to plugin select to control user ability to set cron expression. |
option.hour | boolean (true) | remove (false) or add hour to plugin select to control user ability to set cron expression. |
option.day | boolean (true) | remove (false) or add day to plugin select to control user ability to set cron expression. |
option.week | boolean (true) | remove (false) or add week to plugin select to control user ability to set cron expression. |
option.month | boolean (true) | remove (false) or add month to plugin select to control user ability to set cron expression. |
option.year | boolean (true) | remove (false) or add year to plugin select to control user ability to set cron expression. |
Additional to this plugin supports validation config ([validate]
input):
Option | Type | Description |
---|---|---|
validate | boolean (false) | Add validation classes if controls are invalid. |
License
MIT © Daniel 'yp2' Derezinski
Contributors
From angular 1 project
From angular2-cron-jobs project
From ngx-cron-jobs project