From 66ab7905dd12e6ce7f5fa4e74478f5a6c0d69e63 Mon Sep 17 00:00:00 2001 From: Martijn Russchen Date: Sun, 5 Jan 2025 20:22:20 +0100 Subject: [PATCH] Publish new API docs (automated commit) --- docs/calendar_container.md | 13 +- docs/calendar_icon.md | 21 ++-- docs/click_outside_wrapper.md | 20 +-- docs/index.md | 187 ++++++++++++++-------------- docs/input_time.md | 17 +-- docs/month_dropdown.md | 16 +-- docs/month_dropdown_options.md | 16 +-- docs/month_year_dropdown.md | 14 ++- docs/month_year_dropdown_options.md | 24 ++-- docs/portal.md | 13 +- docs/tab_loop.md | 12 +- docs/time.md | 36 +++--- docs/week_number.md | 38 +++--- docs/year.md | 49 ++++---- 14 files changed, 250 insertions(+), 226 deletions(-) diff --git a/docs/calendar_container.md b/docs/calendar_container.md index b6013064f..fc339f953 100644 --- a/docs/calendar_container.md +++ b/docs/calendar_container.md @@ -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`|| \ No newline at end of file diff --git a/docs/calendar_icon.md b/docs/calendar_icon.md index f01046d72..d5e964cbf 100644 --- a/docs/calendar_icon.md +++ b/docs/calendar_icon.md @@ -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 @@ -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 } 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`|||| \ No newline at end of file diff --git a/docs/click_outside_wrapper.md b/docs/click_outside_wrapper.md index ccf323813..cd34f6d78 100644 --- a/docs/click_outside_wrapper.md +++ b/docs/click_outside_wrapper.md @@ -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`|||| \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f7e8713b6..8e714df57 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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`|| \ No newline at end of file diff --git a/docs/input_time.md b/docs/input_time.md index c30685905..775fde09d 100644 --- a/docs/input_time.md +++ b/docs/input_time.md @@ -1,4 +1,5 @@ -# `input_time` (component) +`input_time` (component) +======================== `InputTime` is a React component that manages time input. @@ -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`|||| \ No newline at end of file diff --git a/docs/month_dropdown.md b/docs/month_dropdown.md index 949116c24..38863e7a4 100644 --- a/docs/month_dropdown.md +++ b/docs/month_dropdown.md @@ -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`|||| \ No newline at end of file diff --git a/docs/month_dropdown_options.md b/docs/month_dropdown_options.md index 29437b4ce..78ea7c96c 100644 --- a/docs/month_dropdown_options.md +++ b/docs/month_dropdown_options.md @@ -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)|||| \ No newline at end of file diff --git a/docs/month_year_dropdown.md b/docs/month_year_dropdown.md index b2074e2a7..452969ef5 100644 --- a/docs/month_year_dropdown.md +++ b/docs/month_year_dropdown.md @@ -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)|||| \ No newline at end of file diff --git a/docs/month_year_dropdown_options.md b/docs/month_year_dropdown_options.md index a14c32091..c8fa1e5ca 100644 --- a/docs/month_year_dropdown_options.md +++ b/docs/month_year_dropdown_options.md @@ -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`|||| \ No newline at end of file diff --git a/docs/portal.md b/docs/portal.md index b1fd3fd65..8b344e37c 100644 --- a/docs/portal.md +++ b/docs/portal.md @@ -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. @@ -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)|||| \ No newline at end of file diff --git a/docs/tab_loop.md b/docs/tab_loop.md index 211d301f3..ea89b3a94 100644 --- a/docs/tab_loop.md +++ b/docs/tab_loop.md @@ -1,4 +1,5 @@ -# `tab_loop` (component) +`tab_loop` (component) +====================== `TabLoop` is a React component that manages tabbing behavior for its children. @@ -9,7 +10,7 @@ and "Shift Tab" on the first element will focus the last element @component @example - + @param props - The properties that define the `TabLoop` component. @@ -18,6 +19,7 @@ and "Shift Tab" on the first element will focus the last element @returns The `TabLoop` component. -| name | type | default value | description | -| --------------- | ---- | ------------- | ----------- | -| `enableTabLoop` | | `true` | | +| name | type | default value | description | +|---|---|---|---| +|`children`|||| +|`enableTabLoop`||`true`|| \ No newline at end of file diff --git a/docs/time.md b/docs/time.md index ace375cc6..f1a2dfa18 100644 --- a/docs/time.md +++ b/docs/time.md @@ -1,18 +1,20 @@ -# `time` (component) +`time` (component) +================== -| name | type | default value | description | -| -------------------- | ---- | ------------- | ----------- | -| `format` | | | | -| `handleOnKeyDown` | | | | -| `injectTimes` | | | | -| `intervals` | | `30` | | -| `locale` | | | | -| `monthRef` | | | | -| `onChange` | | | | -| `openToDate` | | | | -| `selected` | | | | -| `showTimeCaption` | | `true` | | -| `showTimeSelectOnly` | | | | -| `timeCaption` | | `"Time"` | | -| `timeClassName` | | | | -| `todayButton` | | `null` | | + +| name | type | default value | description | +|---|---|---|---| +|`format`|||| +|`handleOnKeyDown`|||| +|`injectTimes`|||| +|`intervals`||`30`|| +|`locale`|||| +|`monthRef`|||| +|`onChange`|||| +|`openToDate`|||| +|`selected`|||| +|`showTimeCaption`||`true`|| +|`showTimeSelectOnly`|||| +|`timeCaption`||`"Time"`|| +|`timeClassName`|||| +|`todayButton`||`null`|| \ No newline at end of file diff --git a/docs/week_number.md b/docs/week_number.md index 65af5d5ca..832eb3088 100644 --- a/docs/week_number.md +++ b/docs/week_number.md @@ -1,19 +1,21 @@ -# `week_number` (component) +`week_number` (component) +========================= -| name | type | default value | description | -| ---------------------------- | ---- | ------------- | ----------- | -| `ariaLabelPrefix` | | `"week "` | | -| `containerRef` | | | | -| `date` (required) | | | | -| `disabledKeyboardNavigation` | | | | -| `handleOnKeyDown` | | | | -| `inline` | | | | -| `isInputFocused` | | | | -| `onClick` | | | | -| `preSelection` | | | | -| `selected` | | | | -| `shouldFocusDayInline` | | | | -| `showWeekNumber` | | | | -| `showWeekPicker` | | | | -| `weekNumber` (required) | | | | -| `isWeekDisabled` | | | | + +| name | type | default value | description | +|---|---|---|---| +|`ariaLabelPrefix`||`"week "`|| +|`containerRef`|||| +|`date` (required)|||| +|`disabledKeyboardNavigation`|||| +|`handleOnKeyDown`|||| +|`inline`|||| +|`isInputFocused`|||| +|`isWeekDisabled`|||| +|`onClick`|||| +|`preSelection`|||| +|`selected`|||| +|`shouldFocusDayInline`|||| +|`showWeekNumber`|||| +|`showWeekPicker`|||| +|`weekNumber` (required)|||| \ No newline at end of file diff --git a/docs/year.md b/docs/year.md index 9bf269e82..2f3eac94e 100644 --- a/docs/year.md +++ b/docs/year.md @@ -1,4 +1,5 @@ -# `year` (component) +`year` (component) +================== `Year` is a component that represents a year in a date picker. @@ -19,26 +20,26 @@ @property {(date: Date) => void} props.onYearMouseEnter - Function to handle mouse enter events on a year. @property {(date: Date) => void} props.onYearMouseLeave - Function to handle mouse leave events on a year. -| name | type | default value | description | -| ----------------------------- | ---- | ------------- | ----------- | -| `clearSelectingDate` | | | | -| `date` | | | | -| `disabledKeyboardNavigation` | | | | -| `endDate` | | | | -| `handleOnKeyDown` | | | | -| `inline` | | | | -| `onDayClick` | | | | -| `onYearMouseEnter` (required) | | | | -| `onYearMouseLeave` (required) | | | | -| `preSelection` | | | | -| `renderYearContent` | | | | -| `selected` | | | | -| `selectingDate` | | | | -| `selectsEnd` | | | | -| `selectsRange` | | | | -| `selectsStart` | | | | -| `setPreSelection` | | | | -| `startDate` | | | | -| `usePointerEvent` | | | | -| `yearClassName` | | | | -| `yearItemNumber` | | | | +| name | type | default value | description | +|---|---|---|---| +|`clearSelectingDate`|||| +|`date`|||| +|`disabledKeyboardNavigation`|||| +|`endDate`|||| +|`handleOnKeyDown`|||| +|`inline`|||| +|`onDayClick`|||| +|`onYearMouseEnter` (required)|||| +|`onYearMouseLeave` (required)|||| +|`preSelection`|||| +|`renderYearContent`|||| +|`selected`|||| +|`selectingDate`|||| +|`selectsEnd`|||| +|`selectsRange`|||| +|`selectsStart`|||| +|`setPreSelection`|||| +|`startDate`|||| +|`usePointerEvent`|||| +|`yearClassName`|||| +|`yearItemNumber`|||| \ No newline at end of file