Back
dateSelect()
Builds and returns a string containing three select
form controls for month, day, and year based on the supplied objectName
and property
.
Name | Type | Required | Default | Description |
---|---|---|---|---|
objectName | any | No | The variable name of the object to build the form control for. | |
property | string | No | The name of the property to use in the form control. | |
association | string | No | The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. | |
position | string | No |
The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.
|
|
order | string | No | month, day, year |
Use to change the order of or exclude date select tags.
|
separator | string | No | ||
startYear | numeric | No | 2018 |
First year in select list.
|
endYear | numeric | No | 2028 |
Last year in select list.
|
monthDisplay | string | No | names | Pass in names, numbers, or abbreviations to control display. |
monthNames | string | No | January, February, March, April, May, June, July, August, September, October, November, December | |
monthAbbreviations | string | No | Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec | |
includeBlank | any | No | false |
Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
|
label | string | No | false | The label text to use in the form control. |
labelPlacement | string | No | around |
Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight .
|
prepend | string | No | String to prepend to the form control. Useful to wrap the form control with HTML tags. | |
append | string | No | String to append to the form control. Useful to wrap the form control with HTML tags. | |
prependToLabel | string | No | String to prepend to the form control's label. Useful to wrap the form control with HTML tags. | |
appendToLabel | string | No | String to append to the form control's label. Useful to wrap the form control with HTML tags. | |
errorElement | string | No | span | HTML tag to wrap the form control with when the object contains errors. |
errorClass | string | No | field-with-errors |
The class name of the HTML tag that wraps the form control when there are errors.
|
combine | boolean | No | Set to false to not combine the select parts into a single DateTime object. | |
encode | any | No | true |
Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.
|
Example 1: Basic usage
#dateSelect(objectName="user", property="dateOfBirth")#
Outputs month/day/year selects for the user.dateOfBirth property.
---
Example 2: Only month and year (no day)
#dateSelect(objectName="order", property="expirationDate", order="month,year")#
Useful for credit card expiration dates.
Only month and year dropdowns appear.
---
Example 3: Custom year range
#dateSelect(objectName="event", property="eventDate", startYear=2000, endYear=2030)#
Dropdown shows years 2000–2030.
---
Example 4: Custom month display
#dateSelect(objectName="user", property="anniversary", monthDisplay="abbreviations")#
Months display as Jan, Feb, Mar… instead of full names.
---
Example 5: Include blank options
#dateSelect(objectName="profile", property="graduationDate", includeBlank="- Select Date -")#
Adds a blank option at the top of each select with the label - Select Date -.
---
Example 6: Using labels and custom HTML
#dateSelect(objectName="employee", property="hireDate", label="Hire Date", labelPlacement="before", prepend="<div class='date-wrapper'>", append="</div>")#
Adds a label and wraps selects inside a div for styling.
Copied!