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

Radio Group

کامپوننت x-radio-group برای نمایش و مدیریت گروهی از دکمه‌های رادیویی (Radio) در فرم‌ها با امکانات پیشرفته و قابل شخصی‌سازی استفاده می‌شود. این کامپوننت امکان نمایش لیبل، حالت فقط‌خواندنی، غیرفعال، پیام راهنما، پیام خطا، کنترل ظاهر و رفتار، و مدیریت گزینه‌های مختلف را فراهم می‌کند.


ویژگی‌ها

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

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

نام پراپنوع دادهمقدار پیش‌فرضتوضیحات
namestringنام فیلد (اجباری)
optionsarrayآرایه‌ای از گزینه‌ها. هر گزینه باید شامل value و label باشد.
labelstringnullلیبل اصلی گروه رادیوها
labelSpaceReservedboolfalseآیا فضای لیبل حتی بدون مقدار رزرو شود؟
idstringnullشناسه یکتا برای گروه رادیو
checkedstringnullمقدار انتخاب‌شده اولیه
classstringnullکلاس CSS سفارشی برای رادیوها
containerClassstringnullکلاس CSS سفارشی برای کانتینر
wrapperClassstringnullکلاس CSS سفارشی برای رپپر داخلی
gapstringnullفاصله بین گزینه‌های رادیو
optionClassstringnullکلاس CSS سفارشی برای هر گزینه
labelClassstringnullکلاس CSS سفارشی برای لیبل اصلی گروه
readonlyboolfalseفقط‌خواندنی بودن کل گروه
disabledboolfalseغیرفعال بودن کل گروه
requiredboolfalseاجباری بودن فیلد
hintstringnullپیام راهنما یا توضیح کوتاه
messageStylestring/enum"message"استایل نمایش پیام (message, tooltip, ...)
defaultMessageTypestring/enum"success"نوع پیام پیش‌فرض (success, error, info, warning, ...)
defaultMessagestringnullپیام پیش‌فرض برای نمایش
suppressLogicMessagesboolfalseعدم نمایش پیام‌های منطقی
tooltipstringnullپیام راهنما هنگام هاور روی گروه
disabledTooltipstringnullپیام راهنما هنگام غیرفعال بودن گروه
modestring"horizontal"حالت نمایش (افقی یا عمودی)
orientationstring"vertical"جهت نمایش: vertical (ستونی) یا horizontal (سطری)

ساختار هر گزینه در options:

کلیدنوع دادهتوضیحات
valuestringمقدار گزینه (اجباری)
labelstringمتن نمایشی گزینه (اجباری)
tooltipstringپیام راهنما هنگام هاور روی گزینه (اختیاری)
disabledboolغیرفعال بودن گزینه (اختیاری)
readonlyboolفقط‌خواندنی بودن گزینه (اختیاری)

مثال‌ها

نمونه پایه

$options = [
['label' => 'مرد', 'value' => 'male'],
[
'label' => 'زن',
'value' => 'female',
'disabled' => 'true',
'tooltip' => 'این گزینه غیر فعال است',
],
[
'label' => 'دیگر',
'value' => 'other',
'readonly' => 'true',
'tooltip' => 'این گزینه صرفا برای نمایش می باشد',
],
];
<x-radio-group
name="gender"
id="gender"
label="یک مورد را انتخاب کنید"
required
tooltip="for radio group"
:options="$options"
checked="male"
messageStyle="toast"
defaultMessageType="success"
orientation="horizontal"
labelSpaceReserved="true"
defaultMessage="متن دیفالت"
hint="یک مورد را انتخاب کنید"
class="custom-radio-class"
containerClass="custom-container-class"
wrapperClass="flex-wrap"
/>