Skip to content

Latest commit

 

History

History
97 lines (70 loc) · 4.4 KB

README.md

File metadata and controls

97 lines (70 loc) · 4.4 KB
Raw

knockout.moment-binding

A knockout date parser by Graham Charles.

A working demo is available.

Dependencies

Usage

Invoke the binding by using the moment: value within the data-bind attribute, typically on an <input> element.

<input type="text" data-bind="moment: dateOfBirth" />

The text displayed in the input will be the date as formatted by the moment.js library, or no text. The value returned by the view model will be a JavaScript Date (or undefined).

You can set the value of the view model property in code to a JavaScript Date or a string to be parsed:

viewModel.dateOfBirth("2010-07-01");
viewModel.dateOfBirth(new Date (2010, 6, 1));
viewModel.dateOfBirth("1/1");

If the value cannot be parsed into a valid date, the control will display the invalid text.

Options

  • format (default 'MM/DD/YYYY'): A format string to use for display.
  • parsePattern (default ['M/D/YY', 'M/D/YYYY', 'YYYY-M-D', 'M/D']): A format string (or array of format strings) to use for transforming input into a date.
  • invalid (default '-'): A value to display if the date is invalid.
  • beforeParse (default: undefined): A function that takes text input and returns either a valid Date, an altered string to be parsed, or undefined. For example, to parse the string 'today', you could use Example 1, below.
  • afterParse (default: undefined): A function that takes date (or undefined) input and returns either true (to allow the input), false or undefined (to disallow the input, as for an illegal value), or a different Date (or moment) object. For example, to require a weekday entry, this function might return the previous day for Saturday dates, the next day for Sunday dates.
  • keyPressed (default: undefined): A function that translates a change amount and units into a new date. It passes parameters currentdate (moment), change (int), unit (string), and keycode (int), and expects a date value in return. If nothing is returned, then default changes are made; if a date or valid moment is returned, that will be used as the new value. (You could use this event to skip weekends when using the arrow keys, for example.)
  • unit (default: 'day'): A value for the default unit used in keymapping; change this to 'month', for example, and the arrow keys will advance one month instead of one day by default.
  • keymap: (default: up = -1 day, pageup = -1 month, etc.) An object that maps keycodes to date-changing behavior. See "Keymapping," below.

Keymapping

The keymap is an object in the form:

{ key1: { unit: 'day', change: -1 }, ... }

where

  • key: a keycode
  • unit: a unit name as recognized by moment.js (e.g. 'day') (default = 'day')
  • change: is a positive or negative value

The default mapping is:

  • up, left: subtract one day
  • right, down: add one day
  • page up: subtract one month
  • page down: add one month

Examples

Typical day-style usage

 <input type="text" data-bind="moment: dateOfBirth, 
    format: 'MMMM D, YYYY', 
	invalid: 'invalid date', 
    beforeParse:function(d) { 
		if (d=='today') { return new Date() } 
		else return d; }
 "  />

Exclude weekends on key press

    <input type="text" data-bind="moment: dateOfBirth, 
    format: 'MMMM D, YYYY', 
	keyPressed: function( oldValue, change, unit, keycode) {
        var newValue = moment(oldValue);
        if (!newValue.isValid()) { newValue = moment(); } else {
            newValue = newValue.add(change, unit);
            while (newValue.day() === 0 || newValue.day() === 6) {
                newValue.add (Math.sign(change) || 1, "day");
            }
        }
        return newValue;
	}        
	" />

Month-style###

Allows month/year entry and U.S.-style formatting. If an invalid date is entered, defaults to the current month. The value returned to the view model is always the 1st of the month.

<input type="text" data-bind="
    moment: dateMonth, 
    format: 'MMMM YYYY', 
    unit:'month', 
    parsePattern: ['M/YY', 'M/YYYY', 'YYYY-M' ], afterParse: function(d) 
       { return moment(d).isValid() ? 
           moment(d).startOf('month') 
           : moment(d).startOf('month'); }
"/>