Skip to content
Simple, easy and performance countdown for angular
TypeScript HTML JavaScript CSS
Branch: master
Clone or download
cipchk releases: 8.0.3
- close #53
Latest commit 347501f Nov 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github refactor: refactor build Apr 5, 2018
.vscode release: 8.0.0 Aug 31, 2019
lib fix: move setTimeout out of NgZone #53 Nov 21, 2019
scripts build: used ng-packagr bundle lib, close #20, close #21 Sep 29, 2018
src fix: move setTimeout out of NgZone #53 Nov 21, 2019
.editorconfig release: 8.0.0 Aug 31, 2019
.gitignore build: used ng-packagr bundle lib, close #20, close #21 Sep 29, 2018
.npmignore first commit Apr 27, 2017
.nvmrc chore: fix travis Aug 31, 2019
.prettierignore feat: support angular6, closes #19 May 8, 2018
.prettierrc
.stylelintrc feat: support angular6, closes #19 May 8, 2018
.travis.yml chore: try fix travis Aug 31, 2019
CONTRIBUTING.md refactor: refactor build Apr 5, 2018
LICENSE refactor: refactor build Apr 5, 2018
README.md release: 8.0.0 Aug 31, 2019
angular.json release: 8.0.0 Aug 31, 2019
package.json releases: 8.0.3 Nov 24, 2019
tsconfig.json release: 8.0.0 Aug 31, 2019
tslint.json release: 8.0.0 Aug 31, 2019

README.md

ngx-countdown

Simple, easy and performance countdown for angular

NPM version Build Status

Demo

Usage

1. Install

npm install ngx-countdown --save

import CountdownModule

import { CountdownModule } from 'ngx-countdown';

@NgModule({
  imports: [ BrowserModule, CountdownModule ],
  declarations: [AppComponent],
  bootstrap: [AppComponent]
})
export class AppModule { }

2、Template

<countdown #cd [config]="config" (event)="handleEvent($event)"></countdown>

Method

Name Description
begin() Start countdown, you must manually call when demand: false
restart() Restart countdown
stop() Stop countdown, must call restart when stopped, it's different from pause, unable to recover
pause() Pause countdown, you can use resume to recover again
resume() Resume countdown

How call component methods

@ViewChild('cd', { static: false }) private countdown: CountdownComponent;
this.countdown.begin();

API

countdown

Name Type Default Summary
config CountdownConfig - Config
event EventEmitter<CountdownEvent> - Events

CountdownConfig

Name Type Default Summary
demand boolean false Start the counter on demand, must call begin() to starting
leftTime number 0 Calculate the remaining time based on the server, e.g: 10,5.5, (Unit: seconds)
stopTime number - Refers to counting down from local time to end time (Unit: Milliseconds second UNIX timestamp)
format string HH:mm:ss Formats a date value, pls refer to Accepted patterns
prettyText (text: string) => string - Beautify text, generally used to convert formatted time text into HTML
notify `number[] number` -
formatDate CountdownFormatFn - Default based on the implementation of formatDate in @angular/common, You can changed to other libs, e.g: date-fns
timezone string +0000 A timezone offset (such as '+0430'), or a standard UTC/GMT. When not supplied, uses the end-user's local system timezone

CountdownEvent

Name Type Summary
action start,stop,restart,pause,resume,notify,done Action of the event
status CountdownStatus Status of the countdown
left number Number of remaining milliseconds
text string Format the text

Global Config

function countdownConfigFactory(): CountdownGlobalConfig {
  return { format: `mm:ss` };
}

@NgModule({
  imports: [ CountdownModule ],
  providers: [
    { provide: CountdownGlobalConfig, useFactory: countdownConfigFactory }
  ],
})
export class AppDemoModule {}

Troubleshooting

Please follow this guidelines when reporting bugs and feature requests:

  1. Use GitHub Issues board to report bugs and feature requests (not our email address)
  2. Please always write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.

Thanks for understanding!

License

The MIT License (see the LICENSE file for the full text)

You can’t perform that action at this time.