Skip to content

Commit

Permalink
Last updates
Browse files Browse the repository at this point in the history
Signed-off-by: gpbl <[email protected]>
  • Loading branch information
gpbl committed Mar 2, 2024
1 parent a8bfa54 commit 6515ed4
Show file tree
Hide file tree
Showing 299 changed files with 2,285 additions and 2,284 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ The name of the modifiers that are used internally by DayPicker.

| Enumeration Member | Value | Description |
| :------ | :------ | :------ |
| `Disabled` | `"disabled"` | Name of the modifier applied to the disabled days, using the `disabled` prop. |
| `Disabled` | `"disabled"` | Name of the modifier applied to the disabled days, using the `disabled`<br />prop. |
| `Hidden` | `"hidden"` | Name of the modifier applied to the hidden days using the `hidden` prop). |
| `Outside` | `"outside"` | - |
| `RangeEnd` | `"range_end"` | The modifier applied to the day ending a selected range, when in range selection mode. |
| `RangeMiddle` | `"range_middle"` | The modifier applied to the days between the start and the end of a selected range, when in range selection mode. |
| `RangeStart` | `"range_start"` | The modifier applied to the day starting a selected range, when in range selection mode. |
| `Selected` | `"selected"` | Name of the modifier applied to the selected days using the `selected` prop). |
| `RangeEnd` | `"range_end"` | The modifier applied to the day ending a selected range, when in range<br />selection mode. |
| `RangeMiddle` | `"range_middle"` | The modifier applied to the days between the start and the end of a<br />selected range, when in range selection mode. |
| `RangeStart` | `"range_start"` | The modifier applied to the day starting a selected range, when in range<br />selection mode. |
| `Selected` | `"selected"` | Name of the modifier applied to the selected days using the `selected`<br />prop). |
| `Today` | `"today"` | Name of the modifier applied to the day specified using the `today` prop). |
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Render a button HTML element applying the reset class name.

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/Button/Button.tsx:9
[src/components/Button/Button.tsx:9](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Button/Button.tsx#L9)
25 changes: 25 additions & 0 deletions docs/api/latest/functions/Caption.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
section: Function
title: Caption
---

# Function: Caption()

> **Caption**(`props`): `JSX.Element`
Render the caption of a month. The caption has a different layout when
setting the [DayPickerBase.captionLayout](/api/latest/interfaces/DayPickerBase.mdx) prop.

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`CaptionProps`](/api/latest/interfaces/CaptionProps.mdx) |

## Returns

`JSX.Element`

## Source

