9fd0ff4a6a
* return date object from date/datetime widgets if no format set BREAKING CHANGE As of 1.0, the documented behavior for the date and datetime widgets was to always return a string value, but they were instead returning a date object if the default date was not manually changed by the user. This was addressed in #1143, but it became clear afterward that static site generators were depending on the raw date objects that Netlify CMS was unintentionally producing. Remaining as is or addressing the bug were both "breaking" states, so this commit reverts to producing raw date objects when no format is explicitly set. It is now considered an edge case to require string dates, as most static site generators expect to parse a raw date against formatting in a site's templates. Also note that this commit improves the original behavior by always providing a date object when no format is provided, even if the user manually changes the value. * produce raw date when no format is provided
25 lines
714 B
Markdown
25 lines
714 B
Markdown
---
|
|
label: "DateTime"
|
|
target: "datetime"
|
|
---
|
|
|
|
### DateTime
|
|
|
|
The datetime widget translates a datetime picker to a datetime string. For saving the date only, use the date widget.
|
|
|
|
- **Name:** `datetime`
|
|
- **UI:** datetime picker
|
|
- **Data type:** Moment.js-formatted datetime string
|
|
- **Options:**
|
|
- `default`: accepts a datetime string, or an empty string to accept blank input; otherwise defaults to current datetime
|
|
- `format`: optional; accepts Moment.js [tokens](https://momentjs.com/docs/#/parsing/string-format/); defaults to raw Date object (if supported by output format)
|
|
- **Example:**
|
|
|
|
```yaml
|
|
- label: "Start time"
|
|
name: "start"
|
|
widget: "datetime"
|
|
default: ""
|
|
format: "LLL"
|
|
```
|