Skip to content

Commit 66ab790

Browse files
martijnrusschenmartijnrusschen
committed
Publish new API docs (automated commit)
1 parent 2c271f1 commit 66ab790

14 files changed

+250
-226
lines changed

‎docs/calendar_container.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# `calendar_container` (component)
1+
`calendar_container` (component)
2+
================================
23

3-
| name | type | default value | description |
4-
| -------------------- | ---- | ------------- | ----------- |
5-
| `className` | | | |
6-
| `showTime` | | `false` | |
7-
| `showTimeSelectOnly` | | `false` | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`showTime`||`false`||
8+
|`showTimeSelectOnly`||`false`||

‎docs/calendar_icon.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# `calendar_icon` (component)
1+
`calendar_icon` (component)
2+
===========================
23

34
`CalendarIcon` is a React component that renders an icon for a calendar.
45
The icon can be a string representing a CSS class, a React node, or a default SVG icon.
56

67
@component
7-
@prop icon - The icon to be displayed. This can be a string representing a CSS class or a React node.
8-
@prop className - An optional string representing additional CSS classes to be applied to the icon.
9-
@prop onClick - An optional function to be called when the icon is clicked.
8+
@prop icon - The icon to be displayed. This can be a string representing a CSS class or a React node.
9+
@prop className - An optional string representing additional CSS classes to be applied to the icon.
10+
@prop onClick - An optional function to be called when the icon is clicked.
1011

1112
@example
1213
// To use a CSS class as the icon
@@ -16,10 +17,10 @@ The icon can be a string representing a CSS class, a React node, or a default SV
1617
// To use a React node as the icon
1718
<CalendarIcon icon={<MyIconComponent />} onClick={myClickHandler} />
1819

19-
@returns The `CalendarIcon` component.
20+
@returns The `CalendarIcon` component.
2021

21-
| name | type | default value | description |
22-
| ----------- | ---- | ------------- | ----------- |
23-
| `className` | | `""` | |
24-
| `icon` | | | |
25-
| `onClick` | | | |
22+
| name | type | default value | description |
23+
|---|---|---|---|
24+
|`className`||`""`||
25+
|`icon`||||
26+
|`onClick`||||

‎docs/click_outside_wrapper.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# `click_outside_wrapper` (component)
1+
`click_outside_wrapper` (component)
2+
===================================
23

3-
| name | type | default value | description |
4-
| --------------------------- | ---- | ------------- | ----------- |
5-
| `children` (required) | | | |
6-
| `className` | | | |
7-
| `containerRef` | | | |
8-
| `ignoreClass` | | | |
9-
| `onClickOutside` (required) | | | |
10-
| `style` | | | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`children` (required)||||
8+
|`className`||||
9+
|`containerRef`||||
10+
|`ignoreClass`||||
11+
|`onClickOutside` (required)||||
12+
|`style`||||

‎docs/index.md‎

Lines changed: 95 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,96 @@
1-
# `index` (component)
1+
`index` (component)
2+
===================
23

