input (type=week) element

If you don't know what an element is or how you must use it, I recommend you read the "HTML tags and attributes" tutorial that you can find in the HTML tutorials section.

Description

The input element, having the "week" value in its type attribute, represents a field for a week input. In supporting browsers, these fields could be represented by controls that enable users to change its value in a graphical way (like, for example, a calendar), instead of having to input it directly as a string.

Upon submission, supporting browsers convert the input data into a string representing a week. The rules to compose a valid week are described below.

Weeks

A week syntax is composed by:

  1. A week-year (a bit different to regular years, delimited by the limits of weeks) greater than zero, consisting of at least four digits.
  2. A minus sign or hypen character ("-").
  3. A capital letter W.
  4. Two digits representing the week number, between 1 and the maximum number of weeks present in this particular year, being either 52 or 53.

A week in this model is considered as a seven-day period starting on a Monday. The first week of a year is the one that has the first Thursday.

Example

<time>1986-W03</time>
<time>2014-W52</time>

Browser support for week fields is very low. To improve compatibility, authors may have to rely on scripts to provide advanced controls and to check values conformance before submission.

The min and max attributes may be used in this element to set a range of valid weeks the user will be able to submit.

Examples

In the first example we'll only create a form with a week control. Here you'll be able to note the functionality provided by your browser (if any) for the control.

<form action="../../form-result.php" target="_blank">
  <p>Select a week: <input type="week" name="aweek"> <input type="submit" value="Send data"></p>
</form>

Select a week:

In our second example we'll provide a list of suggested values using the datalist element, so the user can quickliy pick up one of the predefined values when the browser suggests them. The control will be linked to the datalist because of the matching between the id attribute in the list and the list attribute in the control.

Browser support for datalist is incomplete. Authors may have to rely on scripts to provide this functionality cross-browser.

The values provided by the datalist element must conform with the requirements of week strings.

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Choose a week for your vacation: <input type="week" name="vacationweek" list="vacationweekslist">
    <input type="submit" value="Send data">
  </p>
</form>
<datalist id="vacationweekslist">
  <option value="2015-W53">
  <option value="2015-W01">
  <option value="2016-W02">
  <option value="2016-W03">
  <option value="2016-W04">
</datalist>

Choose a week for your vacation:

In our last example we'll be working with the attributes min, max and step to put restrictions to the values the user can input. With this configuration we're setting a minimum week, a maximum week, and the distance between a selectable week and the following, respectively. More specifically, we'll only allow the user to pick any pair week between 2015-W06 and 2015-W24.

When the step attribute is present, authors should specify a week to be taken as initial step. This can be done through the attributes min and value. When both are present, the min attribute takes precedence.

The values provided in the attributes min, max and step must conform with the requirements of week strings.

<form action="../../form-result.php" target="_blank">
  <p>
    Select a week: <input type="week" name="selectedweek" min="2015-W06" max="2015-W24" step="2">
    <input type="submit" value="Send data">
  </p>
</form>

Select a week:

Attributes

Specific attributes

autocomplete

The autocomplete attribute provides information about if and how browsers should automatically suggest options for this control, as an attempt to guess what the user is typing. There are three possible values for this attribute:

  • The value on value, indicating the browser that it should suggest options automatically but not providing any further information about what kind of data is expected in the control.
  • The value off, indicating the browser that it shouldn't suggest options automatically, either because the control's input data is particularly sensitive (like the user to login in a very secure area) or because it's a value that will never be reused (like a one-time-key in a registration process).
  • An autofill detail tokens list, indicating the browser that it should suggest options automatically and specifying what kind of value is expected.

An autofill detail tokens list can be composed by the following tokens in the specified order.

  1. Optionally, a token beginning with the string "section-" (case-insentsitive), indicating the named group to which the field belongs.
  2. Optionally, one of the two following tokens (case-insentsitive):
    • shipping: the field is part of the shipping address.
    • billing: the field is part of the billing address.
  3. Optionally, a token that is a case-insensitive match for one of the following strings:
    • home: meaning the field is for contacting someone at their residence.
    • work: meaning the field is for contacting someone at their workplace.
    • mobile: meaning the field is for contacting someone at their mobile device.
    • fax: meaning the field describes a fax machine's contact details.
    • pager: meaning the field describes a pager's or beeper's contact details

Browsers usually perform autofilling operations by retrieving data from a database containing previous inputs or other sources of user information.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Desired arrival: <input type="week" name="desired-arrival" autocomplete="section-annasgift shipping">
    <input type="submit" value="Send">
  </p>
</form>

Desired arrival:

autofocus

A boolean value instructing the browser to set the focus to this control when the document has finished loading or when the dialog where the control finds itself is shown. If the attribute has the value "autofocus" or the empty string (""), or if it's just present, the control should get the focus as soon as possible, after the page or dialog has been loaded.

Example

<p>Join the class in: <input type="week" name="joinweek" autofocus></p>

disabled

A boolean value indicating wether the control is disabled or not. If the attribute takes the value "disabled" or the empty string (""), or if it's just present, the control will be disabled.

Disabled controls are rendered greyed out (if visible), are blocked from user interaction and, more importantly, their values (if any) aren't sent when the form is submitted.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Begin on: <input type="week" name="beginweek" disabled>
    <input type="submit" value="Send data">
  </p>
</form>

Begin on:

form

The value of the id attribute of the form with which this control is associated to.

