Skip to content

Commit 385e3f4

Browse files
martijnrusschenmartijnrusschen
committed
Publish new API docs (automated commit)
1 parent 69fad28 commit 385e3f4

File tree

2 files changed

+71
-96
lines changed

2 files changed

+71
-96
lines changed

‎docs/index.md‎

Lines changed: 70 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,73 @@
11
# `index` (component)
22

3-
General datepicker component.
3+
| name | type | default value | description |
4+
| ---------------------------- | ------------------------------ | ------------------ | ----------- |
5+
| `adjustDateOnChange` | `bool` | | |
6+
| `allowSameDay` | `bool` | `false` | |
7+
| `autoComplete` | `string` | | |
8+
| `autoFocus` | `bool` | | |
9+
| `calendarClassName` | `string` | | |
10+
| `calendarContainer` | `func` | | |
11+
| `children` | `node` | | |
12+
| `className` | `string` | | |
13+
| `clearButtonTitle` | `string` | | |
14+
| `customInput` | `element` | | |
15+
| `customInputRef` | `string` | | |
16+
| `dateFormat` | `union(string\|array)` | `"L"` | |
17+
| `dateFormatCalendar` | `string` | `"MMMM YYYY"` | |
18+
| `dayClassName` | `func` | | |
19+
| `disabled` | `bool` | `false` | |
20+
| `disabledKeyboardNavigation` | `bool` | `false` | |
21+
| `dropdownMode` | `enum("scroll"\|"select")` | `"scroll"` | |
22+
| `endDate` | `object` | | |
23+
| `excludeDates` | `array` | | |
24+
| `excludeTimes` | `array` | | |
25+
| `filterDate` | `func` | | |
26+
| `fixedHeight` | `bool` | | |
27+
| `forceShowMonthNavigation` | `bool` | | |
28+
| `formatWeekDay` | `func` | | |
29+
| `formatWeekNumber` | `func` | | |
30+
| `highlightDates` | `array` | | |
31+
| `id` | `string` | | |
32+
| `includeDates` | `array` | | |
33+
| `includeTimes` | `array` | | |
34+
| `injectTimes` | `array` | | |
35+
| `inline` | `bool` | | |
36+
| `isClearable` | `bool` | | |
37+
| `locale` | `string` | | |
38+
| `maxDate` | `object` | | |
39+
| `maxTime` | `object` | | |
40+
| `minDate` | `object` | | |
41+
| `minTime` | `object` | | |
42+
| `monthsShown` | `number` | `1` | |
43+
| `name` | `string` | | |
44+
| `nextMonthButtonLabel` | `string` | `"Next month"` | |
45+
| `onBlur` | `func` | `function() {}` | |
46+
| `onChange` | `func` | `function() {}` | |
47+
| `onChangeRaw` | `func` | | |
48+
| `onClickOutside` | `func` | `function() {}` | |
49+
| `onFocus` | `func` | `function() {}` | |
50+
| `onInputClick` | `func` | `function() {}` | |
51+
| `onInputError` | `func` | `function() {}` | |
52+
| `onKeyDown` | `func` | `function() {}` | |
53+
| `onMonthChange` | `func` | `function() {}` | |
54+
| `onSelect` | `func` | `function() {}` | |
55+
| `onWeekSelect` | `func` | | |
56+
| `onYearChange` | `func` | `function() {}` | |
57+
| `open` | `bool` | | |
58+
| `openToDate` | `object` | | |
59+
| `peekNextMonth` | `bool` | | |
60+
| `placeholderText` | `string` | | |
61+
| `popperClassName` | `string` | | |
62+
| `popperContainer` | `func` | | |
63+
| `popperModifiers` | `object` | | |
64+
| `popperPlacement` | `enumpopperPlacementPositions` | | |
65+
| `popperProps` | `object` | | |
66+
| `preventOpenOnFocus` | `bool` | `false` | |
67+
| `previousMonthButtonLabel` | `string` | `"Previous Month"` | |
68+
| `readOnly` | `bool` | `false` | |
69+
| `renderCustomHeader` | `func` | | |
70+
| `renderDayContents` | `func` | `function(date) { |
471

5-
| name | type | default value | description |
6-
| ----------------------------- | ------------------------------ | ------------------ | ----------- |
7-
| `adjustDateOnChange` | `bool` | | |
8-
| `allowSameDay` | `bool` | `false` | |
9-
| `autoComplete` | `string` | | |
10-
| `autoFocus` | `bool` | | |
11-
| `calendarClassName` | `string` | | |
12-
| `calendarContainer` | `func` | | |
13-
| `children` | `node` | | |
14-
| `className` | `string` | | |
15-
| `clearButtonTitle` | `string` | | |
16-
| `customInput` | `element` | | |
17-
| `customInputRef` | `string` | | |
18-
| `dateFormat` | `union(string\|array)` | `"L"` | |
19-
| `dateFormatCalendar` | `string` | `"MMMM YYYY"` | |
20-
| `dayClassName` | `func` | | |
21-
| `disabled` | `bool` | `false` | |
22-
| `disabledKeyboardNavigation` | `bool` | `false` | |
23-
| `dropdownMode` | `enum("scroll"\|"select")` | `"scroll"` | |
24-
| `endDate` | `object` | | |
25-
| `excludeDates` | `array` | | |
26-
| `excludeTimes` | `array` | | |
27-
| `filterDate` | `func` | | |
28-
| `fixedHeight` | `bool` | | |
29-
| `forceShowMonthNavigation` | `bool` | | |
30-
| `formatWeekDay` | `func` | | |
31-
| `formatWeekNumber` | `func` | | |
32-
| `highlightDates` | `array` | | |
33-
| `id` | `string` | | |
34-
| `includeDates` | `array` | | |
35-
| `includeTimes` | `array` | | |
36-
| `injectTimes` | `array` | | |
37-
| `inline` | `bool` | | |
38-
| `isClearable` | `bool` | | |
39-
| `locale` | `string` | | |
40-
| `maxDate` | `object` | | |
41-
| `maxTime` | `object` | | |
42-
| `minDate` | `object` | | |
43-
| `minTime` | `object` | | |
44-
| `monthsShown` | `number` | `1` | |
45-
| `name` | `string` | | |
46-
| `nextMonthButtonLabel` | `string` | `"Next month"` | |
47-
| `onBlur` | `func` | `function() {}` | |
48-
| `onChange` | `func` | `function() {}` | |
49-
| `onChangeRaw` | `func` | | |
50-
| `onClickOutside` | `func` | `function() {}` | |
51-
| `onFocus` | `func` | `function() {}` | |
52-
| `onInputClick` | `func` | `function() {}` | |
53-
| `onKeyDown` | `func` | `function() {}` | |
54-
| `onMonthChange` | `func` | `function() {}` | |
55-
| `onSelect` | `func` | `function() {}` | |
56-
| `onWeekSelect` | `func` | | |
57-
| `onYearChange` | `func` | `function() {}` | |
58-
| `open` | `bool` | | |
59-
| `openToDate` | `object` | | |
60-
| `peekNextMonth` | `bool` | | |
61-
| `placeholderText` | `string` | | |
62-
| `popperClassName` | `string` | | |
63-
| `popperContainer` | `func` | | |
64-
| `popperModifiers` | `object` | | |
65-
| `popperPlacement` | `enumpopperPlacementPositions` | | |
66-
| `preventOpenOnFocus` | `bool` | `false` | |
67-
| `previousMonthButtonLabel` | `string` | `"Previous Month"` | |
68-
| `readOnly` | `bool` | `false` | |
69-
| `renderCustomHeader` | `func` | | |
70-
| `required` | `bool` | | |
71-
| `scrollableMonthYearDropdown` | `bool` | | |
72-
| `scrollableYearDropdown` | `bool` | | |
73-
| `selected` | `object` | | |
74-
| `selectsEnd` | `bool` | | |
75-
| `selectsStart` | `bool` | | |
76-
| `shouldCloseOnSelect` | `bool` | `true` | |
77-
| `showDisabledMonthNavigation` | `bool` | | |
78-
| `showMonthDropdown` | `bool` | | |
79-
| `showMonthYearDropdown` | `bool` | | |
80-
| `showTimeSelect` | `bool` | `false` | |
81-
| `showTimeSelectOnly` | `bool` | | |
82-
| `showWeekNumbers` | `bool` | | |
83-
| `showYearDropdown` | `bool` | | |
84-
| `startDate` | `object` | | |
85-
| `startOpen` | `bool` | | |
86-
| `tabIndex` | `number` | | |
87-
| `timeCaption` | `string` | `"Time"` | |
88-
| `timeFormat` | `string` | | |
89-
| `timeIntervals` | `number` | `30` | |
90-
| `title` | `string` | | |
91-
| `todayButton` | `node` | | |
92-
| `useShortMonthInDropdown` | `bool` | | |
93-
| `useWeekdaysShort` | `bool` | | |
94-
| `utcOffset` | `union(number\|string)` | | |
95-
| `value` | `string` | | |
96-
| `weekLabel` | `string` | | |
97-
| `withPortal` | `bool` | `false` | |
98-
| `yearDropdownItemNumber` | `number` | | |
72+
return date;
73+
}`|| |`required`|`bool`||| |`scrollableMonthYearDropdown`|`bool`||| |`scrollableYearDropdown`|`bool`||| |`selected`|`object`||| |`selectsEnd`|`bool`||| |`selectsStart`|`bool`||| |`shouldCloseOnSelect`|`bool`|`true`|| |`showDisabledMonthNavigation`|`bool`||| |`showMonthDropdown`|`bool`||| |`showMonthYearDropdown`|`bool`||| |`showTimeSelect`|`bool`|`false`|| |`showTimeSelectOnly`|`bool`||| |`showWeekNumbers`|`bool`||| |`showYearDropdown`|`bool`||| |`startDate`|`object`||| |`startOpen`|`bool`||| |`tabIndex`|`number`||| |`timeCaption`|`string`|`"Time"`|| |`timeFormat`|`string`||| |`timeIntervals`|`number`|`30`|| |`title`|`string`||| |`todayButton`|`node`||| |`useShortMonthInDropdown`|`bool`||| |`useWeekdaysShort`|`bool`||| |`utcOffset`|`union(number\|string)`||| |`value`|`string`||| |`weekLabel`|`string`||| |`withPortal`|`bool`|`false`|| |`yearDropdownItemNumber`|`number`|||

‎docs/popper_component.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ enabled: true,
1313
escapeWithReference: true,
1414
boundariesElement: "viewport"
1515
}
16-
}`|| |`popperPlacement`|`enum("bottom"\|"bottom-end"\|"bottom-start"\|"left"\|"left-end"\|"left-start"\|"right"\|"right-end"\|"right-start"\|"top"\|"top-end"\|"top-start")`|`"bottom-start"`|| |`targetComponent`|`element`|||
16+
}`|| |`popperPlacement`|`enum("bottom"\|"bottom-end"\|"bottom-start"\|"left"\|"left-end"\|"left-start"\|"right"\|"right-end"\|"right-start"\|"top"\|"top-end"\|"top-start")`|`"bottom-start"`|| |`popperProps`|`object`|`{}`|| |`targetComponent`|`element`|||

0 commit comments

Comments
 (0)