3-
| name | type | default value | description |
4-
| ------------------------------- | ---- | ------------------ | ----------- |
5-
| `allowSameDay` | | `false` | |
6-
| `ariaDescribedBy` | | | |
7-
| `ariaInvalid` | | | |
8-
| `ariaLabelClose` | | | |
9-
| `ariaLabelledBy` | | | |
10-
| `ariaRequired` | | | |
11-
| `autoComplete` | | | |
12-
| `autoFocus` | | | |
13-
| `calendarClassName` | | | |
14-
| `calendarContainer` | | | |
15-
| `calendarIconClassName` | | | |
16-
| `calendarIconClassname` | | | |
17-
| `calendarStartDay` | | `undefined` | |
18-
| `className` | | | |
19-
| `clearButtonClassName` | | | |
20-
| `clearButtonTitle` | | | |
21-
| `closeOnScroll` | | | |
22-
| `customInput` | | | |
23-
| `customInputRef` | | | |
24-
| `customTimeInput` | | `null` | |
25-
| `dateFormat` | | `"MM/dd/yyyy"` | |
26-
| `dateFormatCalendar` | | `"LLLL yyyy"` | |
27-
| `disabled` | | `false` | |
28-
| `disabledKeyboardNavigation` | | `false` | |
29-
| `dropdownMode` | | `"scroll"` | |
30-
| `enableTabLoop` | | `true` | |
31-
| `excludeScrollbar` | | `true` | |
32-
| `focusSelectedMonth` | | `false` | |
33-
| `form` | | | |
34-
| `highlightDates` | | | |
35-
| `holidays` | | | |
36-
| `id` | | | |
37-
| `isClearable` | | | |
38-
| `monthsShown` | | `1` | |
39-
| `name` | | | |
40-
| `nextMonthAriaLabel` | | `"Next Month"` | |
41-
| `nextMonthButtonLabel` | | `"Next Month"` | |
42-
| `nextYearAriaLabel` | | `"Next Year"` | |
43-
| `nextYearButtonLabel` | | `"Next Year"` | |
44-
| `onBlur` | | | |
45-
| `onCalendarClose` | | | |
46-
| `onCalendarOpen` | | | |
47-
| `onChangeRaw` | | | |
48-
| `onClickOutside` | | | |
49-
| `onFocus` | | | |
50-
| `onInputClick` | | | |
51-
| `onInputError` | | | |
52-
| `onKeyDown` | | | |
53-
| `onSelect` | | | |
54-
| `open` | | | |
55-
| `placeholderText` | | | |
56-
| `popperClassName` | | | |
57-
| `preventOpenOnFocus` | | `false` | |
58-
| `previousMonthAriaLabel` | | `"Previous Month"` | |
59-
| `previousMonthButtonLabel` | | `"Previous Month"` | |
60-
| `previousYearAriaLabel` | | `"Previous Year"` | |
61-
| `previousYearButtonLabel` | | `"Previous Year"` | |
62-
| `readOnly` | | `false` | |
63-
| `required` | | | |
64-
| `selected` | | | |
65-
| `selectsDisabledDaysInRange` | | `false` | |
66-
| `shouldCloseOnSelect` | | `true` | |
67-
| `showDateSelect` | | | |
68-
| `showFourColumnMonthYearPicker` | | `false` | |
69-
| `showFullMonthYearPicker` | | `false` | |
70-
| `showIcon` | | | |
71-
| `showMonthYearPicker` | | `false` | |
72-
| `showPopperArrow` | | `true` | |
73-
| `showPreviousMonths` | | `false` | |
74-
| `showQuarterYearPicker` | | `false` | |
75-
| `showTimeInput` | | `false` | |
76-
| `showTimeSelect` | | `false` | |
77-
| `showTwoColumnMonthYearPicker` | | `false` | |
78-
| `showWeekPicker` | | `false` | |
79-
| `showYearPicker` | | `false` | |
80-
| `startDate` | | | |
81-
| `startOpen` | | | |
82-
| `strictParsing` | | `false` | |
83-
| `swapRange` | | `false` | |
84-
| `tabIndex` | | | |
85-
| `timeCaption` | | `"Time"` | |
86-
| `timeInputLabel` | | `"Time"` | |
87-
| `timeIntervals` | | `30` | |
88-
| `title` | | | |
89-
| `toggleCalendarOnIconClick` | | `false` | |
90-
| `usePointerEvent` | | `false` | |
91-
| `value` | | | |
92-
| `withPortal` | | `false` | |
93-
| `yearItemNumber` | | `12` | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`allowSameDay`||`false`||
8+
|`ariaDescribedBy`||||
9+
|`ariaInvalid`||||
10+
|`ariaLabelClose`||||
11+
|`ariaLabelledBy`||||
12+
|`ariaRequired`||||
13+
|`autoComplete`||||
14+
|`autoFocus`||||
15+
|`calendarClassName`||||
16+
|`calendarContainer`||||
17+
|`calendarIconClassName`||||
18+
|`calendarIconClassname`||||
19+
|`calendarStartDay`||`undefined`||
20+
|`className`||||
21+
|`clearButtonClassName`||||
22+
|`clearButtonTitle`||||
23+
|`closeOnScroll`||||
24+
|`customInput`||||
25+
|`customInputRef`||||
26+
|`customTimeInput`||`null`||
27+
|`dateFormat`||`"MM/dd/yyyy"`||
28+
|`dateFormatCalendar`||`"LLLL yyyy"`||
29+
|`disabled`||`false`||
30+
|`disabledKeyboardNavigation`||`false`||
31+
|`dropdownMode`||`"scroll"`||
32+
|`enableTabLoop`||`true`||
33+
|`endDate`||||
34+
|`excludeScrollbar`||`true`||
35+
|`focusSelectedMonth`||`false`||
36+
|`form`||||
37+
|`highlightDates`||||
38+
|`holidays`||||
39+
|`id`||||
40+
|`isClearable`||||
41+
|`monthsShown`||`1`||
42+
|`name`||||
43+
|`nextMonthAriaLabel`||`"Next Month"`||
44+
|`nextMonthButtonLabel`||`"Next Month"`||
45+
|`nextYearAriaLabel`||`"Next Year"`||
46+
|`nextYearButtonLabel`||`"Next Year"`||
47+
|`onBlur`||||
48+
|`onCalendarClose`||||
49+
|`onCalendarOpen`||||
50+
|`onChangeRaw`||||
51+
|`onClickOutside`||||
52+
|`onFocus`||||
53+
|`onInputClick`||||
54+
|`onInputError`||||
55+
|`onKeyDown`||||
56+
|`onSelect`||||
57+
|`open`||||
58+
|`placeholderText`||||
59+
|`popperClassName`||||
60+
|`preventOpenOnFocus`||`false`||
61+
|`previousMonthAriaLabel`||`"Previous Month"`||
62+
|`previousMonthButtonLabel`||`"Previous Month"`||
63+
|`previousYearAriaLabel`||`"Previous Year"`||
64+
|`previousYearButtonLabel`||`"Previous Year"`||
65+
|`readOnly`||`false`||
66+
|`required`||||
67+
|`selected`||||
68+
|`selectsDisabledDaysInRange`||`false`||
69+
|`shouldCloseOnSelect`||`true`||
70+
|`showDateSelect`||||
71+
|`showFourColumnMonthYearPicker`||`false`||
72+
|`showFullMonthYearPicker`||`false`||
73+
|`showIcon`||||
74+
|`showMonthYearPicker`||`false`||
75+
|`showPopperArrow`||`true`||
76+
|`showPreviousMonths`||`false`||
77+
|`showQuarterYearPicker`||`false`||
78+
|`showTimeInput`||`false`||
79+
|`showTimeSelect`||`false`||
80+
|`showTwoColumnMonthYearPicker`||`false`||
81+
|`showWeekPicker`||`false`||
82+
|`showYearPicker`||`false`||
83+
|`startDate`||||
84+
|`startOpen`||||
85+
|`strictParsing`||`false`||
86+
|`swapRange`||`false`||
87+
|`tabIndex`||||
88+
|`timeCaption`||`"Time"`||
89+
|`timeInputLabel`||`"Time"`||
90+
|`timeIntervals`||`30`||
91+
|`title`||||
92+
|`toggleCalendarOnIconClick`||`false`||
93+
|`usePointerEvent`||`false`||
94+
|`value`||||
95+
|`withPortal`||`false`||
96+
|`yearItemNumber`||`12`||

