Update docs

nathanreyes · Nov 1, 2020 · 6d7bce2 · 6d7bce2
1 parent 11ec1d8
commit 6d7bce2
Show file tree

Hide file tree

Showing 4 changed files with 113 additions and 43 deletions.
diff --git a/docs/api/v1.0/attribute.md b/docs/api/v1.0/attribute.md
@@ -239,23 +239,23 @@ sidebarDepth: 2
 
 **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`.
 
-**Default:** `"bottom-start"`
+**Default:** `bottom-start`
 
 ### `popover.positionFixed`
 
 **Type:** Boolean
 
 **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.
 
-**Default:** `"bottom-start"`
+**Default:** `false`
 
 ### `popover.visibility`
 
 **Type:** String
 
-**Description:** Visibility of the popover when this label or slot is displayed (`"hover-focus`, `"hover"`, `"focus"`, `"click"`, `"visible"`, `"hidden"`).
+**Description:** Visibility of the popover when this label or slot is displayed (`hover-focus`, `hover`, `focus`, `click`, `visible`, `hidden`).
 
-**Default:** `"hover"`
+**Default:** `hover`
 
 <!-- 
 ### 

diff --git a/docs/api/v1.0/datepicker.md b/docs/api/v1.0/datepicker.md
@@ -28,7 +28,7 @@ sidebarDepth: 2
 
 **Description:** Selection mode: `"single"`, `"multiple"`, `"range"`
 
-**Default Value:** `"single"`
+**Default:** `"single"`
 
 :::warning
 **`mode` modified in [`v2.0`](../v2.0)**
@@ -40,7 +40,7 @@ sidebarDepth: 2
 
 **Description:** Selected date, dates or date range.
 
-**Default Value:** `null`
+**Default:** `null`
 
 :::warning
 **`value` modified in [`v2.0`](../v2.0)**
@@ -52,7 +52,7 @@ sidebarDepth: 2
 
 **Description:** Prevents the **user** from clearing the selected value.
 
-**Default Value:** `false`
+**Default:** `false`
 
 ::: tip
 Setting `value = null` still allowed through code.
@@ -64,7 +64,7 @@ Setting `value = null` still allowed through code.
 
 **Description:** Props to apply to the input DOM element.
 
-**Default Value:** [Reference code]()
+**Default:** [Reference code]()
 
 :::danger
 **`input-props` deprecated in [`v2.0`](../v2.0)**
@@ -76,47 +76,77 @@ Setting `value = null` still allowed through code.
 
 **Description:** Update the picker value after every `input` event. Otherwise, value is just updated on `change` event.
 
-**Default Value:** `true`
+**Default:** `true`
 
 ### `input-debounce`
 
 **Type:** Number
 
 **Description:** If `update-on-input` is enabled, the duration in milliseconds at which the `input` event is debounced before updating the date value.
 
-**Default Value:** `1000`
+**Default:** `1000`
 
 ### `drag-attribute`
 
 **Type:** Object
 
 **Description:** Attribute to use for the dragged selection in "range" mode. The `dates` property is ignored.
 
-**Default Value:** [Reference code]()
+**Default:** [Reference code]()
 
 ### `select-attribute`
 
 **Type:** Object
 
 **Description:** Attribute to use for the value selection in all modes. The `dates` property is ignored.
 
-**Default Value:** [Reference code]()
+**Default:** [Reference code]()
 
 ### `popover`
 
 **Type:** Object
 
 **Description:** Properties of the popover to apply for the calendar component.
 
-**Default Value:** [Reference code](./defaults.md)
+**Default:** [Reference code](./defaults.md)
+
+### `popover.keepVisibleOnInput`
+
+**Type:** Boolean
+
+**Description:** Keep the popover visible after a date is selected (only applies for `mode: 'date'`), until the `visibility` determines that it should hide again.
+
+### `popover.modifiers`
+
+**Type:** Array
+
+**Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
+
+**Default:** `undefined`
+
+### `popover.placement`
+
+**Type:** String
+
+**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`.
+
+**Default:** `bottom-start`
+
+### `popover.positionFixed`
+
+**Type:** Boolean
+
+**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.
+
+**Default:** `false`
+
+### `popover.visibility`
+
+**Type:** String
+
+**Description:** Visibility mode for the input/slot popover (`hover-focus`, `hover`, `focus`, `visible`, `hidden`)
 
-| Property | Type | Description |
-| --- | --- | --- |
-| `visibility` | String | Visibility mode for the input/slot popover (`"hover-focus"`, `"hover"`, `"focus"`, `"visible"`, `"hidden"`) |
-| `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`. |
-| `positionFixed` | Boolean | Display the popover in `fixed` mode. Reference [`popper.js`](https://popper.js.org/docs/v2/constructors/#strategy) for more details. |
-| `modifiers` | Array | Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers). |
-| `keepVisibleOnInput` | Boolean | Keep the popover visible after a date is selected, until the `visibility` determines. |
+**Default:** `hover-focus`
 
 <!-- 
 ### 
@@ -125,7 +155,7 @@ Setting `value = null` still allowed through code.
 
 **Description:** 
 
-**Default Value:** 
+**Default:** 
 -->
 
 ## Events

diff --git a/docs/api/v2.0/attribute.md b/docs/api/v2.0/attribute.md
@@ -233,27 +233,29 @@ sidebarDepth: 2
 
 **Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
 
+**Default:** `undefined`
+
 ### `popover.placement`
 
 **Type:** String
 
 **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`.
 
