From 162227e6e3e2acae9d3492dbcdd877cf4dfd87d1 Mon Sep 17 00:00:00 2001 From: Daniel Lehr Date: Fri, 8 Nov 2024 23:08:57 +0100 Subject: [PATCH] update README.md --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2c747a9..6e7679c 100644 --- a/README.md +++ b/README.md @@ -286,19 +286,21 @@ type Options = { digits?: 'numeric' | '2-digit' snapToStep?: boolean wheelControl?: boolean + disallowPartial?: boolean } ``` -| Option | Default | Description | -| -------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date` | `undefined` | The initial date. If not set, it will render the placeholders in their respective input fields (if set). | -| `minDate` | `undefined` | The minimum date that the user can select. `$NOW` is a special value that represents the current date and time. [See more below](#now-vavue) | -| `maxDate` | `undefined` | The maximum date that the user can select. `$NOW` is a special value that represents the current date and time. [See more below](#now-value) | -| `hour12` | `false` | If set to `true`, the time input will use a 12-hour format (with AM/PM). If set to `false`, it will use a 24-hour format. | -| `digits` | `'2-digit'` | Controls the display of the day and month in the date input. `'numeric'` displays as 1-12 for month and 1-31 for day, while `'2-digit'` displays as 01-12 for month and 01-31 for day. This follows [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#day) convention. | -| `wrapAround` | `false` | If set to `true`, the time input will wrap around from the end of one period (AM/PM or day) to the beginning of the next. | -| `snapToStep` | `false` | If set to `true`, the input value will snap to the nearest step when the user uses arrow keys to increment/decrement values. Can be further adjust by using the [`step` attribute](#step-on-input-elements) | -| `wheelControl` | `false` | If set to `true`, the user can use the mouse wheel or touchpad to increment/decrement values. | +| Option | Default | Description | +| ----------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `date` | `undefined` | The initial date. If not set, it will render the placeholders in their respective input fields (if set). | +| `minDate` | `undefined` | The minimum date that the user can select. `$NOW` is a special value that represents the current date and time. [See more below](#now-vavue) | +| `maxDate` | `undefined` | The maximum date that the user can select. `$NOW` is a special value that represents the current date and time. [See more below](#now-value) | +| `hour12` | `false` | If set to `true`, the time input will use a 12-hour format (with AM/PM). If set to `false`, it will use a 24-hour format. | +| `digits` | `'2-digit'` | Controls the display of the day and month in the date input. `'numeric'` displays as 1-12 for month and 1-31 for day, while `'2-digit'` displays as 01-12 for month and 01-31 for day. This follows [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#day) convention. | +| `wrapAround` | `false` | If set to `true`, the time input will wrap around from the end of one period (AM/PM or day) to the beginning of the next. | +| `snapToStep` | `false` | If set to `true`, the input value will snap to the nearest step when the user uses arrow keys to increment/decrement values. Can be further adjust by using the [`step` attribute](#step-on-input-elements) | +| `wheelControl` | `false` | If set to `true`, the user can use the mouse wheel or touchpad to increment/decrement values. | +| `disallowPartial` | `false` | If `true`, the input requires fully completed dates and times. By default partial dates are allowed, similar to native HTML input behavior. | ### `$NOW` value