‎docs/input_time.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# `input_time` (component)
1+
`input_time` (component)
2+
========================
23

34
`InputTime` is a React component that manages time input.
45

@@ -15,10 +16,10 @@
1516

1617
@returns The `InputTime` component.
1718

18-
| name | type | default value | description |
19-
| ----------------- | ---- | ------------- | ----------- |
20-
| `customTimeInput` | | | |
21-
| `date` | | | |
22-
| `onChange` | | | |
23-
| `timeInputLabel` | | | |
24-
| `timeString` | | | |
19+
| name | type | default value | description |
20+
|---|---|---|---|
21+
|`customTimeInput`||||
22+
|`date`||||
23+
|`onChange`||||
24+
|`timeInputLabel`||||
25+
|`timeString`||||

‎docs/month_dropdown.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# `month_dropdown` (component)
1+
`month_dropdown` (component)
2+
============================
23

3-
| name | type | default value | description |
4-
| ------------------------- | ---- | ------------- | ----------- |
5-
| `dropdownMode` (required) | | | |
6-
| `locale` | | | |
7-
| `onChange` (required) | | | |
8-
| `useShortMonthInDropdown` | | | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`dropdownMode` (required)||||
8+
|`locale`||||
9+
|`onChange` (required)||||
10+
|`useShortMonthInDropdown`||||

