File size: 3,672 Bytes
cf86710 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | # Interface: UseInputOptions
## Extends
- `Pick` \<[`DayPickerBase`](DayPickerBase.md), `"locale"` \| `"fromDate"` \| `"toDate"` \| `"fromMonth"` \| `"toMonth"` \| `"fromYear"` \| `"toYear"` \| `"today"`\>
## Properties
### defaultSelected?
> `optional` **defaultSelected**: `Date`
The initially selected date
#### Source
[src/hooks/useInput/useInput.ts:53](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/hooks/useInput/useInput.ts#L53)
***
### format?
> `optional` **format**: `string`
The format string for formatting the input field. See
https://date-fns.org/docs/format for a list of format strings.
#### Default Value
```ts
PP
```
#### Source
[src/hooks/useInput/useInput.ts:60](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/hooks/useInput/useInput.ts#L60)
***
### fromDate?
> `optional` **fromDate**: `Date`
The earliest day to start the month navigation.
#### Inherited from
`Pick.fromDate`
#### Source
[src/types/DayPickerBase.ts:103](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L103)
***
### fromMonth?
> `optional` **fromMonth**: `Date`
The earliest month to start the month navigation.
#### Inherited from
`Pick.fromMonth`
#### Source
[src/types/DayPickerBase.ts:107](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L107)
***
### fromYear?
> `optional` **fromYear**: `number`
The earliest year to start the month navigation.
#### Inherited from
`Pick.fromYear`
#### Source
[src/types/DayPickerBase.ts:111](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L111)
***
### locale?
> `optional` **locale**: `Locale`
The date-fns locale object used to localize dates.
#### Default Value
```ts
en-US
```
#### Inherited from
`Pick.locale`
#### Source
[src/types/DayPickerBase.ts:246](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L246)
***
### required?
> `optional` **required**: `boolean`
Make the selection required.
#### Source
[src/hooks/useInput/useInput.ts:62](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/hooks/useInput/useInput.ts#L62)
***
### toDate?
> `optional` **toDate**: `Date`
The latest day to end the month navigation.
#### Inherited from
`Pick.toDate`
#### Source
[src/types/DayPickerBase.ts:105](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L105)
***
### toMonth?
> `optional` **toMonth**: `Date`
The latest month to end the month navigation.
#### Inherited from
`Pick.toMonth`
#### Source
[src/types/DayPickerBase.ts:109](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L109)
***
### toYear?
> `optional` **toYear**: `number`
The latest year to end the month navigation.
#### Inherited from
`Pick.toYear`
#### Source
[src/types/DayPickerBase.ts:113](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L113)
***
### today?
> `optional` **today**: `Date`
The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day.
#### Inherited from
`Pick.today`
#### Source
[src/types/DayPickerBase.ts:237](https://github.com/gpbl/react-day-picker/blob/9ad13dc72fff814dcf720a62f6e3b5ea38e8af6d/src/types/DayPickerBase.ts#L237)
|