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.

Sign up for GitHub

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

[Calendar] Document usage scope of format tokens #524

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

[Calendar] Document usage scope of format tokens #524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b609719
[Calendar] Document usage scope of format tokens
dreaming-augustin Dec 23, 2024
da466bb
[Calendar] Capitalize: JavaScript Date object
dreaming-augustin Dec 23, 2024
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
22 changes: 14 additions & 8 deletions server/documents/modules/calendar.html.eco
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,8 @@ themes : ['Default']
<div class="example" data-since="2.9.0">
<h4 class="ui header">Custom format</h4>
<p>You can entirely change the date format by using a token string formatter.</p>
<p>The format is applied to the calendar cells.</p>
<p>These same tokens can be used to format the date gotten through <a href="#/usage>behaviors</a>.</p>
Comment on lines +342 to +343
Copy link
Member

Choose a reason for hiding this comment

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

This is wrong. The format token is not only applied to the calendar cells but for several date outputs mentioned as tokens in the settings
image

<p>
Tokens are placeholder characters for a specific output format. Fomantic-UI supports the following tokens:
<table class="ui celled table">
Expand Down Expand Up @@ -982,8 +984,9 @@ themes : ['Default']
<td>Clear the selected date</td>
</tr>
<tr>
<td>get date</td>
<td>Get the selected date</td>
<td>get date(format = '')</td>
<td>Get the selected date.
If <code>format</code> is omitted, a JavaScript Date object is returned, otherwise a <a href="/modules/calendar.html#custom-format">formatted string</a> is returned.</td>
</tr>
<tr>
<td>set date(date, updateInput = true, fireChange = true)</td>
Expand All @@ -998,24 +1001,27 @@ themes : ['Default']
<td>Set the current selection mode (<code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>minute</code>)</td>
</tr>
<tr>
<td>get startDate</td>
<td>Get the start date for range selection</td>
<td>get startDate(format = '')</td>
<td>Get the start date for range selection.
If <code>format</code> is omitted, a JavaScript Date object is returned, otherwise a <a href="/modules/calendar.html#custom-format">formatted string</a> is returned.</td>
</tr>
<tr>
<td>set startDate(date)</td>
<td>Set the start date for range selection</td>
</tr>
<tr>
<td>get endDate</td>
<td>Get the end date for range selection</td>
<td>get endDate(format = '')</td>
<td>Get the end date for range selection.
If <code>format</code> is omitted, a JavaScript Date object is returned, otherwise a <a href="/modules/calendar.html#custom-format">formatted string</a> is returned.</td>
</tr>
<tr>
<td>set endDate(date)</td>
<td>Set the end date for range selection</td>
</tr>
<tr>
<td>get focusDate</td>
<td>Get the currently focused date</td>
<td>get focusDate(format = '')</td>
<td>Get the currently focused date.
If <code>format</code> is omitted, a JavaScript Date object is returned, otherwise a <a href="/modules/calendar.html#custom-format">formatted string</a> is returned.</td>
</tr>
<tr>
<td>set focusDate(date)</td>
Expand Down