@amerandish/farsava-ckeditor

1.0.2 • Public • Published

افزونه فارس‌آوا برای CKEditor5

به کمک دستور زیر می‌توانید افزونه فارس‌آوا را نصب کنید:

npm install --save @amerandish/farsava-ckeditor

پس از نصب افزونه، نیاز است تا در CKEditor5 خود افزونه را اضافه کنید.

به عنوان مثال:

// index.js
import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import {CONSTANTS, Farsava} from "@amerandish/farsava-ckeditor";

ClassicEditor
    .create(document.querySelector('#editor'), {
        plugins: [Essentials, Paragraph, Bold, Italic, Farsava],
        toolbar: ['bold', 'italic', CONSTANTS.buttons.duration, CONSTANTS.buttons.toggle, CONSTANTS.buttons.download],
        farsavaConfig: {
            liveUrl: '<LIVE_URL>', // آدرس سرور
            apiKey: '<API_KEY>',   // توکن
        },
    })
    .then(editor => {
        console.log('Editor was initialized', editor);
    })
    .catch(error => {
        console.error(error.stack);
    });

برای استفاده نیاز است آدرس سرور و همینطور توکن خود را در بخش زیر قرار دهید:

farsavaConfig: {
    liveUrl: '<LIVE_URL>', // آدرس سرور
    apiKey: '<API_KEY>'   // توکن
}        

این افزونه شامل ۵ آیتم نمایشی است که میتوانید به صورت دلخواه در CKEditor خود قرار دهید:

عنوان متغیر کارکرد توضیحات نیازمندی
آیتم مدت زمان

CONSTANTS.buttons.duration

نمایش مدت زمان ضبط شدن صوت - -
آیتم شروع ضبط

CONSTANTS.buttons.start

شروع به ضبط کردن صوت در صورت استفاده از این آیتم نیاز است آیتم توقف ضبط هم استفاده شود.

CONSTANTS.buttons.stop

آیتم توقف ضبط

CONSTANTS.buttons.stop

توقف ضبط کردن صوت در صورت استفاده از این آیتم نیاز است آیتم شروع ضبط هم استفاده شود.

CONSTANTS.buttons.start

آیتم شروع/توقف ضبط

CONSTANTS.buttons.toggle

شروع/توقف ضبط کردن صوت در صورت استفاده از این آیتم نیازی نیست آیتم های شروع و توقف ضبط اضافه شوند -
آیتم دانلود محتوا

CONSTANTS.buttons.download

دانلود کردن متن - -

حالت های آیتم های نمایشی:

حالت عکس آیتم های نمایشی
ضبط متوقف شده/آماده به ضبط

ضبط متوقف شده/آماده به ضبط

CONSTANTS.buttons.start, CONSTANTS.buttons.toggle

ضبط متوقف شده/آماده به ضبط

ضبط متوقف شده/آماده به ضبط

CONSTANTS.buttons.stop

در حال ضبط

در حال ضبط

CONSTANTS.buttons.start, CONSTANTS.buttons.toggle

در حال ضبط

در حال ضبط

CONSTANTS.buttons.stop

در حال توقف ضبط

در حال توقف ضبط

CONSTANTS.buttons.stop, CONSTANTS.buttons.toggle

Package Sidebar

Install

npm i @amerandish/farsava-ckeditor

Weekly Downloads

2

Version

1.0.2

License

LGPL-3.0-or-later

Unpacked Size

65.1 kB

Total Files

16

Last publish

Collaborators

  • amin_amerandish