-**Default:** `"bottom-start"`
+**Default:** `bottom-start`
 
 ### `popover.positionFixed`
 
 **Type:** Boolean
 
 **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.
 
-**Default:** `"bottom-start"`
+**Default:** `false`
 
 ### `popover.visibility`
 
 **Type:** String
 
-**Description:** Visibility of the popover when this label or slot is displayed (`"hover-focus`, `"hover"`, `"focus"`, `"click"`, `"visible"`, `"hidden"`).
+**Description:** Visibility of the popover when this label or slot is displayed (`hover-focus`, `hover`, `focus`, `click`, `visible`, `hidden`).
 
 **Default:** `"hover"`
 

diff --git a/docs/api/v2.0/datepicker.md b/docs/api/v2.0/datepicker.md
@@ -16,47 +16,47 @@ sidebarDepth: 2
 
 **Description:** Selection mode: `"date"`, `"dateTime"`, `"time"`
 
-**Default Value:** `"single"`
+**Default:** `"single"`
 
 ### `value`
 
 **Type:** Date, Object
 
 **Description:** Selected date or date range.
 
-**Default Value:** `null`
+**Default:** `null`
 
 ### `is-range`
 
 **Type:** Boolean
 
 **Description:** Date value is a date range object.
 
-**Default Value:** `false`
+**Default:** `false`
 
 ### `is24hr`
 
 **Type:** Boolean
 
 **Description:** Use 24-hr time picker and input format.
 
-**Default Value:** `false`
+**Default:** `false`
 
 ### `minute-increment`
 
 **Type:** Number
 
 **Description:** Increment amount for the minute `select` options.
 
-**Default Value:** 1
+**Default:** 1
 
 ### `is-required`
 
 **Type:** Boolean
 
 **Description:** Prevents the **user** from clearing the selected value.
 
-**Default Value:** `false`
+**Default:** `false`
 
 ::: tip
 Setting `value = null` still allowed through code.
@@ -68,47 +68,85 @@ Setting `value = null` still allowed through code.
 
 **Description:** Update the picker value after every `input` event. Otherwise, value is just updated on `change` event.
 
-**Default Value:** `true`
+**Default:** `true`
 
 ### `input-debounce`
 
 **Type:** Number
 
 **Description:** If `update-on-input` is enabled, the duration in milliseconds at which the `input` event is debounced before updating the date value.
 
-**Default Value:** `1000`
+**Default:** `1000`
 
 ### `drag-attribute`
 
 **Type:** Object
 
 **Description:** Attribute to use for the dragged selection in "range" mode. The `dates` property is ignored.
 
-**Default Value:** [Reference code]()
+**Default:** [Reference code]()
 
 ### `select-attribute`
 
 **Type:** Object
 
 **Description:** Attribute to use for the value selection in all modes. The `dates` property is ignored.
 
-**Default Value:** [Reference code]()
+**Default:** [Reference code]()
 
 ### `popover`
 
 **Type:** Object
 
 **Description:** Properties of the popover to apply for the calendar component.
 
-**Default Value:** [Reference code](./defaults.md)
+**Default:** [Reference code](./defaults.md)
 
-| Property | Type | Description |
-| --- | --- | --- |
-| `visibility` | String | Visibility mode for the input/slot popover (`"hover-focus"`, `"hover"`, `"focus"`, `"visible"`, `"hidden"`) |
-| `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`. |
-| `positionFixed` | Boolean | Display the popover in `fixed` mode. Reference [`popper.js`](https://popper.js.org/popper-documentation.html#Popper.Defaults.positionFixed) for more details. |
-| `modifiers` | Boolean | Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/popper-documentation.html#modifiers). |
-| `keepVisibleOnInput` | Boolean | Keep the popover visible after a date is selected, until the `visibility` determines. |
+### `popover.keepVisibleOnInput`
+
+**Type:** Boolean
+
+**Description:** Keep the popover visible after a date is selected (only applies for `mode: 'date'`), until the `visibility` determines that it should hide again.
+
+### `popover.modifiers`
+
+**Type:** Array
+
+**Description:** Modifiers used to modify the behavior of [`popper.js`](https://popper.js.org/docs/v2/modifiers/).
+
+**Default:** `undefined`
+
+### `popover.placement`
+
+**Type:** String
+
+**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`.
+
+**Default:** `bottom-start`
+
+### `popover.positionFixed`
+
+**Type:** Boolean
+
+**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.
+
+**Default:** `false`
+
+### `popover.transition`
+
+**Type:** String
+
+**Description:** Transition to use when displaying the popover (`slide-fade`, `fade`, `none` or ``).
+
+**Default:** `slide-fade`
+
+### `popover.visibility`
+
+**Type:** String
+
+**Description:** Visibility mode for the input/slot popover (`hover-focus`, `hover`, `focus`, `visible`, `hidden`)
+
+**Default:** `hover-focus`
 
 <!-- 
 ### 
@@ -117,7 +155,7 @@ Setting `value = null` still allowed through code.
 
 **Description:** 
 
-**Default Value:** 
+**Default:** 
 -->
 
 ## Events