Skip to content

Commit 6d7bce2

Browse files
author
Nathan Reyes
committed
Update docs
1 parent 11ec1d8 commit 6d7bce2

File tree

4 files changed

+113
-43
lines changed

4 files changed

+113
-43
lines changed

‎docs/api/v1.0/attribute.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -239,23 +239,23 @@ sidebarDepth: 2
239239

240240
**Description:** Default or suggested placement of the popover. This may change as the browser window dimensions change. Valid placements include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`.
241241

242-
**Default:** `"bottom-start"`
242+
**Default:** `bottom-start`
243243

244244
### `popover.positionFixed`
245245

246246
**Type:** Boolean
247247

248248
**Description:** Uses a `fixed` position when displaying the popover. Use this open when the calendar is placed within a container that has `overflow: hidden` style applied. Reference popper.js for more details.
249249

250-
**Default:** `"bottom-start"`
250+
**Default:** `false`
251251

252252
### `popover.visibility`
253253

254254
**Type:** String
255255

256-
**Description:** Visibility of the popover when this label or slot is displayed (`"hover-focus`, `"hover"`, `"focus"`, `"click"`, `"visible"`, `"hidden"`).
256+
**Description:** Visibility of the popover when this label or slot is displayed (`hover-focus`, `hover`, `focus`, `click`, `visible`, `hidden`).
257257

258-
**Default:** `"hover"`
258+
**Default:** `hover`
259259

260260
<!--
261261
###

‎docs/api/v1.0/datepicker.md‎

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ sidebarDepth: 2
2828

2929
**Description:** Selection mode: `"single"`, `"multiple"`, `"range"`
3030

31-
**Default Value:** `"single"`
31+
**Default:** `"single"`
3232

3333
:::warning
3434
**`mode` modified in [`v2.0`](../v2.0)**
@@ -40,7 +40,7 @@ sidebarDepth: 2
4040

4141
**Description:** Selected date, dates or date range.
4242

43-
**Default Value:** `null`
43+
**Default:** `null`
4444

4545
:::warning
4646
**`value` modified in [`v2.0`](../v2.0)**
@@ -52,7 +52,7 @@ sidebarDepth: 2
5252

5353
**Description:** Prevents the **user** from clearing the selected value.
5454

55-
**Default Value:** `false`
55+
**Default:** `false`
5656

5757
::: tip
5858
Setting `value = null` still allowed through code.
@@ -64,7 +64,7 @@ Setting `value = null` still allowed through code.
6464

6565
**Description:** Props to apply to the input DOM element.
6666

67-
**Default Value:** [Reference code]()
67+
**Default:** [Reference code]()
6868

6969
:::danger
7070
**`input-props` deprecated in [`v2.0`](../v2.0)**
@@ -76,47 +76,77 @@ Setting `value = null` still allowed through code.
7676

7777
**Description:** Update the picker value after every `input` event. Otherwise, value is just updated on `change` event.
7878

79-
**Default Value:** `true`
79+
**Default:** `true`
8080

8181
### `input-debounce`
8282

8383
**Type:** Number
8484

8585
**Description:** If `update-on-input` is enabled, the duration in milliseconds at which the `input` event is debounced before updating the date value.
8686

87-
**Default Value:** `1000`
87+
**Default:** `1000`
8888

8989
### `drag-attribute`
9090

9191
**Type:** Object
9292

9393
**Description:** Attribute to use for the dragged selection in "range" mode. The `dates` property is ignored.
9494

95-
**Default Value:** [Reference code]()
95+
**Default:** [Reference code]()
9696

9797
### `select-attribute`
9898

9999
**Type:** Object
100100

101101
**Description:** Attribute to use for the value selection in all modes. The `dates` property is ignored.
102102

103-
**Default Value:** [Reference code]()
103+
**Default:** [Reference code]()
104104

105105
### `popover`
106106

107107
**Type:** Object
108108

109109
**Description:** Properties of the popover to apply for the calendar component.
110110

