Skip to content

Commit

Permalink
Publish new API docs (automated commit)
Browse files Browse the repository at this point in the history
  • Loading branch information
martijnrusschen committed Jan 5, 2025
1 parent 2c271f1 commit 66ab790
Show file tree
Hide file tree
Showing 14 changed files with 250 additions and 226 deletions.
13 changes: 7 additions & 6 deletions docs/calendar_container.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# `calendar_container` (component)
`calendar_container` (component)
================================

| name | type | default value | description |
| -------------------- | ---- | ------------- | ----------- |
| `className` | | | |
| `showTime` | | `false` | |
| `showTimeSelectOnly` | | `false` | |

| name | type | default value | description |
|---|---|---|---|
|`showTime`||`false`||
|`showTimeSelectOnly`||`false`||
21 changes: 11 additions & 10 deletions docs/calendar_icon.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# `calendar_icon` (component)
`calendar_icon` (component)
===========================

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

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

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

@returns The `CalendarIcon` component.
@returns The `CalendarIcon` component.

| name | type | default value | description |
| ----------- | ---- | ------------- | ----------- |
| `className` | | `""` | |
| `icon` | | | |
| `onClick` | | | |
| name | type | default value | description |
|---|---|---|---|
|`className`||`""`||
|`icon`||||
|`onClick`||||
20 changes: 11 additions & 9 deletions docs/click_outside_wrapper.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# `click_outside_wrapper` (component)
`click_outside_wrapper` (component)
===================================

| name | type | default value | description |
| --------------------------- | ---- | ------------- | ----------- |
| `children` (required) | | | |
| `className` | | | |
| `containerRef` | | | |
| `ignoreClass` | | | |
| `onClickOutside` (required) | | | |
| `style` | | | |

| name | type | default value | description |
|---|---|---|---|
|`children` (required)||||
|`className`||||
|`containerRef`||||
|`ignoreClass`||||
|`onClickOutside` (required)||||
|`style`||||
187 changes: 95 additions & 92 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,96 @@
# `index` (component)
`index` (component)
===================

| name | type | default value | description |
| ------------------------------- | ---- | ------------------ | ----------- |
| `allowSameDay` | | `false` | |
| `ariaDescribedBy` | | | |
| `ariaInvalid` | | | |
| `ariaLabelClose` | | | |
| `ariaLabelledBy` | | | |
| `ariaRequired` | | | |
| `autoComplete` | | | |
| `autoFocus` | | | |
| `calendarClassName` | | | |
| `calendarContainer` | | | |
| `calendarIconClassName` | | | |
| `calendarIconClassname` | | | |
| `calendarStartDay` | | `undefined` | |
| `className` | | | |
| `clearButtonClassName` | | | |
| `clearButtonTitle` | | | |
| `closeOnScroll` | | | |
| `customInput` | | | |
| `customInputRef` | | | |
| `customTimeInput` | | `null` | |
| `dateFormat` | | `"MM/dd/yyyy"` | |
| `dateFormatCalendar` | | `"LLLL yyyy"` | |
| `disabled` | | `false` | |
| `disabledKeyboardNavigation` | | `false` | |
| `dropdownMode` | | `"scroll"` | |
| `enableTabLoop` | | `true` | |
| `excludeScrollbar` | | `true` | |
| `focusSelectedMonth` | | `false` | |
| `form` | | | |
| `highlightDates` | | | |
| `holidays` | | | |
| `id` | | | |
| `isClearable` | | | |
| `monthsShown` | | `1` | |
| `name` | | | |
| `nextMonthAriaLabel` | | `"Next Month"` | |
| `nextMonthButtonLabel` | | `"Next Month"` | |
| `nextYearAriaLabel` | | `"Next Year"` | |
| `nextYearButtonLabel` | | `"Next Year"` | |
| `onBlur` | | | |
| `onCalendarClose` | | | |
| `onCalendarOpen` | | | |
| `onChangeRaw` | | | |
| `onClickOutside` | | | |
| `onFocus` | | | |
| `onInputClick` | | | |
| `onInputError` | | | |
| `onKeyDown` | | | |
| `onSelect` | | | |
| `open` | | | |
| `placeholderText` | | | |
| `popperClassName` | | | |
| `preventOpenOnFocus` | | `false` | |
| `previousMonthAriaLabel` | | `"Previous Month"` | |
| `previousMonthButtonLabel` | | `"Previous Month"` | |
| `previousYearAriaLabel` | | `"Previous Year"` | |
| `previousYearButtonLabel` | | `"Previous Year"` | |
| `readOnly` | | `false` | |
| `required` | | | |
| `selected` | | | |
| `selectsDisabledDaysInRange` | | `false` | |
| `shouldCloseOnSelect` | | `true` | |
| `showDateSelect` | | | |
| `showFourColumnMonthYearPicker` | | `false` | |
| `showFullMonthYearPicker` | | `false` | |
| `showIcon` | | | |
| `showMonthYearPicker` | | `false` | |
| `showPopperArrow` | | `true` | |
| `showPreviousMonths` | | `false` | |
| `showQuarterYearPicker` | | `false` | |
| `showTimeInput` | | `false` | |
| `showTimeSelect` | | `false` | |
| `showTwoColumnMonthYearPicker` | | `false` | |
| `showWeekPicker` | | `false` | |
| `showYearPicker` | | `false` | |
| `startDate` | | | |
| `startOpen` | | | |
| `strictParsing` | | `false` | |
| `swapRange` | | `false` | |
| `tabIndex` | | | |
| `timeCaption` | | `"Time"` | |
| `timeInputLabel` | | `"Time"` | |
| `timeIntervals` | | `30` | |
| `title` | | | |
| `toggleCalendarOnIconClick` | | `false` | |
| `usePointerEvent` | | `false` | |
| `value` | | | |
| `withPortal` | | `false` | |
| `yearItemNumber` | | `12` | |