This attribute is new in HTML5 and helps defining the pertenence of controls in nested or distant forms.

Example

<p>Departure on: <input type="week" name="departureweek" form="form1"></p>
<form id="form1" action="../../form-result.php" method="post" target="_blank">
  <p><input type="submit" value="Send data"></p>
</form>

Departure on:

list

A token matching the value of the id attribute of the datalist this control is assopciated with. The datalist referenced by this attribute will provide a number of suggestions that users can pick to autocomplete the control.

Browser support for datalist is incomplete. Authors may have to rely on scripts to provide this functionality cross-browser.

The values provided by the datalist element must conform with the requirements of week strings.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Adventure begins on: <input type="week" name="adventureweek" list="adventureweekslist">
    <input type="submit" value="Send data">
  </p>
</form>
<datalist id="adventureweekslist">
  <option value="2015-W30">
  <option value="2015-W31">
  <option value="2016-W01">
  <option value="2016-W02">
</datalist>

Adventure begins on:

max

The maximum week the user should be able to pick. Supporting browsers are supposed to disallow the selection of any date greater than the one specified in this attribute.

The value provided in this attribute must conform with the requirements of week strings.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Stop warnings until: <input type="week" name="stopuntil" max="2016-W01">
    <input type="submit" value="Send data">
  </p>
</form>

Stop warnings until:

min

The minimum week the user should be able to pick. Supporting browsers are supposed to disallow the selection of any week less than the one specified in this attribute.

The value provided in this attribute must conform with the requirements of week strings.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Send messages from: <input type="week" name="sendfrom" min="2016-W02">
    <input type="submit" value="Send data">
  </p>
</form>

Send messages from:

name

A name for the control. This name will be sent by the browser to the processing agent, paired with the content of the value attribute. Both attributes together will conform a name-value pair that will be used to process the form data.

Currently, the value isindex, formerly used in a special way by some browsers and included in the HTML standard, isn't permitted in this attribute.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Graduation party week: <input type="week" name="graduationpartyweek">
    <input type="submit" value="Send data">
  </p>
</form>

Graduation party week:

readonly

A boolean value instructing the browser to prevent the user from changing the control's value. If this attribute has the value "readonly" or the empty string (""), or if it's just present, the user won't be allowed to change the value in the control.

Although this attribute prevents the control's value from being edited, not all interaction is blocked: users will still be able to select and copy the text in the control.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Suscribed since: <input type="week" name="subscriptionweek" value="2003-W05" readonly>
    <input type="submit" value="Send data">
  </p>
</form>

Suscribed since:

required

A boolean value indicating wether this control can be left empty or not. If this attribute has the value "required" or the empty string (""), or if it's just present, the user will have to fill the control in order to be able to submit the form.

If a control with the required attribute present is left blank, supporting browsers will throw an error upon submission and cancel the process immediately.

Browser support for the attribute required is incomplete. Authors may have to rely on scripts to provide this functionality cross-browser.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Member since: <input type="week" name="membersince" required>
    <input type="submit" value="Send data">
  </p>
</form>

Member since:

step

A number of days to be used as the amount of space between an allowed value and the next one. The presence of this attribute reduces the number of choices the user will have by restricting the selection of intermediate values.

The special value any removes the default restriction over the granularity of the control and allows users to input values as specific as they want.

To avoid unexpected behaviors, authors should specify a week to be taken as initial step. This can be done through the attributes min and value. When both are present, the min attribute takes precedence.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Last vacations: <input type="week" name="lastvacations" step="4" min="2000-W01">
    <input type="submit" value="Send data">
  </p>
</form>

Last vacations:

type

A value indicating the type of the field that this element represents. There are twenty two possible values (case-insensitive):

  • hidden: a hidden control used to send information to the server, typically managed by scripts.
  • text: a control used to input a single-line piece of text.
  • search: same as text but for search purposes.
  • tel: a control used to provide a telephone number.
  • url: a text box used to input a single and absolute URL.
  • email: a control designed to edit one or more e-mail addresses.
  • password: a text box for editing passwords, where the characters are represented by dots.
  • date: a control to input a specific date.
  • month: a control to input a specific month.
  • week: a control to input a specific week.
  • time: a control to input a specific time.
  • datetime-local: a control to input a specific local date and time.
  • number: a control to input a number.
  • range: a control to input one or two numbers inside a range.
  • color: a control to input a color.
  • checkbox: a control to input a boolean value (true/false).
  • radio: a control used to choose one single option among many.
  • file: a control used to upload files to the server.
  • submit: a button used to submit the form.
  • image: same as submit but with the ability to be shown as an image instead of using the default button appearance.
  • reset: a button used to reset the form's controls to their default values.
  • button: a button with no default action associated.

When this attribute isn't present, the element behaves as it would have the value "text".

Example

<input type="week" name="starton">

value

An initial value for the control, that will be set when the page loads and when the reset button is pressed.

The value provided in this attribute must conform with the requirements of week strings.

Example

<form action="../../form-result.php" method="post" target="_blank">
  <p>Send me alerts on: <input type="week" name="alerts" value="2016-W02"></p>
  <p>
    <input type="submit" value="Send data">
    <input type="reset" value="Reset form">
  </p>
</form>

Send me alerts on:

Global attributes

For information about global attributes refer to this list of global attributes in HTML5.

Events

Global events

For information about global events refer to this list of global events in HTML5.