Editor

    Editor is rich text editor component based on Quill.

    
    import { Editor } from 'primeng/editor';
    
    

    Editor uses Quill editor underneath so it needs to be installed as a dependency.

    
    npm install quill
    
    

    A model can be bound using the standard ngModel directive.

    
    <p-editor [(ngModel)]="text" [style]="{ height: '320px' }" />
    
    

    Editor can also be used with reactive forms. In this case, the formControlName property is used to bind the component to a form control.

    
    <form [formGroup]="formGroup">
        <p-editor formControlName="text" [style]="{ height: '320px' }" />
    </form>
    
    

    When readonly is present, the value cannot be edited.

    
    <p-editor [(ngModel)]="text" [readonly]="true" [style]="{ height: '320px' }" />
    
    

    Editor provides a default toolbar with common options, to customize it define your elements inside the header element. Refer to Quill documentation for available controls.

    
    <p-editor [(ngModel)]="text" [style]="{ height: '320px' }">
        <ng-template #header>
            <span class="ql-formats">
                <button type="button" class="ql-bold" aria-label="Bold"></button>
                <button type="button" class="ql-italic" aria-label="Italic"></button>
                <button type="button" class="ql-underline" aria-label="Underline"></button>
            </span>
        </ng-template>
    </p-editor>
    
    

    Quill performs generally well in terms of accessibility. The elements in the toolbar can be tabbed and have the necessary ARIA roles/attributes for screen readers. One known limitation is the lack of arrow key support for dropdowns in the toolbar that may be overcome with a custom toolbar.