| name | type | default value | description |
|---|---|---|---|
|`allowSameDay`||`false`||
|`ariaDescribedBy`||||
|`ariaInvalid`||||
|`ariaLabelClose`||||
|`ariaLabelledBy`||||
|`ariaRequired`||||
|`autoComplete`||||
|`autoFocus`||||
|`calendarClassName`||||
|`calendarContainer`||||
|`calendarIconClassName`||||
|`calendarIconClassname`||||
|`calendarStartDay`||`undefined`||
|`className`||||
|`clearButtonClassName`||||
|`clearButtonTitle`||||
|`closeOnScroll`||||
|`customInput`||||
|`customInputRef`||||
|`customTimeInput`||`null`||
|`dateFormat`||`"MM/dd/yyyy"`||
|`dateFormatCalendar`||`"LLLL yyyy"`||
|`disabled`||`false`||
|`disabledKeyboardNavigation`||`false`||
|`dropdownMode`||`"scroll"`||
|`enableTabLoop`||`true`||
|`endDate`||||
|`excludeScrollbar`||`true`||
|`focusSelectedMonth`||`false`||
|`form`||||
|`highlightDates`||||
|`holidays`||||
|`id`||||
|`isClearable`||||
|`monthsShown`||`1`||
|`name`||||
|`nextMonthAriaLabel`||`"Next Month"`||
|`nextMonthButtonLabel`||`"Next Month"`||
|`nextYearAriaLabel`||`"Next Year"`||
|`nextYearButtonLabel`||`"Next Year"`||
|`onBlur`||||
|`onCalendarClose`||||
|`onCalendarOpen`||||
|`onChangeRaw`||||
|`onClickOutside`||||
|`onFocus`||||
|`onInputClick`||||
|`onInputError`||||
|`onKeyDown`||||
|`onSelect`||||
|`open`||||
|`placeholderText`||||
|`popperClassName`||||
|`preventOpenOnFocus`||`false`||
|`previousMonthAriaLabel`||`"Previous Month"`||
|`previousMonthButtonLabel`||`"Previous Month"`||
|`previousYearAriaLabel`||`"Previous Year"`||
|`previousYearButtonLabel`||`"Previous Year"`||
|`readOnly`||`false`||
|`required`||||
|`selected`||||
|`selectsDisabledDaysInRange`||`false`||
|`shouldCloseOnSelect`||`true`||
|`showDateSelect`||||
|`showFourColumnMonthYearPicker`||`false`||
|`showFullMonthYearPicker`||`false`||
|`showIcon`||||
|`showMonthYearPicker`||`false`||
|`showPopperArrow`||`true`||
|`showPreviousMonths`||`false`||
|`showQuarterYearPicker`||`false`||
|`showTimeInput`||`false`||
|`showTimeSelect`||`false`||
|`showTwoColumnMonthYearPicker`||`false`||
|`showWeekPicker`||`false`||
|`showYearPicker`||`false`||
|`startDate`||||
|`startOpen`||||
|`strictParsing`||`false`||
|`swapRange`||`false`||
|`tabIndex`||||
|`timeCaption`||`"Time"`||
|`timeInputLabel`||`"Time"`||
|`timeIntervals`||`30`||
|`title`||||
|`toggleCalendarOnIconClick`||`false`||
|`usePointerEvent`||`false`||
|`value`||||
|`withPortal`||`false`||
|`yearItemNumber`||`12`||
17 changes: 9 additions & 8 deletions docs/input_time.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# `input_time` (component)
`input_time` (component)
========================

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

