From f2f6552cdbfc1a92cf99b2e9e57fc9ba98d742fd Mon Sep 17 00:00:00 2001 From: Martijn Russchen Date: Sat, 17 Nov 2018 13:58:53 +0100 Subject: [PATCH] Publish new API docs (automated commit) --- docs/index.md | 165 ++++++++++++---------------- docs/month_dropdown.md | 1 - docs/month_year_dropdown.md | 6 +- docs/month_year_dropdown_options.md | 18 +-- docs/time.md | 30 ++--- 5 files changed, 97 insertions(+), 123 deletions(-) diff --git a/docs/index.md b/docs/index.md index 0c5100986..fd929e635 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,98 +1,73 @@ # `index` (component) -General datepicker component. +| name | type | default value | description | +| ---------------------------- | ------------------------------ | ------------------ | ----------- | +| `adjustDateOnChange` | `bool` | | | +| `allowSameDay` | `bool` | `false` | | +| `autoComplete` | `string` | | | +| `autoFocus` | `bool` | | | +| `calendarClassName` | `string` | | | +| `calendarContainer` | `func` | | | +| `children` | `node` | | | +| `className` | `string` | | | +| `clearButtonTitle` | `string` | | | +| `customInput` | `element` | | | +| `customInputRef` | `string` | | | +| `dateFormat` | `union(string\|array)` | `'MM/dd/yyyy'` | | +| `dateFormatCalendar` | `string` | `'LLLL yyyy'` | | +| `dayClassName` | `func` | | | +| `disabled` | `bool` | `false` | | +| `disabledKeyboardNavigation` | `bool` | `false` | | +| `dropdownMode` | `enum('scroll'\|'select')` | `'scroll'` | | +| `endDate` | `instanceOfDate` | | | +| `excludeDates` | `array` | | | +| `excludeTimes` | `array` | | | +| `filterDate` | `func` | | | +| `fixedHeight` | `bool` | | | +| `forceShowMonthNavigation` | `bool` | | | +| `formatWeekDay` | `func` | | | +| `formatWeekNumber` | `func` | | | +| `highlightDates` | `array` | | | +| `id` | `string` | | | +| `includeDates` | `array` | | | +| `includeTimes` | `array` | | | +| `injectTimes` | `array` | | | +| `inline` | `bool` | | | +| `isClearable` | `bool` | | | +| `locale` | `string` | | | +| `maxDate` | `instanceOfDate` | | | +| `maxTime` | `instanceOfDate` | | | +| `minDate` | `instanceOfDate` | | | +| `minTime` | `instanceOfDate` | | | +| `monthsShown` | `number` | `1` | | +| `name` | `string` | | | +| `nextMonthButtonLabel` | `string` | `'Next month'` | | +| `onBlur` | `func` | `function() {}` | | +| `onChange` | `func` | `function() {}` | | +| `onChangeRaw` | `func` | | | +| `onClickOutside` | `func` | `function() {}` | | +| `onFocus` | `func` | `function() {}` | | +| `onInputClick` | `func` | `function() {}` | | +| `onInputError` | `func` | `function() {}` | | +| `onKeyDown` | `func` | `function() {}` | | +| `onMonthChange` | `func` | `function() {}` | | +| `onSelect` | `func` | `function() {}` | | +| `onWeekSelect` | `func` | | | +| `onYearChange` | `func` | `function() {}` | | +| `open` | `bool` | | | +| `openToDate` | `instanceOfDate` | | | +| `peekNextMonth` | `bool` | | | +| `placeholderText` | `string` | | | +| `popperClassName` | `string` | | | +| `popperContainer` | `func` | | | +| `popperModifiers` | `object` | | | +| `popperPlacement` | `enumpopperPlacementPositions` | | | +| `popperProps` | `object` | | | +| `preventOpenOnFocus` | `bool` | `false` | | +| `previousMonthButtonLabel` | `string` | `'Previous Month'` | | +| `readOnly` | `bool` | `false` | | +| `renderCustomHeader` | `func` | | | +| `renderDayContents` | `func` | `function(date) { | -| name | type | default value | description | -| ----------------------------- | ------------------------------ | ------------------ | ----------- | -| `adjustDateOnChange` | `bool` | | | -| `allowSameDay` | `bool` | `false` | | -| `autoComplete` | `string` | | | -| `autoFocus` | `bool` | | | -| `calendarClassName` | `string` | | | -| `calendarContainer` | `func` | | | -| `children` | `node` | | | -| `className` | `string` | | | -| `clearButtonTitle` | `string` | | | -| `customInput` | `element` | | | -| `customInputRef` | `string` | | | -| `dateFormat` | `union(string\|array)` | `"L"` | | -| `dateFormatCalendar` | `string` | `"MMMM YYYY"` | | -| `dayClassName` | `func` | | | -| `disabled` | `bool` | `false` | | -| `disabledKeyboardNavigation` | `bool` | `false` | | -| `dropdownMode` | `enum("scroll"\|"select")` | `"scroll"` | | -| `endDate` | `instanceOf(Date)` | | | -| `excludeDates` | `array` | | | -| `excludeTimes` | `array` | | | -| `filterDate` | `func` | | | -| `fixedHeight` | `bool` | | | -| `forceShowMonthNavigation` | `bool` | | | -| `formatWeekDay` | `func` | | | -| `formatWeekNumber` | `func` | | | -| `highlightDates` | `array` | | | -| `id` | `string` | | | -| `includeDates` | `array` | | | -| `includeTimes` | `array` | | | -| `injectTimes` | `array` | | | -| `inline` | `bool` | | | -| `isClearable` | `bool` | | | -| `locale` | `string` | | | -| `maxDate` | `instanceOf(Date)` | | | -| `maxTime` | `instanceOf(Date)` | | | -| `minDate` | `instanceOf(Date)` | | | -| `minTime` | `instanceOf(Date)` | | | -| `monthsShown` | `number` | `1` | | -| `name` | `string` | | | -| `nextMonthButtonLabel` | `string` | `"Next month"` | | -| `onBlur` | `func` | `function() {}` | | -| `onChange` | `func` | `function() {}` | | -| `onChangeRaw` | `func` | | | -| `onClickOutside` | `func` | `function() {}` | | -| `onFocus` | `func` | `function() {}` | | -| `onInputClick` | `func` | `function() {}` | | -| `onKeyDown` | `func` | `function() {}` | | -| `onMonthChange` | `func` | `function() {}` | | -| `onSelect` | `func` | `function() {}` | | -| `onWeekSelect` | `func` | | | -| `onYearChange` | `func` | `function() {}` | | -| `open` | `bool` | | | -| `openToDate` | `instanceOf(Date)` | | | -| `peekNextMonth` | `bool` | | | -| `placeholderText` | `string` | | | -| `popperClassName` | `string` | | | -| `popperContainer` | `func` | | | -| `popperModifiers` | `object` | | | -| `popperPlacement` | `enumpopperPlacementPositions` | | | -| `preventOpenOnFocus` | `bool` | `false` | | -| `previousMonthButtonLabel` | `string` | `"Previous Month"` | | -| `readOnly` | `bool` | `false` | | -| `renderCustomHeader` | `func` | | | -| `required` | `bool` | | | -| `scrollableMonthYearDropdown` | `bool` | | | -| `scrollableYearDropdown` | `bool` | | | -| `selected` | `instanceOf(Date)` | | | -| `selectsEnd` | `bool` | | | -| `selectsStart` | `bool` | | | -| `shouldCloseOnSelect` | `bool` | `true` | | -| `showDisabledMonthNavigation` | `bool` | | | -| `showMonthDropdown` | `bool` | | | -| `showMonthYearDropdown` | `bool` | | | -| `showTimeSelect` | `bool` | `false` | | -| `showTimeSelectOnly` | `bool` | | | -| `showWeekNumbers` | `bool` | | | -| `showYearDropdown` | `bool` | | | -| `startDate` | `instanceOf(Date)` | | | -| `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` | | | +return date; +}`|| |`required`|`bool`||| |`scrollableMonthYearDropdown`|`bool`||| |`scrollableYearDropdown`|`bool`||| |`selected`|`instanceOfDate`||| |`selectsEnd`|`bool`||| |`selectsStart`|`bool`||| |`shouldCloseOnSelect`|`bool`|`true`|| |`showDisabledMonthNavigation`|`bool`||| |`showMonthDropdown`|`bool`||| |`showMonthYearDropdown`|`bool`||| |`showTimeSelect`|`bool`|`false`|| |`showTimeSelectOnly`|`bool`||| |`showWeekNumbers`|`bool`||| |`showYearDropdown`|`bool`||| |`startDate`|`instanceOfDate`||| |`startOpen`|`bool`||| |`tabIndex`|`number`||| |`timeCaption`|`string`|`'Time'`|| |`timeFormat`|`string`||| |`timeIntervals`|`number`|`30`|| |`title`|`string`||| |`todayButton`|`node`||| |`useShortMonthInDropdown`|`bool`||| |`useWeekdaysShort`|`bool`||| |`value`|`string`||| |`weekLabel`|`string`||| |`withPortal`|`bool`|`false`|| |`yearDropdownItemNumber`|`number`||| diff --git a/docs/month_dropdown.md b/docs/month_dropdown.md index 30bc33daa..f3d4531bf 100644 --- a/docs/month_dropdown.md +++ b/docs/month_dropdown.md @@ -2,7 +2,6 @@ | name | type | default value | description | | ------------------------- | -------------------------- | ------------- | ----------- | -| `dateFormat` (required) | `string` | | | | `dropdownMode` (required) | `enum("scroll"\|"select")` | | | | `locale` | `string` | | | | `month` (required) | `number` | | | diff --git a/docs/month_year_dropdown.md b/docs/month_year_dropdown.md index 305bf49fa..9ff58a0d8 100644 --- a/docs/month_year_dropdown.md +++ b/docs/month_year_dropdown.md @@ -2,11 +2,11 @@ | name | type | default value | description | | ----------------------------- | -------------------------- | ------------- | ----------- | -| `date` (required) | `instanceOf(Date)` | | | +| `date` (required) | `instanceOfDate` | | | | `dateFormat` (required) | `string` | | | | `dropdownMode` (required) | `enum("scroll"\|"select")` | | | | `locale` | `string` | | | -| `maxDate` (required) | `instanceOf(Date)` | | | -| `minDate` (required) | `instanceOf(Date)` | | | +| `maxDate` (required) | `instanceOfDate` | | | +| `minDate` (required) | `instanceOfDate` | | | | `onChange` (required) | `func` | | | | `scrollableMonthYearDropdown` | `bool` | | | diff --git a/docs/month_year_dropdown_options.md b/docs/month_year_dropdown_options.md index 8b1370d9f..8dd91e573 100644 --- a/docs/month_year_dropdown_options.md +++ b/docs/month_year_dropdown_options.md @@ -1,11 +1,11 @@ # `month_year_dropdown_options` (component) -| name | type | default value | description | -| ----------------------------- | ------------------ | ------------- | ----------- | -| `date` (required) | `instanceOf(Date)` | | | -| `dateFormat` (required) | `string` | | | -| `maxDate` (required) | `instanceOf(Date)` | | | -| `minDate` (required) | `instanceOf(Date)` | | | -| `onCancel` (required) | `func` | | | -| `onChange` (required) | `func` | | | -| `scrollableMonthYearDropdown` | `bool` | | | +| name | type | default value | description | +| ----------------------------- | ---------------- | ------------- | ----------- | +| `date` (required) | `instanceOfDate` | | | +| `dateFormat` (required) | `string` | | | +| `maxDate` (required) | `instanceOfDate` | | | +| `minDate` (required) | `instanceOfDate` | | | +| `onCancel` (required) | `func` | | | +| `onChange` (required) | `func` | | | +| `scrollableMonthYearDropdown` | `bool` | | | diff --git a/docs/time.md b/docs/time.md index 2fb850f4b..fb4919f14 100644 --- a/docs/time.md +++ b/docs/time.md @@ -1,17 +1,17 @@ # `time` (component) -| name | type | default value | description | -| -------------- | ------------------ | ------------- | ----------- | -| `excludeTimes` | `array` | | | -| `format` | `string` | | | -| `includeTimes` | `array` | | | -| `injectTimes` | `array` | | | -| `intervals` | `number` | `30` | | -| `maxTime` | `instanceOf(Date)` | | | -| `minTime` | `instanceOf(Date)` | | | -| `monthRef` | `object` | | | -| `onChange` | `func` | | | -| `onTimeChange` | | `() => {}` | | -| `selected` | `instanceOf(Date)` | | | -| `timeCaption` | `string` | `"Time"` | | -| `todayButton` | `node` | `null` | | +| name | type | default value | description | +| -------------- | ---------------- | ------------- | ----------- | +| `excludeTimes` | `array` | | | +| `format` | `string` | | | +| `includeTimes` | `array` | | | +| `injectTimes` | `array` | | | +| `intervals` | `number` | `30` | | +| `maxTime` | `instanceOfDate` | | | +| `minTime` | `instanceOfDate` | | | +| `monthRef` | `object` | | | +| `onChange` | `func` | | | +| `onTimeChange` | | `() => {}` | | +| `selected` | `instanceOfDate` | | | +| `timeCaption` | `string` | `"Time"` | | +| `todayButton` | `node` | `null` | |