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

Editor

کامپوننت x-editor یک ویرایشگر متنی پیشرفته (WYSIWYG) برای فرم‌ها است که از ویرایشگرهای CKEditor و TinyMCE پشتیبانی می‌کند و امکانات متنوعی برای شخصی‌سازی ظاهر، ابزارها، شمارشگر کاراکتر، حالت ساده یا کامل و ... را ارائه می‌دهد.


ویژگی‌ها

  • پشتیبانی از دو نوع ویرایشگر: CKEditor و TinyMCE (type)
  • حالت کامل یا ساده برای ویرایشگر (mode)
  • امکان تعیین ابزارهای سفارشی و تنظیمات پیشرفته (toolbar, config)
  • شمارشگر تعداد کاراکتر و محدودیت طول متن (showCharacterCount, maxLength)
  • قابلیت تنظیم placeholder برای ویرایشگر
  • پشتیبانی از auto resize (افزایش خودکار ارتفاع)
  • نمایش پیام راهنما هنگام غیرفعال بودن (disabledTooltip)
  • نمایش پیام خطا و پیام‌های سفارشی با استایل‌های مختلف
  • امکان شخصی‌سازی کلاس‌های CSS برای خود و کانتینر
  • پشتیبانی از پیام راهنما (hint)
  • کنترل نمایش پیام‌های منطقی (suppressLogicMessages)
  • پشتیبانی از لیبل و فضای رزرو لیبل

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

نام پراپنوع دادهمقدار پیش‌فرضتوضیحات
namestringنام فیلد (اجباری)
labelstringnullلیبل اصلی ویرایشگر
labelSpaceReservedboolfalseآیا فضای لیبل حتی بدون مقدار رزرو شود؟
idstringnullشناسه یکتا برای ویرایشگر
placeholderstringnullplaceholder برای ویرایشگر
classstringnullکلاس CSS سفارشی برای خود ویرایشگر
containerClassstringnullکلاس CSS سفارشی برای کانتینر
requiredboolfalseاجباری بودن فیلد
disabledboolfalseغیرفعال بودن ویرایشگر
defaultMessagestringnullپیام پیش‌فرض برای نمایش
messageStylestring/enum"message"استایل نمایش پیام (message, tooltip, ...)
defaultMessageTypestring/enum"info"نوع پیام پیش‌فرض (info, error, success, ...)
hintstringnullپیام راهنما یا توضیح کوتاه
suppressLogicMessagesboolfalseعدم نمایش پیام‌های منطقی
typestring"ckeditor"نوع ویرایشگر: ckeditor یا tinymce
modestring"full"حالت ویرایشگر: full (کامل) یا simple (ساده)
toolbararraynullآرایه ابزارهای سفارشی برای ویرایشگر
configarraynullتنظیمات پیشرفته ویرایشگر (مطابق مستندات CKEditor/TinyMCE)
showCharacterCountbooltrueنمایش شمارشگر تعداد کاراکتر
maxLengthintnullحداکثر تعداد کاراکتر مجاز
autoResizeboolfalseافزایش خودکار ارتفاع ویرایشگر
disabledTooltipstringnullپیام راهنما هنگام غیرفعال بودن ویرایشگر

مثال‌ها

نمونه پایه

<x-editor
name="editor-test-3"
type="ckeditor"
label="ادیتور ckeditor"
defaultMessage="لطفا متن مورد نظر را وارد نمایید."
hint="شما باید متن مورد نظر را وارد کنید."
placeholder="متن مورد نظر را وارد کنید"
mode="full"
:config="[
'fontSize' => [
'options' => [8, 9, 10],
],
]"
/>