‎docs/month_dropdown_options.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# `month_dropdown_options` (component)
1+
`month_dropdown_options` (component)
2+
====================================
23

3-
| name | type | default value | description |
4-
| ----------------------- | ---- | ------------- | ----------- |
5-
| `month` (required) | | | |
6-
| `monthNames` (required) | | | |
7-
| `onCancel` (required) | | | |
8-
| `onChange` (required) | | | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`month` (required)||||
8+
|`monthNames` (required)||||
9+
|`onCancel` (required)||||
10+
|`onChange` (required)||||

‎docs/month_year_dropdown.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# `month_year_dropdown` (component)
1+
`month_year_dropdown` (component)
2+
=================================
23

3-
| name | type | default value | description |
4-
| ------------------------- | ---- | ------------- | ----------- |
5-
| `dropdownMode` (required) | | | |
6-
| `locale` | | | |
7-
| `onChange` (required) | | | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`dropdownMode` (required)||||
8+
|`locale`||||
9+
|`onChange` (required)||||

‎docs/month_year_dropdown_options.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# `month_year_dropdown_options` (component)
1+
`month_year_dropdown_options` (component)
2+
=========================================
23

3-
| name | type | default value | description |
4-
| ----------------------------- | ---- | ------------- | ----------- |
5-
| `date` (required) | | | |
6-
| `dateFormat` (required) | | | |
7-
| `locale` | | | |
8-
| `maxDate` (required) | | | |
9-
| `minDate` (required) | | | |
10-
| `onCancel` (required) | | | |
11-
| `onChange` (required) | | | |
12-
| `scrollableMonthYearDropdown` | | | |
4+
5+
| name | type | default value | description |
6+
|---|---|---|---|
7+
|`date` (required)||||
8+
|`dateFormat` (required)||||
9+
|`locale`||||
10+
|`maxDate` (required)||||
11+
|`minDate` (required)||||
12+
|`onCancel` (required)||||
13+
|`onChange` (required)||||
14+
|`scrollableMonthYearDropdown`||||

‎docs/portal.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# `portal` (component)
1+
`portal` (component)
2+
====================
23

34
`Portal` is a React component that allows you to render children into a DOM node
45
that exists outside the DOM hierarchy of the parent component.
@@ -9,8 +10,8 @@ that exists outside the DOM hierarchy of the parent component.
910
@property {string} props.portalId - The id of the DOM node into which the `Portal` will render.
1011
@property {ShadowRoot} [props.portalHost] - The DOM node to host the `Portal`.
1112

12-
| name | type | default value | description |
13-
| --------------------- | ---- | ------------- | ----------- |
14-
| `children` (required) | | | |
15-
| `portalHost` | | | |
16-
| `portalId` (required) | | | |
13+
| name | type | default value | description |
14+
|---|---|---|---|
15+
|`children` (required)||||
16+
|`portalHost`||||
17+
|`portalId` (required)||||

0 commit comments

Comments
 (0)