در این مطلب قصد داریم کتابخانه‌ای با قابلیت استفاده‌ی مجدد را جهت بکارگیری «
PersianDatePicker یک DatePicker شمسی به زبان JavaScript که از تاریخ سرور استفاده می‌کند» ارائه دهیم. نکات ارائه شده‌ی در آن‌را میتوان جهت تبدیل و استفاده‌ی از تمام DatePickerهای مشابه نیز بکاربرد.
نیازهای یک ورودی تاریخ سازگار با EditForm
- باید قابلیت استفاده‌ی مجدد را داشته باشد. یعنی باید به صورت یک کامپوننت مجزا و یا به صورت یک کتابخانه‌ی مجزا ارائه شود.
- باید با سیستم اعتبارسنجی EditForm یکپارچه باشد.
- باید جنریک باشد. یعنی باید بتوان در صورت نیاز DateTime ، DateTimeOffset و DateOnly و نمونه‌های nullable آن‌هارا توسط این کامپوننت دریافت کرد و ورودی و خروجی آن رشته‌ای نباشد.
نیاز به ارث‌بری از <InputBase<T جهت ارائه‌ی کامپوننت‌هایی سازگار با EditForm
تقریبا تمام کامپوننت‌های استاندارد EditForm ارائه شده‌ی توسط Blazor، از کامپوننت پایه‌ای به نام <InputBase<T مشتق می‌شوند. این کلاس، یک کلاس abstract است که قابلیت‌های بیشتری را نسبت به یک input ساده‌ی HTML ای مانند اعتبارسنجی سازگار با EditForm ارائه می‌دهد. به همین جهت توصیه می‌شود تا اگر خواستید یک کامپوننت ورودی را برای استفاده‌ی در Blazor و EditForm آن طراحی کنید، با ارث‌بری از این کلاس شروع کنید و صرفا کار را با یک input ساده، شروع نکنید.
برای استفاده‌ی از آن، ابتدای کامپوننت Blazor ما به این صورت شروع خواهد شد:
@typeparam T
@inherits InputBase<T>
که دو متد را برای بازنویسی در اختیار ما قرار می‌دهد:
protected override bool TryParseValueFromString(
string? value,
[MaybeNullWhen(false)] out T result,
[NotNullWhen(false)] out string? validationErrorMessage)
{
// ...
}
protected override string FormatValueAsString(T? value)
{
// ...
}
علت وجود این دو متد، این است که مرورگرها، رشته‌ها را در اختیار ما قرار می‌دهند و ما باید راهی را برای تبدیل T به یک رشته و عکس آن را ارائه دهیم. با بازنویسی متد TryParseValueFromString، میتوان رشته‌ی دریافتی از کاربر را تبدیل به T کرد و اگر این تبدیل میسر نبود، با مقدار دهی validationErrorMessage، مشکل را به کاربر، با یک پیام شکست اعتبارسنجی، اعلام کرد. کار متد FormatValueAsString، تبدیل T به یک رشته‌است تا در input واقع در صفحه، نمایش داده شود. در اینجا میتوان فرمت خاصی را به شیء دریافتی اعمال و نمایش داد.
ایجاد یک کتابخانه‌ی جدید برای محصور سازی DatePicker جاوااسکریپتی
چون قصد استفاده‌ی مجدد از این کامپوننت جدید را در پروژه‌های مختلف داریم، بهتر است آن‌را تبدیل به یک «
کتابخانه‌ی Blazor» کنیم. به همین جهت کتابخانه‌ی فرضی BlazorPersianJavaScriptDatePicker.Lib را در اینجا ایجاد کرده‌ایم.
در ابتدا دو فایل PersianDatePicker.js و PersianDatePicker.css موجود و مدنظر را در پوشه‌های js و css پوشه‌ی wwwroot این کتابخانه کپی می‌کنیم. بنابراین استفاده کننده‌ی از آن، مانند پروژه‌ی blazor wasm جدیدی به نام BlazorPersianJavaScriptDatePicker، باید ارجاعاتی را به آن‌ها به صورت زیر اضافه کند:
<link href="_content/BlazorPersianJavaScriptDatePicker.Lib/css/PersianDatePicker.css" rel="stylesheet"/>
<script src="_content/BlazorPersianJavaScriptDatePicker.Lib/js/PersianDatePicker.js?v=1"></script>
همچنین در فایل Imports.razor_ آن نیز بهتر است فضای نام این کتابخانه، ذکر شود تا به سادگی بتوان از کامپوننت PersianDatePicker در آن استفاده کرد:
@using BlazorPersianJavaScriptDatePicker.Lib
شروع به پیاده سازی کامپوننت PersianDatePicker
در ادامه کامپوننت جدید PersianDatePicker.razor را به پروژه‌ی کتابخانه اضافه می‌کنیم. قسمت razor آن به صورت زیر است:
@typeparam T
@inherits InputBase<T>
<div>
<span style="cursor:pointer"
onclick="PersianDatePicker.Show(document.getElementById('@ElementId'), '@Today')">
📅
</span>
<input
@attributes="@AdditionalAttributes"
type="text" dir="ltr"
@ref="ElementReference"
name="@ElementId" id="@ElementId"
autocapitalize="off" autocorrect="off" autocomplete="off"
value="@EnteredValue"
@oninput="OnInput"/>
@if (ValueExpression is not null)
{
<ValidationMessage For="@ValueExpression"/>
}
</div>
همانطور که مشاهده می‌کنید، کار با جنریک تعریف کردن و ارث‌بری از InputBase شروع می‌شود.
در اینجا با کلیک بر روی دکمه‌ی 📅، کار فراخوانی متد PersianDatePicker.Show مربوط به datePicker جاوا اسکریپتی صورت می‌گیرد. همچنین هر طراحی را که در اینجا ارائه دهیم، قالب UI پیش‌فرض InputBase را بازنویسی می‌کند.
نیاز به دریافت تاریخ تنظیم شده‌ی توسط کدهای جاوااسکریپتی در کامپوننت Blazor
کتابخانه‌های جاوااسکریپتی با مقداردهی مستقیم textbox.
value سبب تغییر مقدار آن می‌شوند. نکته‌ی مهم اینجا است که نه فقط Blazor این تغییرات را ردیابی نمی‌کند، بلکه اگر با استفاده از متد استاندارد جاوااسکریپتی
addEventListener به تغییرات این input گوش فرا دهیم، هیچ رخدادی را مشاهده نخواهیم کرد. به همین جهت نیاز است اندکی کدهای PersianDatePicker.js را تغییر دهیم (و این مورد جهت تمام کتابخانه‌های مشابه یکسان است):
function setValue(date) {
_textBox.value = date;
// NOTE: To notify the addEventListener('change', fn)
_textBox.dispatchEvent(new Event('change'));
_textBox.focus();
hide();
try {
_textBox.onchange();
}catch(ex) {}
}
در اینجا پس از تغییر خاصیت value، باید به صورت دستی سبب بروز رخداد change شد تا addEventListenerها بتوانند این رخداد را ردیابی کنند. به همین جهت فایل مجزایی را به نام wwwroot\js\activateDatePicker.js به کتابخانه‌ی blazor اضافه می‌کنیم:
window.activateDatePicker = {
enableDatePicker: function (element, objectReference) {
element.addEventListener('change', function (evt) {
objectReference.invokeMethodAsync("OnInputFieldChanged", this.value);
});
}
};
هدف از این کدها این است که جهت element یا همان datePicker جاری، بتوان رخداد change را ثبت کرد و به تغییرات آن گوش فرا داد تا هر زمانیکه کدهای جاوا اسکریپتی datePicker سبب تغییری در خاصیت value شدند، بتوان آن‌را به کامپوننت Blazor ارسال کرد. وهله‌ای از این کامپوننت توسط objectReference در اینجا دریافت شده و سپس متد OnInputFieldChanged کامپوننت را با مقدار جدید وارد شده، فراخوانی می‌کند.
بنابراین این فایل جدید نیز باید به index.html مصرف کننده اضافه شود:
<script src="_content/BlazorPersianJavaScriptDatePicker.Lib/js/activateDatePicker.js?v=1"></script>
فعالسازی DatePicker در اولین بار نمایش کامپوننت Blazor
تا اینجا زیرساخت دریافت مقدار تنظیمی توسط کاربر را در کامپوننت Blazor فراهم کردیم. اکنون نوبت به استفاده‌ی از آن است:
public partial class PersianDatePicker<T> : IDisposable
{
private bool _isDisposed;
private DotNetObjectReference<PersianDatePicker<T>>? _objectReference;
private string ElementId { get; } = Guid.NewGuid().ToString("N");
private ElementReference? ElementReference { set; get; }
private string Today { get; } = DateTime.Now.ToShortPersianDateString();
[Inject] private IJSRuntime JsRuntime { set; get; } = default!;
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
_objectReference = DotNetObjectReference.Create(this);
await JsRuntime.InvokeVoidAsync("activateDatePicker.enableDatePicker", ElementReference, _objectReference);
EnteredValue = CurrentValueAsString;
StateHasChanged();
}
}
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
if (!_isDisposed)
{
try
{
_objectReference?.Dispose();
}
finally
{
_isDisposed = true;
}
}
}
}
- اگر دقت کرده باشید در تعاریف razor کامپوننت، "
ref="ElementReference
@ وجود دارد که یک ElementReference است و توسط آن میتوان در متد OnAfterRenderAsync، ارجاعی را به المان جاری، به کدهای جاوااسکریپتی متد enableDatePicker ارسال کرد.
- همچنین چون نمی‌خواهیم متد OnInputFieldChanged را به صورت static تعریف کنیم، نیاز است تا یک DotNetObjectReference را ایجاد و به متد enableDatePicker ارسال کرد تا توسط آن بتوان به یک instance method کلاس جاری دسترسی یافت و به سادگی مقادیر کامپوننت را تغییر داد:
[JSInvokable]
public void OnInputFieldChanged(string? value)
- در پایان کار کامپوننت، باید این DotNetObjectReference را Dispose کرد.
نیاز به تبدیل T به تاریخ رشته‌ای و برعکس
زیر ساخت تبدیلات جنریک تاریخ میلادی به شمسی در کتابخانه‌ی «
DNTPersianUtils.Core » پیش‌بینی شدهاست و فقط کافی است
از آن استفاده کنیم. با وجود این زیرساخت، تهیه‌ی کامپوننت‌های جنریک تاریخ شمسی بسیار ساده می‌شود:
public partial class PersianDatePicker<T> : IDisposable
{
private string? _enteredValue;
private string? EnteredValue
{
set => _enteredValue = value;
get => UsePersianNumbers ? _enteredValue.ToPersianNumbers() : _enteredValue;
}
[Parameter] public bool UsePersianNumbers { set; get; }
[Parameter] public string ParsingErrorMessage { get; set; } = "لطفا در ورودی {0} تاریخ شمسی معتبری را وارد نمائید.";
[Parameter] public int BeginningOfCentury { set; get; } = 1400;
private void OnInput(ChangeEventArgs e)
{
SetCurrentValue(e.Value as string);
}
private void SetCurrentValue(string? value)
{
EnteredValue = value;
CurrentValueAsString = value;
}
[JSInvokable]
public void OnInputFieldChanged(string? value)
{
SetCurrentValue(value);
}
protected override void OnInitialized()
{
base.OnInitialized();
SanityCheck();
}
protected override bool TryParseValueFromString(
string? value,
[MaybeNullWhen(false)] out T result,
[NotNullWhen(false)] out string? validationErrorMessage)
{
validationErrorMessage = string.Format(CultureInfo.InvariantCulture, ParsingErrorMessage, DisplayName);
if (!value.TryParsePersianDateToDateTimeOrDateTimeOffset(out result, BeginningOfCentury))
{
return false;
}
if (result is null)
{
throw new InvalidOperationException(validationErrorMessage);
}
validationErrorMessage = null;
return true;
}
protected override string FormatValueAsString(T? value)
{
return !string.IsNullOrWhiteSpace(EnteredValue) ? EnteredValue : value.FormatDateToShortPersianDate();
}
private void SanityCheck()
{
if (!Value.IsDateTimeOrDateTimeOffsetType())
{
throw new InvalidOperationException(
"The `Value` type is not a supported `date` type. DateTime, DateTime?, DateTimeOffset and DateTimeOffset? are supported.");
}
}
// ...
}
در اینجا قسمت نهایی و تکمیلی کامپوننت محصور کننده‌ی DatePicker را مشاهده می‌کنید که بسیار ساده‌است:
- InputBase به همراه یک خاصیت عمومی دوطرفه‌ی Value است که امکان تعریفی مانند bind-Value@ را میسر می‌کند.
- این Value به همراه یک خاصیت متناظر رشته‌ای به نام CurrentValueAsString نیز هست که در اینجا از آن استفاده می‌کنیم و کار با آن، بایندینگ دوطرفه و همچنین اعتبارسنجی خودکار و فعالسازی متدهای بازنویسی شده‌ی InputBase را میسر می‌کند.
- پیاده سازی متدهای بازنویسی شده‌ی جنریک TryParseValueFromString و FormatValueAsString، با استفاده از دو متد TryParsePersianDateToDateTimeOrDateTimeOffset و FormatDateToShortPersianDate کتابخانه‌ی «
DNTPersianUtils.Core » انجام شده‌اند و اصل کار تهیه‌ی یک کامپوننت جنریک تاریخ شمسی را انجام می‌دهند.
استفاده‌ی از کامپوننت Blazor تهیه شده
یک کامپوننت تاریخ شمسی باید بتواند تمام حالات و نوع‌های زیر را پوشش دهد که به لطف جنریک بودن کامپوننت تهیه شده، این امر میسر است:
using System.ComponentModel.DataAnnotations;
namespace BlazorPersianJavaScriptDatePicker.ViewModels;
public class InputPersianDateViewModel
{
[Required] public string Name { set; get; } = default!;
[Required] public DateTime BirthDayGregorian { set; get; } = DateTime.Now.AddYears(-40);
public DateTime? LoginAt { set; get; } = DateTime.Now.AddMinutes(-2);
[Required] public DateTimeOffset LogoutAt { set; get; }
public DateTimeOffset? RegisterAt { set; get; } = DateTimeOffset.Now.AddMinutes(-10);
}
سپس از این کامپوننت، در صفحه‌ی Index مثال پیوست به صورت زیر استفاده شدهاست:
<EditForm Model="Model" OnValidSubmit="DoSave">
<DataAnnotationsValidator/>
<div>
<label>تاریخ تولد</label>
<div>
<PersianDatePicker
@bind-Value="Model.BirthDayGregorian"
UsePersianNumbers="false"
/>
</div>
</div>
<button type="submit">ارسال</button>
</EditForm>
کدهای کامل این مطلب را از اینجا می‌توانید دریافت کنید: BlazorPersianJavaScriptDatePicker.zip 
