راهنمای کامل پارامترهای customization در ONLYOFFICE Docs API
فرانتاندخلاصهٔ کامل‌تر
بخش customization در ONLYOFFICE Docs API یه شیء پیکربندی‌ه که از طریق editorConfig.customization به ویرایشگر پاس داده میشه. با این پارامترها میشه تجربه کاربری ویرایشگر رو به‌دلخواه تغییر داد — از نمایش یا مخفی کردن دکمه‌ها گرفته تا شخصی‌سازی کامل ظاهر.
پارامترهای پایه‌ای و پرکاربرد:
- autosave (پیش‌فرض: true): ذخیره خودکار رو فعال یا غیرفعال می‌کنه. اگه false بشه، فقط حالت همکاری Strict قابل استفاده‌ست.
- comments و chat: نمایش دکمه‌های کامنت‌گذاری و چت رو کنترل می‌کنن. توجه کن که chat از نسخه ۷.۱ منسوخ شده و باید از document.permissions.chat استفاده کنی.
- help (پیش‌فرض: true): دکمه راهنما رو نشون می‌ده یا مخفی می‌کنه.
- compactHeader و compactToolbar: چیدمان هدر و نوار ابزار رو فشرده‌تر می‌کنن.
تنظیمات دکمه بستن ویرایشگر از طریق شیء close انجام میشه. میشه هم نمایش دکمه رو کنترل کرد و هم متن توضیحی (tooltip) اون رو تغییر داد. این دکمه فقط وقتی نمایش داده میشه که رویداد onRequestClose تعریف شده باشه.
{
visible: true,
text: "Close file",
}شیء features یه سری ویژگی قابل‌تنظیم رو در خودش داره. spellcheck غلط‌یاب رو فعال یا غیرفعال می‌کنه (فقط برای ویرایشگر سند و ارائه). tabStyle استایل تب‌های نوار ابزار رو تعیین می‌کنه: fill برای تب‌های کاملاً پر، و line برای نمایش فقط یه خط زیر تب انتخاب‌شده. tabBackground هم رنگ پس‌زمینه تب‌ها رو کنترل می‌کنه.
{
spellcheck: { mode: true },
tabStyle: { mode: "fill", change: true },
tabBackground: { mode: "header", change: true },
}پارامتر goback دکمه «بازگشت به محل فایل» رو پیکربندی می‌کنه — میشه آدرس URL، متن دکمه، و اینکه لینک در تب جدید باز بشه یا نه رو تعیین کرد. پارامتر feedback هم دکمه پشتیبانی رو مدیریت می‌کنه و میشه یه URL سفارشی بهش داد.
پارامترهای مخصوص نسخه Developer (نیاز به لایسنس Developer دارن):
- logo: لوگوی گوشه بالا-چپ ویرایشگر رو عوض می‌کنه (پشتیبانی از تم روشن، تاریک، و URL کلیک).
- customer: اطلاعات شرکت یا توسعه‌دهنده رو در بخش «درباره» ویرایشگر نشون می‌ده (نام، آدرس، ایمیل، تلفن، وب‌سایت).
- features.roles: مدیریت نقش‌ها در فرم‌های PDF رو فعال یا غیرفعال می‌کنه.
نکات کلیدی:
- بعضی پارامترها مثل autosave، compactToolbar، forcesave، و spellcheck اگه توسط کاربر در رابط ویرایشگر تغییر کنن، مقدار جدید در localStorage مرورگر ذخیره میشه و اولویتش از مقدار ارسال‌شده در API بیشتره.
- در ویرایشگر موبایل فقط پارامترهای محدودی مثل close، feedback، goback، help، logo، mobile، و uiTheme در دسترسن.
- پارامتر integrationMode: "embed" برای جاسازی ویرایشگر داخل صفحه وب استفاده میشه و اسکرول خودکار به فریم رو غیرفعال می‌کنه.
- compatibleFeatures اگه true باشه، فقط قابلیت‌های سازگار با فرمت OOXML فعال می‌مونن.
