kneath / timeframe-mootools
watch download tarball
public
Forks1Right
Watchers12Right
Description: Click-draggable. Range-makeable. A better calendar. In MooTools.
Homepage:
Clone URL: git://github.com/kneath/timeframe-mootools.git
timeframe-mootools / README.markdown
raw normal view history
563bb775 » kneath 2008-10-16 Initial Commit 1 # Timeframe
2
3 Click-draggable. Range-makeable. A better calendar. In MooTools.
4
5 A port of Stephen Celis's [Timeframe for Prototype](http://github.com/stephencelis/timeframe/tree/master). The Public API should be the same.
6
7 ## A work in progress
8
51924401 » kneath 2008-10-19 Let everyone know it works ... 9 This is still a work in process, but it should be mostly working at this point.
563bb775 » kneath 2008-10-16 Initial Commit 10
11 ## The Code
12
13 new Timeframe(element, options);
14
15
16 ### Options available:
17
18 * `months`:
19 The number of calendar months showing at once (default: `2`).
20
21 * `format`:
22 The strftime format for the dates in the input fields (default:
23 `%b %d, %Y`). (With [Datejs](http://datejs.com), it takes Datejs
24 formatting.)
25
26 * `weekOffset`:
27 Override the localization's default weekday start with this option (e.g.,
28 `1` will force the rows to start on Monday; use `0` for Sunday).
29
30 * `startField`, `endField`:
31 Declare the range start and end input tags (by default, these are generated
32 with the Timeframe). When the `value` attribute is pre-populated, the
33 Timeframe will load with this range.
34
35 * `previousButton`, `todayButton`, `nextButton`, `resetButton`:
36 Declare the navigational buttons (these are also generated by default with
37 the Timeframe).
38
39 * `earliest`, `latest`:
40 The earliest and latest selectable dates (accepts either a `Date` object or
41 a `String` that can be parsed with `Date.parse()`).
42
43 * `maxRange`:
44 Limit the maximum possible range length (set to `1` to turn Timeframe into
45 a regular old date picker).
46
47
48 ### Localization:
49
50 Drop in a localized version of [Datejs](http://datejs.com), and it should just
51 work. An added bonus is that the text fields will live-parse more nicely! Just
52 try "next tues."