Skip to content

Commit 2f4cdfb

Browse files
martijnrusschenmartijnrusschen
committed
Publish new API docs (automated commit)
1 parent abea7ea commit 2f4cdfb

14 files changed

+283
-296
lines changed

‎docs/calendar_container.md‎

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

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

‎docs/calendar_icon.md‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
# `calendar_icon` (component)
22

3-
| name | type | default value | description |
4-
| ----------- | --------------------- | ------------- | ----------- |
5-
| `className` | `string` | `""` | |
6-
| `icon` | `union(string\|node)` | | |
7-
| `onClick` | `func` | | |
3+
`CalendarIcon` is a React component that renders an icon for a calendar.
4+
The icon can be a string representing a CSS class, a React node, or a default SVG icon.
5+
6+
@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.
10+
11+
@example
12+
// To use a CSS class as the icon
13+
<CalendarIcon icon="my-icon-class" onClick={myClickHandler} />
14+
15+
@example
16+
// To use a React node as the icon
17+
<CalendarIcon icon={<MyIconComponent />} onClick={myClickHandler} />
18+
19+
@returns The `CalendarIcon` component.
20+
21+
| name | type | default value | description |
22+
| ----------- | ---- | ------------- | ----------- |
23+
| `className` | | `""` | |
24+
| `icon` | | | |
25+
| `onClick` | | | |

‎docs/index.md‎

Lines changed: 91 additions & 164 deletions
Large diffs are not rendered by default.

‎docs/input_time.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# `input_time` (component)
2+
3+
`InputTime` is a React component that manages time input.
4+
5+
@component
6+
@example
7+
<InputTime timeString="12:00" />
8+
9+
@param props - The properties that define the `InputTime` component.
10+
@param props.onChange - Function that is called when the date changes.
11+
@param props.date - The initial date value.
12+
@param props.timeString - The initial time string value.
13+
@param props.timeInputLabel - The label for the time input.
14+
@param props.customTimeInput - An optional custom time input element.
15+
16+
@returns The `InputTime` component.
17+
18+
| name | type | default value | description |
19+
| ----------------- | ---- | ------------- | ----------- |
20+
| `customTimeInput` | | | |
21+
| `date` | | | |
22+
| `onChange` | | | |
23+
| `timeInputLabel` | | | |
24+
| `timeString` | | | |

‎docs/month_dropdown.md‎

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

4-
5-
| name | type | default value | description |
6-
|---|---|---|---|
7-
|`dropdownMode` (required)|`enum("scroll"\|"select")`|||
8-
|`locale`|`string`|||
9-
|`month` (required)|`number`|||
10-
|`onChange` (required)|`func`|||
11-
|`useShortMonthInDropdown`|`bool`|||
3+
| name | type | default value | description |
4+
| ------------------------- | ---- | ------------- | ----------- |
5+
| `dropdownMode` (required) | | | |
6+
| `locale` | | | |
7+
| `onChange` (required) | | | |
8+
| `useShortMonthInDropdown` | | | |

‎docs/month_dropdown_options.md‎

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

4-
5-
| name | type | default value | description |
6-
|---|---|---|---|
7-
|`month` (required)|`number`|||
8-
|`monthNames` (required)|`arrayOf[object Object]`|||
9-
|`onCancel` (required)|`func`|||
10-
|`onChange` (required)|`func`|||
3+
| name | type | default value | description |
4+
| ----------------------- | ---- | ------------- | ----------- |
5+
| `month` (required) | | | |
6+
| `monthNames` (required) | | | |
7+
| `onCancel` (required) | | | |
8+
| `onChange` (required) | | | |

‎docs/month_year_dropdown.md‎

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

4-
5-
| name | type | default value | description |
6-
|---|---|---|---|
7-
|`date` (required)|`instanceOfDate`|||
8-
|`dateFormat` (required)|`string`|||
9-
|`dropdownMode` (required)|`enum("scroll"\|"select")`|||
10-
|`locale`|`string`|||
11-
|`maxDate` (required)|`instanceOfDate`|||
12-
|`minDate` (required)|`instanceOfDate`|||
13-
|`onChange` (required)|`func`|||
14-
|`scrollableMonthYearDropdown`|`bool`|||
3+
| name | type | default value | description |
4+
| ------------------------- | ---- | ------------- | ----------- |
5+
| `dropdownMode` (required) | | | |
6+
| `locale` | | | |
7+
| `onChange` (required) | | | |

‎docs/month_year_dropdown_options.md‎

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

4-
5-
| name | type | default value | description |
6-
|---|---|---|---|
7-
|`date` (required)|`instanceOfDate`|||
8-
|`dateFormat` (required)|`string`|||
9-
|`locale`|`string`|||
10-
|`maxDate` (required)|`instanceOfDate`|||
11-
|`minDate` (required)|`instanceOfDate`|||
12-
|`onCancel` (required)|`func`|||
13-
|`onChange` (required)|`func`|||
14-
|`scrollableMonthYearDropdown`|`bool`|||
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` | | | |

‎docs/portal.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `portal` (component)
22

3-
| name | type | default value | description |
4-
| ------------ | ---------------------- | ------------- | ----------- |
5-
| `children` | `any` | | |
6-
| `portalHost` | `instanceOfShadowRoot` | | |
7-
| `portalId` | `string` | | |
3+
`Portal` is a React component that allows you to render children into a DOM node
4+
that exists outside the DOM hierarchy of the parent component.
5+
6+
@class
7+
@param {PortalProps} props - The properties that define the `Portal` component.
8+
@property {React.ReactNode} props.children - The children to be rendered into the `Portal`.
9+
@property {string} props.portalId - The id of the DOM node into which the `Portal` will render.
10+
@property {ShadowRoot} [props.portalHost] - The DOM node to host the `Portal`.
11+
12+
| name | type | default value | description |
13+
| --------------------- | ---- | ------------- | ----------- |
14+
| `children` (required) | | | |
15+
| `portalHost` | | | |
16+
| `portalId` (required) | | | |

‎docs/tab_loop.md‎

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

3+
`TabLoop` is a React component that manages tabbing behavior for its children.
44

5-
| name | type | default value | description |
6-
|---|---|---|---|
7-
|`children`|`any`|||
8-
|`enableTabLoop`|`bool`|`true`||
5+
TabLoop prevents the user from tabbing outside of the popper
6+
It creates a tabindex loop so that "Tab" on the last element will focus the first element
7+
and "Shift Tab" on the first element will focus the last element
8+
9+
@component
10+
@example
11+
<TabLoop enableTabLoop={true}>
12+
<ChildComponent />
13+
</TabLoop>
14+
15+
@param props - The properties that define the `TabLoop` component.
16+
@param props.children - The child components.
17+
@param props.enableTabLoop - Whether to enable the tab loop.
18+
19+
@returns The `TabLoop` component.
20+
21+
| name | type | default value | description |
22+
| --------------- | ---- | ------------- | ----------- |
23+
| `enableTabLoop` | | `true` | |

0 commit comments

Comments
 (0)