web-components.html-data.json

{
	"version": 1.1,
	"tags": [
		{
			"name": "relative-time",
			"description": "A relative time-ago-in-words description can be generated by using the `relative-time` element extension.\n\nAdd a `<relative-time>` element to your markup. Provide a default formatted date as the element's text content (e.g. April 1, 2014).\n\n``` html\n<relative-time datetime=\"2014-04-01T16:30:00-08:00\">\n  April 1, 2014\n</relative-time>\n```\n\nDepending on how far in the future this is being viewed, the element's text will be replaced with one of the following formats:\n\n- 6 years from now\n- 20 days from now\n- 4 hours from now\n- 7 minutes from now\n- just now\n- 30 seconds ago\n- a minute ago\n- 30 minutes ago\n- an hour ago\n- 20 hours ago\n- a day ago\n- 20 days ago\n- on Apr 1, 2014\n\nSo, a relative date phrase is used for up to a month and then the actual date is shown.",
			"references": [
				{
					"name": "GitHub",
					"url": "https://github.com/github/time-elements#relative-time"
				},
				{
					"name": "WebComponents",
					"url": "https://www.webcomponents.org/element/time-elements#relative-time"
				},
				{
					"name": "NPM",
					"url": "https://www.npmjs.com/package/@github/time-elements#relative-time"
				}
			],
			"attributes": [
				{
					"name": "datetime",
					"description": "Value Type: ISO 8601 date.\nDescription: Required date of element such as `2014-06-01T13:05:07Z`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "year",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format year as `14` or `2014`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "month",
					"description": "Value Type: short, long\nDescription: Format month as `Jun` or `June`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "day",
					"description": "Value Type: 2-digit, numeric\nDescription: Format day as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "weekday",
					"description": "Value Type: short, long\nDescription: Format weekday as `Sun` or `Sunday`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "hour",
					"description": "Value Type: 2-digit, numeric\nDescription: Format hour as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "minute",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format minute as `05` or `5`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "second",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format second as `07` or `7`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "time-zone-name",
					"description": "Value Type: short, long\nDescription: Display time zone as `GMT+1` or by its full name",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				}
			]
		},
		{
			"name": "time-until",
			"description": "You can use `time-until` to always display a relative date that's in the future. It operates much like `<relative-time>`, except in the reverse, with past events shown as `just now` and future events always showing as relative:\n\n- 10 years from now\n- 20 days from now\n- 6 hours from now\n- 20 minutes from now\n- 30 seconds from now\n- just now\n\nAdd a `<time-until>` element to your markup. Provide a default formatted date as the element's text content (e.g. April 1, 2024).\n\n```html\n<time-until datetime=\"2024-04-01T16:30:00-08:00\">\n  April 1, 2024\n</time-until>\n```\n",
			"references": [
				{
					"name": "GitHub",
					"url": "https://github.com/github/time-elements#time-until"
				},
				{
					"name": "WebComponents",
					"url": "https://www.webcomponents.org/element/time-elements#time-until"
				},
				{
					"name": "NPM",
					"url": "https://www.npmjs.com/package/@github/time-elements#time-until"
				}
			],
			"attributes": [
				{
					"name": "datetime",
					"description": "Value Type: ISO 8601 date.\nDescription: Required date of element such as `2014-06-01T13:05:07Z`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "year",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format year as `14` or `2014`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "month",
					"description": "Value Type: short, long\nDescription: Format month as `Jun` or `June`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "day",
					"description": "Value Type: 2-digit, numeric\nDescription: Format day as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "weekday",
					"description": "Value Type: short, long\nDescription: Format weekday as `Sun` or `Sunday`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "hour",
					"description": "Value Type: 2-digit, numeric\nDescription: Format hour as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "minute",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format minute as `05` or `5`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "second",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format second as `07` or `7`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "time-zone-name",
					"description": "Value Type: short, long\nDescription: Display time zone as `GMT+1` or by its full name",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				}
			]
		},
		{
			"name": "time-ago",
			"description": "An *always* relative time-ago-in-words description can be generated by using the `time-ago` element extension. This is similar to the `relative-time` extension. However, this will never switch to displaying the date. It strictly shows relative date phrases, even after a month has passed.\n\n```html\n<time-ago datetime=\"2012-04-01T16:30:00-08:00\">\n  April 1, 2014\n</time-ago>\n```\n\nFor example, if this markup is viewed two years in the future, the element's text will read `2 years ago`.",
			"references": [
				{
					"name": "GitHub",
					"url": "https://github.com/github/time-elements#time-ago"
				},
				{
					"name": "WebComponents",
					"url": "https://www.webcomponents.org/element/time-elements#time-ago"
				},
				{
					"name": "NPM",
					"url": "https://www.npmjs.com/package/@github/time-elements#time-ago"
				}
			],
			"attributes": [
				{
					"name": "format",
					"description": "The optional `format=\"micro\"` attribute shortens the descriptions to 1m, 1h, 1d, 1y.\n```html\n<time-ago datetime=\"2012-04-01T16:30:00-08:00\" format=\"micro\">\n  April 1, 2014\n</time-ago>\n```",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#micro-format"
						},
						{
							"name": "WebComponents",
							"url": "https://www.webcomponents.org/element/time-elements#micro-format"
						},
						{
							"name": "NPM",
							"url": "https://www.npmjs.com/package/@github/time-elements#micro-format"
						}
					],
					"values": [
						{
							"name": "micro",
							"description": "The optional `format=\"micro\"` attribute shortens the descriptions to 1m, 1h, 1d, 1y."
						}
					]
				},
				{
					"name": "datetime",
					"description": "Value Type: ISO 8601 date.\nDescription: Required date of element such as `2014-06-01T13:05:07Z`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "year",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format year as `14` or `2014`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "month",
					"description": "Value Type: short, long\nDescription: Format month as `Jun` or `June`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "day",
					"description": "Value Type: 2-digit, numeric\nDescription: Format day as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "weekday",
					"description": "Value Type: short, long\nDescription: Format weekday as `Sun` or `Sunday`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "hour",
					"description": "Value Type: 2-digit, numeric\nDescription: Format hour as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "minute",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format minute as `05` or `5`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "second",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format second as `07` or `7`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "time-zone-name",
					"description": "Value Type: short, long\nDescription: Display time zone as `GMT+1` or by its full name",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				}
			]
		},
		{
			"name": "local-time",
			"description": "This custom time extension is useful for formatting a date and time in the user's preferred locale format.\n\n```html\n<local-time datetime=\"2014-04-01T16:30:00-08:00\"\n  month=\"short\"\n  day=\"numeric\"\n  year=\"numeric\"\n  hour=\"numeric\"\n  minute=\"numeric\">\n  April 1, 2014 4:30PM PDT\n</local-time>\n```\n\nWhen this markup is viewed in a CDT timezone, it will show `Apr 1, 2014 6:30PM`. If it's viewed in a browser with European date preferences, it will read `1 Apr 2014 18:30`.",
			"references": [
				{
					"name": "GitHub",
					"url": "https://github.com/github/time-elements#local-time"
				},
				{
					"name": "WebComponents",
					"url": "https://www.webcomponents.org/element/time-elements#local-time"
				},
				{
					"name": "NPM",
					"url": "https://www.npmjs.com/package/@github/time-elements#local-time"
				}
			],
			"attributes": [
				{
					"name": "datetime",
					"description": "Value Type: ISO 8601 date.\nDescription: Required date of element such as `2014-06-01T13:05:07Z`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "year",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format year as `14` or `2014`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "month",
					"description": "Value Type: short, long\nDescription: Format month as `Jun` or `June`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "day",
					"description": "Value Type: 2-digit, numeric\nDescription: Format day as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "weekday",
					"description": "Value Type: short, long\nDescription: Format weekday as `Sun` or `Sunday`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "hour",
					"description": "Value Type: 2-digit, numeric\nDescription: Format hour as `01` or `1`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "minute",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format minute as `05` or `5`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "second",
					"description": "Value Type: 2-digit, numeric.\nDescription: Format second as `07` or `7`",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				},
				{
					"name": "time-zone-name",
					"description": "Value Type: short, long\nDescription: Display time zone as `GMT+1` or by its full name",
					"references": [
						{
							"name": "GitHub",
							"url": "https://github.com/github/time-elements#options"
						}
					]
				}
			]
		}
	]
}