پرش به مطلب اصلی

Checkbox

کامپوننت x-checkbox برای نمایش و مدیریت چک‌باکس‌های فرم با امکانات پیشرفته و قابل شخصی‌سازی استفاده می‌شود. این کامپوننت از ویژگی‌هایی مانند نمایش لیبل، حالت فقط‌خواندنی، غیرفعال، پیام راهنما، نمایش خطا و کنترل ظاهر و رفتار پشتیبانی می‌کند.


ویژگی‌ها

  • پشتیبانی از لیبل اصلی و لیبل گزینه (optionLabel)
  • امکان تعیین مقدار اولیه (checked) و مقدار دلخواه (value)
  • قابلیت فقط‌خواندنی (readonly) و غیرفعال (disabled)
  • پشتیبانی از نمایش پیام راهنما (tooltip) و پیام غیرفعال بودن (disabledTooltip)
  • امکان تعیین جهت نمایش (افقی یا عمودی) با پراپ orientation
  • نمایش پیام خطا و پیام‌های سفارشی با استایل‌های مختلف
  • امکان شخصی‌سازی کلاس‌های CSS برای خود چک‌باکس و کانتینر

ورودی‌های کامپوننت

نام پراپنوع دادهمقدار پیش‌فرضتوضیحات
namestringنام فیلد (اجباری)
labelstringnullلیبل اصلی چک‌باکس
labelSpaceReservedboolfalseآیا فضای لیبل حتی بدون مقدار رزرو شود؟
idstringnullشناسه یکتا برای چک‌باکس
optionLabelstringnullلیبل کنار خود چک‌باکس (معمولاً سمت راست)
checkedboolfalseآیا چک‌باکس به‌صورت پیش‌فرض تیک خورده باشد؟
readonlyboolfalseفقط‌خواندنی بودن چک‌باکس
disabledboolfalseغیرفعال بودن چک‌باکس
requiredboolfalseاجباری بودن فیلد
valuestringnullمقدار ارسالی چک‌باکس در صورت انتخاب
classstringnullکلاس CSS سفارشی برای خود چک‌باکس
containerClassstringnullکلاس CSS سفارشی برای کانتینر
messageStylestring"message"استایل نمایش پیام (message, tooltip, ...)
defaultMessageTypestring"info"نوع پیام پیش‌فرض (info, error, success, ...)
defaultMessagestringnullپیام پیش‌فرض برای نمایش
tooltipstringnullپیام راهنما هنگام هاور روی چک‌باکس
disabledTooltipstringnullپیام راهنما هنگام غیرفعال بودن چک‌باکس
suppressLogicMessagesboolfalseعدم نمایش پیام‌های منطقی
orientationstring"vertical"جهت نمایش: vertical (ستونی) یا horizontal (سطری)

مثال‌ها

نمونه پایه

<x-checkbox
name="terms"
id="terms2"
label="شرایط و ضوابط"
optionLabel="من با شرایط و ضوابط موافقم"
tooltip="test"
/>

<x-checkbox
name="terms"
id="terms"
label="شرایط و ضوابط"
optionLabel="من با شرایط و ضوابط موافقم"
:checked="true"
:readonly="false"
:disabled="true"
class="custom-checkbox"
containerClass="my-custom-container"
defaultMessage="لطفا حداقل یک اندازه را انتخاب کنید."
defaultMessageType="warning"
messageStyle="message"
required="true"
tooltip="test"
/>