[src/components/Caption/Caption.tsx:36](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Caption/Caption.tsx#L36)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render a caption with the dropdowns to navigate between months and years.

| Parameter | Type |
| :------ | :------ |
| `props` | [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx) |
| `props` | [`CaptionProps`](/api/latest/interfaces/CaptionProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/CaptionDropdowns/CaptionDropdowns.tsx:14
[src/components/CaptionDropdowns/CaptionDropdowns.tsx:12](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/CaptionDropdowns/CaptionDropdowns.tsx#L12)
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@ title: CaptionLabel

> **CaptionLabel**(`props`): `JSX.Element`
Render the caption for the displayed month. This component is used when `captionLayout="buttons"`.
Render the caption for the displayed month. This component is used when
`captionLayout="buttons"`.

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`CaptionLabelProps`](/docs/api/main/interfaces/CaptionLabelProps.mdx) |
| `props` | [`CaptionLabelProps`](/api/latest/interfaces/CaptionLabelProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/CaptionLabel/CaptionLabel.tsx:14
[src/components/CaptionLabel/CaptionLabel.tsx:23](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/CaptionLabel/CaptionLabel.tsx#L23)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render a caption with a button-based navigation.

| Parameter | Type |
| :------ | :------ |
| `props` | [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx) |
| `props` | [`CaptionProps`](/api/latest/interfaces/CaptionProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/CaptionNavigation/CaptionNavigation.tsx:13
[src/components/CaptionNavigation/CaptionNavigation.tsx:11](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/CaptionNavigation/CaptionNavigation.tsx#L11)
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ modifiers.

| Parameter | Type |
| :------ | :------ |
| `props` | [`DayProps`](/docs/api/main/interfaces/DayProps.mdx) |
| `props` | [`DayProps`](/api/latest/interfaces/DayProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/Day/Day.tsx:19
[src/components/Day/Day.tsx:19](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Day/Day.tsx#L19)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render the content of the day cell.

| Parameter | Type |
| :------ | :------ |
| `props` | [`DayContentProps`](/docs/api/main/interfaces/DayContentProps.mdx) |
| `props` | [`DayContentProps`](/api/latest/interfaces/DayContentProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/DayContent/DayContent.tsx:15
[src/components/DayContent/DayContent.tsx:15](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/DayContent/DayContent.tsx#L15)
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ examples.

DayPicker offers different customization props. For example,

- show multiple months using `numberOfMonths`
- display a dropdown to navigate the months via `captionLayout`
- display the week numbers with `showWeekNumbers`
- disable or hide days with `disabled` or `hidden`
- Show multiple months using `numberOfMonths`
- Display a dropdown to navigate the months via `captionLayout`
- Display the week numbers with `showWeekNumbers`
- Disable or hide days with `disabled` or `hidden`

### Controlling the months

Expand All @@ -40,13 +40,13 @@ DayPicker supports different selection mode that can be toggled using the
days.
- `mode="multiple"`: users can select one or more days. Limit the amount of
days that can be selected with the `min` or the `max` props.
- `mode="range"`: users can select a range of days. Limit the amount of days
in the range with the `min` or the `max` props.
- `mode="range"`: users can select a range of days. Limit the amount of days in
the range with the `min` or the `max` props.
- `mode="default"` (default): the built-in selections are disabled. Implement
your own selection mode with `onDayClick`.

The selection modes should cover the most common use cases. In case you
need a more refined way of selecting days, use `mode="default"`. Use the
The selection modes should cover the most common use cases. In case you need
a more refined way of selecting days, use `mode="default"`. Use the
`selected` props and add the day event handlers to add/remove days from the
selection.

Expand Down Expand Up @@ -88,21 +88,19 @@ To localize DayPicker, import the locale from `date-fns` package and use the

For example, to use Spanish locale:

```
import { es } from 'date-fns/locale';
<DayPicker locale={es} />
```
import \{ es \} from 'date-fns/locale';
`<DayPicker locale=\{es\} />`;

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`DayPickerSingleProps`](/docs/api/main/interfaces/DayPickerSingleProps.mdx) \| [`DayPickerMultipleProps`](/docs/api/main/interfaces/DayPickerMultipleProps.mdx) \| [`DayPickerRangeProps`](/docs/api/main/interfaces/DayPickerRangeProps.mdx) \| [`DayPickerDefaultProps`](/docs/api/main/interfaces/DayPickerDefaultProps.mdx) |
| `props` | [`DayPickerMultipleProps`](/api/latest/interfaces/DayPickerMultipleProps.mdx) \| [`DayPickerDefaultProps`](/api/latest/interfaces/DayPickerDefaultProps.mdx) \| [`DayPickerSingleProps`](/api/latest/interfaces/DayPickerSingleProps.mdx) \| [`DayPickerRangeProps`](/api/latest/interfaces/DayPickerRangeProps.mdx) |

## Returns

`JSX.Element`

## Source

typedoc/node\_modules/react-day-picker-v8/src/DayPicker.tsx:102
[src/DayPicker.tsx:100](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/DayPicker.tsx#L100)
25 changes: 25 additions & 0 deletions docs/api/latest/functions/DayPickerProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
section: Function
title: DayPickerProvider
---

# Function: DayPickerProvider()

> **DayPickerProvider**(`props`): `JSX.Element`
The provider for the [DayPickerContext](/api/latest/variables/DayPickerContext.mdx), assigning the defaults from the
initial DayPicker props.

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`DayPickerProviderProps`](/api/latest/interfaces/DayPickerProviderProps.mdx) |

## Returns

`JSX.Element`

## Source

[src/contexts/DayPicker/DayPickerContext.tsx:77](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/contexts/DayPicker/DayPickerContext.tsx#L77)
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ drop-down icon.

| Parameter | Type |
| :------ | :------ |
| `props` | [`DropdownProps`](/docs/api/main/interfaces/DropdownProps.mdx) |
| `props` | [`DropdownProps`](/api/latest/interfaces/DropdownProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/Dropdown/Dropdown.tsx:30
[src/components/Dropdown/Dropdown.tsx:30](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Dropdown/Dropdown.tsx#L30)
24 changes: 24 additions & 0 deletions docs/api/latest/functions/FocusProvider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
section: Function
title: FocusProvider
---

# Function: FocusProvider()

> **FocusProvider**(`props`): `JSX.Element`
The provider for the [FocusContext](/api/latest/variables/FocusContext.mdx).

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`FocusProviderProps`](/api/latest/type-aliases/FocusProviderProps.mdx) |

## Returns

`JSX.Element`

## Source

[src/contexts/Focus/FocusContext.tsx:60](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/contexts/Focus/FocusContext.tsx#L60)
24 changes: 24 additions & 0 deletions docs/api/latest/functions/Footer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
section: Function
title: Footer
---

# Function: Footer()

> **Footer**(`props`): `Element`
Render the Footer component (empty as default).

## Parameters

| Parameter | Type |
| :------ | :------ |
| `props` | [`FooterProps`](/api/latest/interfaces/FooterProps.mdx) |

## Returns

`Element`

## Source

[src/components/Footer/Footer.tsx:9](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Footer/Footer.tsx#L9)
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Render the table head.

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/Head/Head.tsx:5
[src/components/Head/Head.tsx:5](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Head/Head.tsx#L5)
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ title: HeadRow

> **HeadRow**(): `JSX.Element`
Render the HeadRow component - i.e. the table head row with the weekday names.
Render the HeadRow component - i.e. the table head row with the weekday
names.

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/HeadRow/HeadRow.tsx:8
[src/components/HeadRow/HeadRow.tsx:9](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/HeadRow/HeadRow.tsx#L9)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render the icon in the styled drop-down.

| Parameter | Type |
| :------ | :------ |
| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) |
| `props` | [`StyledComponent`](/api/latest/type-aliases/StyledComponent.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/IconDropdown/IconDropdown.tsx:6
[src/components/IconDropdown/IconDropdown.tsx:4](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/IconDropdown/IconDropdown.tsx#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render the "previous month" button in the navigation.

| Parameter | Type |
| :------ | :------ |
| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) |
| `props` | [`StyledComponent`](/api/latest/type-aliases/StyledComponent.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/IconLeft/IconLeft.tsx:6
[src/components/IconLeft/IconLeft.tsx:4](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/IconLeft/IconLeft.tsx#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render the "next month" button in the navigation.

| Parameter | Type |
| :------ | :------ |
| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) |
| `props` | [`StyledComponent`](/api/latest/type-aliases/StyledComponent.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/IconRight/IconRight.tsx:6
[src/components/IconRight/IconRight.tsx:4](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/IconRight/IconRight.tsx#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Render the wrapper for the month grids.

| Parameter | Type |
| :------ | :------ |
| `props` | [`MonthsProps`](/docs/api/main/type-aliases/MonthsProps.mdx) |
| `props` | [`MonthsProps`](/api/latest/type-aliases/MonthsProps.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/components/Months/Months.tsx:11
[src/components/Months/Months.tsx:9](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/components/Months/Months.tsx#L9)
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: NavigationProvider

> **NavigationProvider**(`props`): `JSX.Element`
Provides the values for the [NavigationContext](/docs/api/main/variables/NavigationContext.mdx).
Provides the values for the [NavigationContext](/api/latest/variables/NavigationContext.mdx).

## Parameters

Expand All @@ -22,4 +22,4 @@ Provides the values for the [NavigationContext](/docs/api/main/variables/Navigat

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/contexts/Navigation/NavigationContext.tsx:38
[src/contexts/Navigation/NavigationContext.tsx:44](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/contexts/Navigation/NavigationContext.tsx#L44)
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Provide the value for all the context providers.

| Parameter | Type |
| :------ | :------ |
| `props` | [`RootContext`](/docs/api/main/interfaces/RootContext.mdx) |
| `props` | [`RootContext`](/api/latest/interfaces/RootContext.mdx) |

## Returns

`JSX.Element`

## Source

node\_modules/.pnpm/[email protected]\_[email protected]\_[email protected]/node\_modules/react-day-picker/src/contexts/RootProvider.tsx:18
[src/contexts/RootProvider.tsx:17](https://github.com/gpbl/react-day-picker/blob/a8bfa5451/src/contexts/RootProvider.tsx#L17)
Loading

0 comments on commit 6515ed4

Please sign in to comment.