Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New page: dateTime property #36987

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions files/en-us/web/api/htmlmodelement/datetime/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "HTMLModElement: dateTime property"
short-title: dateTime
slug: Web/API/HTMLModElement/dateTime
page-type: web-api-instance-property
browser-compat: api.HTMLModElement.dateTime
---

{{ APIRef("HTML DOM") }}

The
**`dateTime`** property of the {{domxref("HTMLModElement")}} interface is a string containing a machine-readable date with an optional
time value. It reflects the [`datetime`](/en-US/docs/Web/HTML/Element/time#datetime) HTML attribute of the {{HTMLElement("del")}} and {{HTMLElement("ins")}} elements.

## Value

A string. For valid string formats, see the [`datetime` valid values](/en-US/docs/Web/HTML/Element/time#valid_datetime_values).

## Examples

Given the following HTML:

```html
<p>The paragraph <del datetime="2021-11-01">has been</del> changed</p>
```

We can get the value of the `dateTime` attribute:

```js
const deletion = document.querySelector("del");
console.log(deletion.dateTime); // "2021-11-01"
```

We can also set the `dateTime` property. Here, we create an element, set the `dateTime` to the current date, add content, then insert it after the deleted text:

```js
const = document.createElement("ins");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const = document.createElement("ins");
const el2 = document.createElement("ins");

const now = new Date();
el2.dateTime = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()}`;
el2.innerHTML = " was"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't use innerHTML for setting text.

el1.insertAdjacentElement("afterend", el2);
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not really clear to me what this example is trying to do. Is it supposed to follow on from the previous example? In that case presumably el1 should be deletion.

Perhaps making this whole thing into a live sample, where the user can show the value of both attributes, might help? You could have an example which starts out with something like:

<p>This paragraph <span>can be</span> changed.</p>

...and have a button to change it:

<p>This paragraph
  <del datetime=the-date>can be</del>
  <ins datetime=the-date>has been</ins> changed.</p>

...and have a button to show the values. And another button a reset so they can try again.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also if el1 should be deletion maybe el2 should be insertion? Or maybe deletedText and insertedText?


## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}

## See also

- {{HTMLElement("del")}}
- {{HTMLElement("ins")}}
- {{domxref("HTMLModElement")}}
- {{domxref("HTMLModElement.cite")}}
- {{domxref("HTMLTimeElement.dateTime")}}
- [Date strings](/en-US/docs/Web/HTML/Date_and_time_formats#date_strings)
- [Local date and time strings](/en-US/docs/Web/HTML/Date_and_time_formats#local_date_and_time_strings)
- {{jsxref("Date")}}
- {{domxref("Element.insertAdjacentElement()")}}
9 changes: 6 additions & 3 deletions files/en-us/web/api/htmltimeelement/datetime/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ browser-compat: api.HTMLTimeElement.dateTime
{{ APIRef("HTML DOM") }}

The
**`HTMLTimeElement.dateTime`**
property is a string that reflects the [`datetime`](/en-US/docs/Web/HTML/Element/time#datetime) HTML attribute, containing a machine-readable form of the element's date and
**`dateTime`**
property of the {{domxref("HTMLTimeElement")}} interface is a string that reflects the [`datetime`](/en-US/docs/Web/HTML/Element/time#datetime) HTML attribute, containing a machine-readable form of the element's date and
time value.

## Value
Expand All @@ -36,4 +36,7 @@ t.dateTime = "6w 5h 34m 5s";

## See also

- The {{domxref("HTMLTimeElement")}} interface it belongs to.
- {{domxref("HTMLTimeElement")}}
- {{domxref("HTMLModElement.dateTime")}}
- [Date strings](/en-US/docs/Web/HTML/Date_and_time_formats#date_strings)
- [Local date and time strings](/en-US/docs/Web/HTML/Date_and_time_formats#local_date_and_time_strings)