Expand All @@ -15,10 +16,10 @@

@returns The `InputTime` component.

| name | type | default value | description |
| ----------------- | ---- | ------------- | ----------- |
| `customTimeInput` | | | |
| `date` | | | |
| `onChange` | | | |
| `timeInputLabel` | | | |
| `timeString` | | | |
| name | type | default value | description |
|---|---|---|---|
|`customTimeInput`||||
|`date`||||
|`onChange`||||
|`timeInputLabel`||||
|`timeString`||||
16 changes: 9 additions & 7 deletions docs/month_dropdown.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# `month_dropdown` (component)
`month_dropdown` (component)
============================

| name | type | default value | description |
| ------------------------- | ---- | ------------- | ----------- |
| `dropdownMode` (required) | | | |
| `locale` | | | |
| `onChange` (required) | | | |
| `useShortMonthInDropdown` | | | |

| name | type | default value | description |
|---|---|---|---|
|`dropdownMode` (required)||||
|`locale`||||
|`onChange` (required)||||
|`useShortMonthInDropdown`||||
16 changes: 9 additions & 7 deletions docs/month_dropdown_options.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# `month_dropdown_options` (component)
`month_dropdown_options` (component)
====================================

| name | type | default value | description |
| ----------------------- | ---- | ------------- | ----------- |
| `month` (required) | | | |
| `monthNames` (required) | | | |
| `onCancel` (required) | | | |
| `onChange` (required) | | | |

| name | type | default value | description |
|---|---|---|---|
|`month` (required)||||
|`monthNames` (required)||||
|`onCancel` (required)||||
|`onChange` (required)||||
14 changes: 8 additions & 6 deletions docs/month_year_dropdown.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# `month_year_dropdown` (component)
`month_year_dropdown` (component)
=================================

| name | type | default value | description |
| ------------------------- | ---- | ------------- | ----------- |
| `dropdownMode` (required) | | | |
| `locale` | | | |
| `onChange` (required) | | | |

| name | type | default value | description |
|---|---|---|---|
|`dropdownMode` (required)||||
|`locale`||||
|`onChange` (required)||||
24 changes: 13 additions & 11 deletions docs/month_year_dropdown_options.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# `month_year_dropdown_options` (component)
`month_year_dropdown_options` (component)
=========================================

| name | type | default value | description |
| ----------------------------- | ---- | ------------- | ----------- |
| `date` (required) | | | |
| `dateFormat` (required) | | | |
| `locale` | | | |
| `maxDate` (required) | | | |
| `minDate` (required) | | | |
| `onCancel` (required) | | | |
| `onChange` (required) | | | |
| `scrollableMonthYearDropdown` | | | |

| name | type | default value | description |
|---|---|---|---|
|`date` (required)||||
|`dateFormat` (required)||||
|`locale`||||
|`maxDate` (required)||||
|`minDate` (required)||||
|`onCancel` (required)||||
|`onChange` (required)||||
|`scrollableMonthYearDropdown`||||
13 changes: 7 additions & 6 deletions docs/portal.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# `portal` (component)
`portal` (component)
====================

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

| name | type | default value | description |
| --------------------- | ---- | ------------- | ----------- |
| `children` (required) | | | |
| `portalHost` | | | |
| `portalId` (required) | | | |
| name | type | default value | description |
|---|---|---|---|
|`children` (required)||||
|`portalHost`||||
|`portalId` (required)||||
Loading

0 comments on commit 66ab790

Please sign in to comment.