qing-timepicker v1.0.1

QingTimepicker

A simple timepicker component.

Usage

<script type="text/javascript" src="node_modules/jquery/dist/jquery.js"></script>
<script type="text/javascript" src="node_modules/moment/moment.js"></script>
<script type="text/javascript" src="node_modules/qing-module/dist/qing-module.js"></script>
<script type="text/javascript" src="node_modules/qing-timepicker/dist/qing-timepicker.js"></script>

<div class="qing-timepicker"></div>

var qingTimepicker = new QingTimepicker({
  el: '.qing-timepicker'
});

qingTimepicker.on('change', function(e, timeStr) {
  // do something
});

Options

el

Selector/Element/jQuery Object, required, specify the html element.

placeholder

String, specify placeholder for input text field.

format

String, 'HH:mm:ss'/'HH:mm'/'mm:ss', 'HH:mm:ss' by default, specify time format for time field value.

renderer

Function, which will be called after component renders. This option can be used to customize html structure.

Methods

setTime (time)

Set value for timepicker, time param should be Momentjs Object/String.

getTime ()

Get current selected time as String.

clear ()

Clear current selected time.

destroy ()

Destroy component, restore element to original state.

Events

change (event)

Triggered when current selected time is changed.

Installation

Install via npm:

npm install --save qing-timepicker

Development

Clone repository from github:

git clone https://github.com/mycolorway/qing-timepicker.git

Install npm dependencies:

npm install

Run default gulp task to build project, which will compile source files, run test and watch file changes for you:

gulp

Now, you are ready to go.

Publish

When you want to publish new version to npm and bower, please make sure all tests have passed, and you need to do these preparations:

• Add release information in CHANGELOG.md. The format of markdown contents will matter, because build scripts will get version and release content from the markdown file by regular expression. You can follow the format of the older releases.

• Put your personal API tokens in /.token.json(listed in .gitignore), which is required by the build scripts to request Github API for creating new release:

{
  "github": "[your github personal access token]"
}

Now you can run gulp publish task, which will do these work for you:

• Get version number from CHANGELOG.md and bump it into package.json and bower.json.
• Get release information from CHANGELOG.md and request Github API to create new release.

If everything goes fine, you can see your release at https://github.com/mycolorway/qing-module/releases. At the End you can publish new version to npm with the command:

npm publish

Please be careful with the last step, because you cannot delete or republish a version on npm.