ng2-ckeditor
- Version 1.3.7
- Published
- 124 kB
- 1 dependency
- MIT license
Install
npm i ng2-ckeditor
yarn add ng2-ckeditor
pnpm add ng2-ckeditor
Overview
Angular CKEditor component
Index
Classes
CKEditorComponent
- blur
- change
- ckeditorInit()
- config
- contentDom
- debounce
- debounceTimeout
- drop
- editorChange
- fileUploadRequest
- fileUploadResponse
- focus
- host
- instance
- ngAfterViewChecked()
- ngAfterViewInit()
- ngOnChanges()
- ngOnDestroy()
- onChange
- onTouched
- ɵcmp
- ɵfac
- paste
- readonly
- ready
- registerOnChange()
- registerOnTouched()
- toolbarButtons
- toolbarGroups
- updateValue()
- value
- writeValue()
Classes
class CKButtonDirective
class CKButtonDirective implements OnInit {}
CKGroup component Usage : <ckeditor [(ngModel)]="data" [config]="{...}" debounce="500"> <ckbutton [name]="'SaveButton'" [command]="'saveCommand'" (click)="save($event)" [icon]="'/save.png'" [toolbar]="'customGroup,1'" [label]="'Save'">
property click
click: EventEmitter<CKEDITOR.editor>;
property command
command: string;
property icon
icon: string;
property label
label: string;
property name
name: string;
property ɵdir
static ɵdir: i0.ɵɵDirectiveDeclaration< CKButtonDirective, 'ckbutton', never, { label: 'label'; command: 'command'; toolbar: 'toolbar'; name: 'name'; icon: 'icon'; }, { click: 'click' }, never, never, false>;
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<CKButtonDirective, never>;
property toolbar
toolbar: string;
method initialize
initialize: (editor: CKEditorComponent) => void;
method ngOnInit
ngOnInit: () => void;
class CKEditorComponent
class CKEditorComponent implements OnChanges, AfterViewInit, OnDestroy {}
CKEditor component Usage : <ckeditor [(ngModel)]="data" [config]="{...}" debounce="500">
constructor
constructor(zone: NgZone);
Constructor
property blur
blur: EventEmitter<CKEDITOR.eventInfo>;
property change
change: EventEmitter<CKEDITOR.eventInfo>;
property config
config: CKEDITOR.config;
property contentDom
contentDom: EventEmitter<CKEDITOR.eventInfo>;
property debounce
debounce: string;
property debounceTimeout
debounceTimeout: number;
property drop
drop: EventEmitter<CKEDITOR.eventInfo>;
property editorChange
editorChange: EventEmitter<CKEDITOR.eventInfo>;
property fileUploadRequest
fileUploadRequest: EventEmitter<CKEDITOR.eventInfo>;
property fileUploadResponse
fileUploadResponse: EventEmitter<CKEDITOR.eventInfo>;
property focus
focus: EventEmitter<CKEDITOR.eventInfo>;
property host
host: ElementRef<HTMLTextAreaElement>;
property instance
instance: CKEDITOR.editor;
property onChange
onChange: (_: string) => void;
property onTouched
onTouched: () => void;
property ɵcmp
static ɵcmp: i0.ɵɵComponentDeclaration< CKEditorComponent, 'ckeditor', never, { config: 'config'; readonly: 'readonly'; debounce: 'debounce'; value: 'value'; }, { change: 'change'; editorChange: 'editorChange'; ready: 'ready'; blur: 'blur'; focus: 'focus'; contentDom: 'contentDom'; fileUploadRequest: 'fileUploadRequest'; fileUploadResponse: 'fileUploadResponse'; paste: 'paste'; drop: 'drop'; }, ['toolbarButtons', 'toolbarGroups'], never, false>;
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<CKEditorComponent, never>;
property paste
paste: EventEmitter<CKEDITOR.eventInfo>;
property readonly
readonly: boolean;
property ready
ready: EventEmitter<CKEDITOR.eventInfo>;
property toolbarButtons
toolbarButtons: QueryList<CKButtonDirective>;
property toolbarGroups
toolbarGroups: QueryList<CKGroupDirective>;
property value
value: string;
method ckeditorInit
ckeditorInit: (config: CKEDITOR.config) => void;
CKEditor init
method ngAfterViewChecked
ngAfterViewChecked: () => void;
On component view checked
method ngAfterViewInit
ngAfterViewInit: () => void;
On component view init
method ngOnChanges
ngOnChanges: (changes: SimpleChanges) => void;
method ngOnDestroy
ngOnDestroy: () => void;
On component destroy
method registerOnChange
registerOnChange: (fn: () => void) => void;
method registerOnTouched
registerOnTouched: (fn: () => void) => void;
method updateValue
updateValue: (value: any) => void;
Value update process
method writeValue
writeValue: (value: string) => void;
Implements ControlValueAccessor
class CKEditorModule
class CKEditorModule {}
CKEditorModule
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<CKEditorModule, never>;
property ɵinj
static ɵinj: i0.ɵɵInjectorDeclaration<CKEditorModule>;
property ɵmod
static ɵmod: i0.ɵɵNgModuleDeclaration< CKEditorModule, [ typeof i1.CKEditorComponent, typeof i2.CKButtonDirective, typeof i3.CKGroupDirective ], [any], [ typeof i1.CKEditorComponent, typeof i2.CKButtonDirective, typeof i3.CKGroupDirective ]>;
class CKGroupDirective
class CKGroupDirective implements AfterContentInit {}
CKGroup component Usage : <ckeditor [(ngModel)]="data" [config]="{...}" debounce="500"> <ckgroup [name]="'exampleGroup2'" [previous]="'1'" [subgroupOf]="'exampleGroup1'"> . .
property name
name: string;
property ɵdir
static ɵdir: i0.ɵɵDirectiveDeclaration< CKGroupDirective, 'ckgroup', never, { name: 'name'; previous: 'previous'; subgroupOf: 'subgroupOf' }, {}, ['toolbarButtons'], never, false>;
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<CKGroupDirective, never>;
property previous
previous: string | number;
property subgroupOf
subgroupOf: string;
property toolbarButtons
toolbarButtons: QueryList<CKButtonDirective>;
method initialize
initialize: (editor: CKEditorComponent) => void;
method ngAfterContentInit
ngAfterContentInit: () => void;
Package Files (5)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ng2-ckeditor
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ng2-ckeditor)
- HTML<a href="https://www.jsdocs.io/package/ng2-ckeditor"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1208 ms. - Missing or incorrect documentation? Open an issue for this package.