Skip to content

docs: WIP calendar resource strings #291

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

Draft
damyanpetev wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: WIP calendar resource strings #291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 73 additions & 0 deletions src/components/Blazor/CalendarResourceStrings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

namespace IgniteUI.Blazor.Controls
{
/// <summary>
/// The localized strings used by the calendar views, exposed through the <c>ResourceStrings</c>
/// property of <see cref="IgbCalendar"/> and <see cref="IgbDatePicker"/>.
/// </summary>
public partial class IgbCalendarResourceStrings : BaseRendererElement
{
public override string Type { get { return "WebCalendarResourceStrings"; } }
Expand All @@ -17,6 +21,10 @@ public IgbCalendarResourceStrings() : base()
private string _selectMonth;

partial void OnSelectMonthChanging(ref string newValue);

/// <summary>
/// Text for the accessible label of the header button that switches the calendar to the months view.

@skrustev skrustev Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe more clear would be to say it is for the "accessibility attribute aria-label", since label might mean something that's visible?

Same for SelectYear.

/// </summary>
[Parameter]
public string SelectMonth
{
Expand All @@ -34,6 +42,10 @@ public string SelectMonth
private string _selectYear;

partial void OnSelectYearChanging(ref string newValue);

/// <summary>
/// Text for the accessible label of the header button that switches the calendar to the years view.
/// </summary>
[Parameter]
public string SelectYear
{
Expand All @@ -51,6 +63,11 @@ public string SelectYear
private string _selectDate;

partial void OnSelectDateChanging(ref string newValue);

/// <summary>
/// Title shown in the calendar header until a date is selected, in single selection mode.

@skrustev skrustev Aug 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So we decide on this to be the correct functionality, since currently it is always showing Select Date/Select Range? Probably should log it?

@damyanpetev damyanpetev Aug 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I have not, which is why this is WIP and I've no idea what to do with those props yet. Kinda why I tucked this PR to the side since we need to clear what's the functionality behind these, if any

/// Defaults to <c>Select Date</c>.
/// </summary>
[Parameter]
public string SelectDate
{
Expand All @@ -68,6 +85,11 @@ public string SelectDate
private string _selectRange;

partial void OnSelectRangeChanging(ref string newValue);

/// <summary>
/// Title shown in the calendar header until a range is selected, in range selection mode.
/// Defaults to <c>Select Range</c>.
/// </summary>
[Parameter]
public string SelectRange
{
Expand All @@ -85,6 +107,13 @@ public string SelectRange
private string _selectedDate;

partial void OnSelectedDateChanging(ref string newValue);

/// <summary>
/// The label for the currently selected date.
/// </summary>
/// <remarks>
/// Not mapped to any string in the current localization pipeline and has no effect.
/// </remarks>
[Parameter]
public string SelectedDate
{
Expand All @@ -102,6 +131,11 @@ public string SelectedDate
private string _startDate;

partial void OnStartDateChanging(ref string newValue);

/// <summary>
/// Placeholder shown in the calendar header in place of the range start date until one is
/// selected. Defaults to <c>Start</c>.
/// </summary>
[Parameter]
public string StartDate
{
Expand All @@ -119,6 +153,11 @@ public string StartDate
private string _endDate;

partial void OnEndDateChanging(ref string newValue);

/// <summary>
/// Placeholder shown in the calendar header in place of the range end date until one is
/// selected. Defaults to <c>End</c>.
/// </summary>
[Parameter]
public string EndDate
{
Expand All @@ -136,6 +175,11 @@ public string EndDate
private string _previousMonth;

partial void OnPreviousMonthChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the days view one month back.

@skrustev skrustev Aug 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also "aria-lable" related.
Same for NextMonth, PreviousYear, NextYear, PreviousYears, NextYears.

/// Defaults to <c>Previous Month</c>.
/// </summary>
[Parameter]
public string PreviousMonth
{
Expand All @@ -153,6 +197,11 @@ public string PreviousMonth
private string _nextMonth;

partial void OnNextMonthChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the days view one month forward.
/// Defaults to <c>Next Month</c>.
/// </summary>
[Parameter]
public string NextMonth
{
Expand All @@ -170,6 +219,11 @@ public string NextMonth
private string _previousYear;

partial void OnPreviousYearChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the months view one year back.
/// Defaults to <c>Previous Year</c>.
/// </summary>
[Parameter]
public string PreviousYear
{
Expand All @@ -187,6 +241,11 @@ public string PreviousYear
private string _nextYear;

partial void OnNextYearChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the months view one year forward.
/// Defaults to <c>Next Year</c>.
/// </summary>
[Parameter]
public string NextYear
{
Expand All @@ -204,6 +263,11 @@ public string NextYear
private string _previousYears;

partial void OnPreviousYearsChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the years view one page back.
/// Defaults to <c>Previous {0} Years</c>, where <c>{0}</c> is the number of years on a page.
/// </summary>
[Parameter]
public string PreviousYears
{
Expand All @@ -221,6 +285,11 @@ public string PreviousYears
private string _nextYears;

partial void OnNextYearsChanging(ref string newValue);

/// <summary>
/// The label of the navigation button that moves the years view one page forward.
/// Defaults to <c>Next {0} Years</c>, where <c>{0}</c> is the number of years on a page.
/// </summary>
[Parameter]
public string NextYears
{
Expand All @@ -238,6 +307,10 @@ public string NextYears
private string _weekLabel;

partial void OnWeekLabelChanging(ref string newValue);

/// <summary>
/// The header of the week numbers column in the days view. Defaults to <c>Wk</c>.
/// </summary>
[Parameter]
public string WeekLabel
{
Expand Down
Loading