Editor
کام پوننت x-editor یک ویرایشگر متنی پیشرفته (WYSIWYG) برای فرمها است که از ویرایشگرهای CKEditor و TinyMCE پشتیبانی میکند و امکانات متنوعی برای شخصیسازی ظاهر، ابزارها، شمارشگر کاراکتر، حالت ساده یا کامل و ... را ارائه میدهد.
ویژگیها
- پشتیبانی از دو نوع ویرایشگر: CKEditor و TinyMCE (
type) - حالت کامل یا ساده برای ویرایشگر (
mode) - امکان تعیین ابزارهای سفارشی و تنظیمات پیشرفته (
toolbar,config) - شمارشگر تعداد کاراکتر و محدودیت طول متن (
showCharacterCount,maxLength) - قابلیت تنظیم placeholder برای ویرایشگر
- پشتیبانی از auto resize (افزایش خودکار ارتفاع)
- نمایش پیام راهنما هنگام غیرفعال بودن (
disabledTooltip) - نمایش پیام خطا و پیامهای سفارشی با استایلهای مختلف
- امکان شخصیسازی کلاسهای CSS برای خود و کانتینر
- پشتیبانی از پیام راهنما (
hint) - کنترل نمایش پیامهای منطقی (
suppressLogicMessages) - پشتیبانی از لیبل و فضای رزرو لیبل
ورودیهای کامپوننت
| نام پراپ | نوع داده | مقدار پیشفرض | توضیحات |
|---|---|---|---|
name | string | — | نام فیلد (اجباری) |
label | string | null | لیبل اصلی ویرایشگر |
labelSpaceReserved | bool | false | آیا فضای لیبل حتی بدون مقدار رزرو شود؟ |
id | string | null | شناسه یکتا برای ویرایشگر |
placeholder | string | null | placeholder برای ویرایشگر |
class | string | null | کلاس CSS سفارشی برای خود ویرایشگر |
containerClass | string | null | کلاس CSS سفارشی برای کانتینر |
required | bool | false | اجباری بودن فیلد |
disabled | bool | false | غیرفعال بودن ویرایشگر |
defaultMessage | string | null | پیام پیشفرض برای نمایش |
messageStyle | string/enum | "message" | استایل نمایش پیام (message, tooltip, ...) |
defaultMessageType | string/enum | "info" | نوع پیام پیشفرض (info, error, success, ...) |
hint | string | null | پیام راهنما یا توضیح کوتاه |
suppressLogicMessages | bool | false | عدم نمایش پیامهای منطقی |
type | string | "ckeditor" | نوع ویرایشگر: ckeditor یا tinymce |
mode | string | "full" | حالت ویرایشگر: full (کامل) یا simple (ساده) |
toolbar | array | null | آرایه ابزارهای سفارشی برای ویرایشگر |
config | array | null | تنظیمات پیشرفته ویرایشگر (مطابق مستندات CKEditor/TinyMCE) |
showCharacterCount | bool | true | نمایش شمارشگر تعداد کاراکتر |
maxLength | int | null | حداکثر تعداد کاراکتر مجاز |
autoResize | bool | false | افزایش خودکار ارتفاع ویرایشگر |
disabledTooltip | string | null | پیام راهنما هنگام غیرفعال بودن ویرایشگر |
مثالها
نمونه پایه
<x-editor
name="editor-test-3"
type="ckeditor"
label="ادیتور ckeditor"
defaultMessage="لطفا متن مورد نظر را وارد نمایید."
hint="شما باید متن مورد نظر را وارد کنید."
placeholder="متن مورد نظر را وارد کنید"
mode="full"
:config="[
'fontSize' => [
'options' => [8, 9, 10],
],
]"
/>