111-
**Default Value:** [Reference code](./defaults.md)
111+
**Default:** [Reference code](./defaults.md)
112+
113+
### `popover.keepVisibleOnInput`
114+
115+
**Type:** Boolean
116+
117+
**Description:** Keep the popover visible after a date is selected (only applies for `mode: 'date'`), until the `visibility` determines that it should hide again.
118+
119+
### `popover.modifiers`
120+
121+
**Type:** Array
122+
123+
**Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
124+
125+
**Default:** `undefined`
126+
127+
### `popover.placement`
128+
129+
**Type:** String
130+
131+
**Description:** Default or suggested placement of the popover. This may change as the browser window dimensions change. [Valid placements](https://popper.js.org/popper-documentation.html#Popper.placements) include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`.
132+
133+
**Default:** `bottom-start`
134+
135+
### `popover.positionFixed`
136+
137+
**Type:** Boolean
138+
139+
**Description:** Uses a `fixed` position when displaying the popover. Use this open when the calendar is placed within a container that has `overflow: hidden` style applied. Reference popper.js for more details.
140+
141+
**Default:** `false`
142+
143+
### `popover.visibility`
144+
145+
**Type:** String
146+
147+
**Description:** Visibility mode for the input/slot popover (`hover-focus`, `hover`, `focus`, `visible`, `hidden`)
112148

113-
| Property | Type | Description |
114-
| --- | --- | --- |
115-
| `visibility` | String | Visibility mode for the input/slot popover (`"hover-focus"`, `"hover"`, `"focus"`, `"visible"`, `"hidden"`) |
116-
| `placement` | String | Default or suggested placement of the popover. This may change as the browser window dimensions change. [Valid placements](https://popper.js.org/docs/v2/constructors/#placement) include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`. |
117-
| `positionFixed` | Boolean | Display the popover in `fixed` mode. Reference [`popper.js`](https://popper.js.org/docs/v2/constructors/#strategy) for more details. |
118-
| `modifiers` | Array | Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers). |
119-
| `keepVisibleOnInput` | Boolean | Keep the popover visible after a date is selected, until the `visibility` determines. |
149+
**Default:** `hover-focus`
120150

121151
<!--
122152
###
@@ -125,7 +155,7 @@ Setting `value = null` still allowed through code.
125155
126156
**Description:**
127157
128-
**Default Value:**
158+
**Default:**
129159
-->
130160

131161
## Events

‎docs/api/v2.0/attribute.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,27 +233,29 @@ sidebarDepth: 2
233233

234234
**Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
235235

236+
**Default:** `undefined`
237+
236238
### `popover.placement`
237239

238240
**Type:** String
239241

240242
**Description:** Default or suggested placement of the popover. This may change as the browser window dimensions change. Valid placements include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`.
241243

242-
**Default:** `"bottom-start"`
244+
**Default:** `bottom-start`
243245

244246
### `popover.positionFixed`
245247

246248
**Type:** Boolean
247249

248250
**Description:** Uses a `fixed` position when displaying the popover. Use this open when the calendar is placed within a container that has `overflow: hidden` style applied. Reference popper.js for more details.
249251

250-
**Default:** `"bottom-start"`
252+
**Default:** `false`
251253

252254
### `popover.visibility`
253255

254256
**Type:** String
255257

256-
**Description:** Visibility of the popover when this label or slot is displayed (`"hover-focus`, `"hover"`, `"focus"`, `"click"`, `"visible"`, `"hidden"`).
258+
**Description:** Visibility of the popover when this label or slot is displayed (`hover-focus`, `hover`, `focus`, `click`, `visible`, `hidden`).
257259

258260
**Default:** `"hover"`
259261

‎docs/api/v2.0/datepicker.md‎

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,47 +16,47 @@ sidebarDepth: 2
1616

1717
**Description:** Selection mode: `"date"`, `"dateTime"`, `"time"`
1818

19-
**Default Value:** `"single"`
19+
**Default:** `"single"`
2020

2121
### `value`
2222

2323
**Type:** Date, Object
2424

2525
**Description:** Selected date or date range.
2626

27-
**Default Value:** `null`
27+
**Default:** `null`
2828

2929
### `is-range`
3030

3131
**Type:** Boolean
3232

3333
**Description:** Date value is a date range object.
3434

35-
**Default Value:** `false`
35+
**Default:** `false`
3636

3737
### `is24hr`
3838

3939
**Type:** Boolean
4040

4141
**Description:** Use 24-hr time picker and input format.
4242

43-
**Default Value:** `false`
43+
**Default:** `false`
4444

4545
### `minute-increment`
4646

4747
**Type:** Number
4848

4949
**Description:** Increment amount for the minute `select` options.
5050

51-
**Default Value:** 1
51+
**Default:** 1
5252

5353
### `is-required`
5454

5555
**Type:** Boolean
5656

5757
**Description:** Prevents the **user** from clearing the selected value.
5858

59-
**Default Value:** `false`
59+
**Default:** `false`
6060

6161
::: tip
6262
Setting `value = null` still allowed through code.
@@ -68,47 +68,85 @@ Setting `value = null` still allowed through code.
6868

6969
**Description:** Update the picker value after every `input` event. Otherwise, value is just updated on `change` event.
7070

71-
**Default Value:** `true`
71+
**Default:** `true`
7272

7373
### `input-debounce`
7474

7575
**Type:** Number
7676

7777
**Description:** If `update-on-input` is enabled, the duration in milliseconds at which the `input` event is debounced before updating the date value.
7878

79-
**Default Value:** `1000`
79+
**Default:** `1000`
8080

8181
### `drag-attribute`
8282

8383
**Type:** Object
8484

8585
**Description:** Attribute to use for the dragged selection in "range" mode. The `dates` property is ignored.
8686

87-
**Default Value:** [Reference code]()
87+
**Default:** [Reference code]()
8888

8989
### `select-attribute`
9090

9191
**Type:** Object
9292

9393
**Description:** Attribute to use for the value selection in all modes. The `dates` property is ignored.
9494

95-
**Default Value:** [Reference code]()
95+
**Default:** [Reference code]()
9696

9797
### `popover`
9898

9999
**Type:** Object
100100

101101
**Description:** Properties of the popover to apply for the calendar component.
102102

103-
**Default Value:** [Reference code](./defaults.md)
103+
**Default:** [Reference code](./defaults.md)
104104

105-
| Property | Type | Description |
106-
| --- | --- | --- |
107-
| `visibility` | String | Visibility mode for the input/slot popover (`"hover-focus"`, `"hover"`, `"focus"`, `"visible"`, `"hidden"`) |
108-
| `placement` | String | Default or suggested placement of the popover. This may change as the browser window dimensions change. [Valid placements](https://popper.js.org/popper-documentation.html#Popper.placements) include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`. |
109-
| `positionFixed` | Boolean | Display the popover in `fixed` mode. Reference [`popper.js`](https://popper.js.org/popper-documentation.html#Popper.Defaults.positionFixed) for more details. |
110-
| `modifiers` | Boolean | Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/popper-documentation.html#modifiers). |
111-
| `keepVisibleOnInput` | Boolean | Keep the popover visible after a date is selected, until the `visibility` determines. |
105+
### `popover.keepVisibleOnInput`
106+
107+
**Type:** Boolean
108+
109+
**Description:** Keep the popover visible after a date is selected (only applies for `mode: 'date'`), until the `visibility` determines that it should hide again.
110+
111+
### `popover.modifiers`
112+
113+
**Type:** Array
114+
115+
**Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
116+
117+
**Default:** `undefined`
118+
119+
### `popover.placement`
120+
121+
**Type:** String
122+
123+
**Description:** Default or suggested placement of the popover. This may change as the browser window dimensions change. [Valid placements](https://popper.js.org/popper-documentation.html#Popper.placements) include `auto`, `top`, `right`, `bottom`, `left`. Each placement can have suffixed variations `-start` or `-end`.
124+
125+
**Default:** `bottom-start`
126+
127+
### `popover.positionFixed`
128+
129+
**Type:** Boolean
130+
131+
**Description:** Uses a `fixed` position when displaying the popover. Use this open when the calendar is placed within a container that has `overflow: hidden` style applied. Reference popper.js for more details.
132+
133+
**Default:** `false`
134+
135+
### `popover.transition`
136+
137+
**Type:** String
138+
139+
**Description:** Transition to use when displaying the popover (`slide-fade`, `fade`, `none` or ``).
140+
141+
**Default:** `slide-fade`
142+
143+
### `popover.visibility`
144+
145+
**Type:** String
146+
147+
**Description:** Visibility mode for the input/slot popover (`hover-focus`, `hover`, `focus`, `visible`, `hidden`)
148+
149+
**Default:** `hover-focus`
112150

113151
<!--
114152
###
@@ -117,7 +155,7 @@ Setting `value = null` still allowed through code.
117155
118156
**Description:**
119157
120-
**Default Value:**
158+
**Default:**
121159
-->
122160

123161
## Events

0 commit comments

Comments
 (0)