To Upload images, you must specify an endpoint to which the image has to be uploaded. The POST request sent is a FORMDATA with name file.
The Response is a json and it should be in the following format
{
- "url": "http://myApiEndPoint"
-}The Input for the endpoint is a string can be provided directly or via config property
<app-ngx-editor imageEndPoint="http://myApiEndPoint"></app-ngx-editor><app-ngx-editor imageEndPoint="http://myApiEndPoint"></app-ngx-editor>The Response is a json and it should be in the following format
{
+ "url": "https://location-of-image"
+}You must install all the following peerDependencies in order for `ngx-editor to work
- {
+ {
: , : (() => ), : true
-}
-
+}
Properties@@ -505,6 +553,7 @@Properties |
Methods@@ -555,6 +604,7 @@Methods |
Inputs@@ -608,6 +658,7 @@Inputs |
Outputs@@ -625,1480 +676,1473 @@Outputs |
- constructor(_messageService: MessageService, _commandExecutor: CommandExecutorService, _renderer: Renderer2)
- |
- ||||||||||||||||||||||||||||||||
| - - | -||||||||||||||||||||||||||||||||
|
-
- Parameters :
-
+
+ no
+ |
+
+
+ |
+
+
+ |
+
-
- config
- |
-
- The config property is a JSON object +Inputs+
+ Type: |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| + + | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - - - - executeCommand - - - - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- executeCommand(commandName: string)
- |
- ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- editor actions, i.e., executes command from toolbar -
- Parameters :
-
+
+
+ Returns :
void
+
+
- Returns :
- void
-
+
-
-
-
-
-
-
|
+
| + + + + codeEditor + + + + | +
+ codeEditor:
+ |
+
-
-
-
- codeEditor
-
-
-
+ Type : any
+
|
- codeEditor:
+ Decorators : ViewChild
|
- Type : any
-
- |
-
- Decorators : ViewChild
+
|
| - - | -
| - - - - codeEditorMode - - - - | -
| + + + + codeEditorMode + + + + | +
+ codeEditorMode:
+ |
+
- codeEditorMode:
+ Default value : false
|
- Default value : false
+
|
| - - | -
| + + + + ngxWrapper + + + + | +
+ ngxWrapper:
+ |
+
-
-
-
- ngxWrapper
-
-
-
+ Type : any
+
|
- ngxWrapper:
+ Decorators : ViewChild
|
- Type : any
-
- |
-
- Decorators : ViewChild
+
|
| - - | -
| + + + + textArea + + + + | +
+ textArea:
+ |
+
-
-
-
- textArea
-
-
-
+ Type : any
+
|
- textArea:
+ Decorators : ViewChild
|
- Type : any
-
- |
-
- Decorators : ViewChild
+
|
| - - | -
| + + + + Utils + + + + | +
+ Utils:
+ |
+
-
-
-
- Utils
-
-
-
+ Type : any
+
|
- Utils:
+ Default value : Utils
|
- Type : any
-
- |
-
- Default value : Utils
+
|
| - - | -
app-ngx-editor-message
Properties@@ -476,6 +526,7 @@Properties |
Methods@@ -490,159 +541,164 @@Methods |
- constructor(_messageService: MessageService)
- |
- ||||||||||||||||||
| - - | -||||||||||||||||||
|
-
- Parameters :
-
+
+ no
+ |
+
+
+ |
+
+
+ |
+
| - - - - clearMessage - - - - | -
- clearMessage()
- |
-
| - - | -
|
- clears editor message -
- Returns :
- void
-
- |
-
| + + + + clearMessage + + + + | +
+clearMessage()
+ |
+
| - - - - ngxMessage - - - - | -
- ngxMessage:
- |
-
- Default value : undefined
+
|
| - - | -
|
+ clears editor message +
+ Returns :
+ void
+
+ |
+
| + + + + ngxMessage + + + + | +
+ ngxMessage:
+ |
+
|
- property that holds the message to be displayed on the editor -undefined
|
property that holds the message to be displayed on the editor
+
- PopoverConfig
-
+ PopoverConfig
Properties@@ -535,6 +583,7 @@Properties |
Methods@@ -585,6 +634,7 @@Methods |
Inputs@@ -599,6 +649,7 @@Inputs |
Outputs@@ -613,1545 +664,1538 @@Outputs |
- constructor(_popOverConfig: PopoverConfig, _formBuilder: FormBuilder, _messageService: MessageService, _commandExecutorService: CommandExecutorService)
- |
- |||||||||||||||||||||||||||||
| - - | -|||||||||||||||||||||||||||||
|
-
- Parameters :
-
+
+ no
+ |
+
+
+
+ |
+
-
- config
- |
- - | +
| + + | +|
-
- execute
- |
- - | +
| + + | +|
| - - - - buildImageForm - - - - | -
- buildImageForm()
- |
-
| - - | -
|
- create insert image form -
- Returns :
- void
-
- |
-
| - - - - buildUrlForm - - - - | -
- buildUrlForm()
- |
-
| - - | -
|
- create URL insert form -
- Returns :
- void
-
- |
-
| - - - - buildVideoForm - - - - | -
- buildVideoForm()
- |
-
| - - | -
|
- create insert image form -
- Returns :
- void
-
- |
-
| - - - - canEnableToolbarOptions - - - - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- canEnableToolbarOptions(value: )
- |
- ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- enable or diable toolbar based on configuration -
- Parameters :
-
+
+
+ Returns :
boolean
+
+
- Returns :
- boolean
-
+
-
-
-
-
-
-
|
+
| - - - - colorPopover - - - - | -
| + + + + colorPopover + + + + | +
+ colorPopover:
+ |
+
- colorPopover:
+ Decorators : ViewChild
|
- Decorators : ViewChild
+
|
| - - | -
| + + + + fontName + + + + | +
+ fontName:
+ |
+
-
-
-
- fontName
-
-
-
+ Type : string
+
|
- fontName:
+ Default value : ''
|
- Type : string
-
- |
-
- Default value : ''
+
|
| - - | -
|
- font family name - |
-
|
+ font family name + |
+
| + + + + fontSize + + + + | +
+ fontSize:
+ |
+
-
-
-
- fontSize
-
-
-
+ Type : string
+
|
- fontSize:
+ Default value : ''
|
- Type : string
-
- |
-
- Default value : ''
+
|
| - - | -
|
- font size - |
-
| - - - - fontSizePopover - - - - | -
|
+ font size + |
+
| + + + + fontSizePopover + + + + | +
+ fontSizePopover:
+ |
+
- fontSizePopover:
+ Decorators : ViewChild
|
- Decorators : ViewChild
+
|
| - - | -
| + + + + hexColor + + + + | +
+ hexColor:
+ |
+
-
-
-
- hexColor
-
-
-
+ Type : string
+
|
- hexColor:
+ Default value : ''
|
- Type : string
-
- |
-
- Default value : ''
+
|
| - - | -
|
- hex color code - |
-
| - - - - imageForm - - - - | -
|
+ hex color code + |
+
| + + + + imageForm + + + + | +
+ imageForm:
+ |
+
- imageForm:
+ Type : FormGroup
+
|
- Type : FormGroup
-
+
|
| - - | -
|
- holds values of the insert image form - |
-
| - - - - imagePopover - - - - | -
|
+ holds values of the insert image form + |
+
| + + + + imagePopover + + + + | +
+ imagePopover:
+ |
+
- imagePopover:
+ Decorators : ViewChild
|
- Decorators : ViewChild
+
|
| - - | -
| - - - - isImageUploader - - - - | -
| + + + + isImageUploader + + + + | +
+ isImageUploader:
+ |
+
- isImageUploader:
+ Default value : false
|
- Default value : false
+
|
| - - | -
|
- show/hide image uploader - |
-
| - - - - isUploading - - - - | -
|
+ show/hide image uploader + |
+
| + + + + isUploading + + + + | +
+ isUploading:
+ |
+
- isUploading:
+ Default value : false
|
- Default value : false
+
|
| - - | -
|
- set to true when the image is being uploaded - |
-
|
+ set to true when the image is being uploaded + |
+
| + + + + selectedColorTab + + + + | +
+ selectedColorTab:
+ |
+
-
-
-
- selectedColorTab
-
-
-
+ Type : string
+
|
- selectedColorTab:
+ Default value : 'textColor'
|
- Type : string
-
- |
-
- Default value : 'textColor'
+
|
| - - | -
|
- which tab to active for color insetion - |
-
|
+ which tab to active for color insetion + |
+
| + + + + updloadPercentage + + + + | +
+ updloadPercentage:
+ |
+
-
-
-
- updloadPercentage
-
-
-
+ Type : number
+
|
- updloadPercentage:
+ Default value : 0
|
- Type : number
-
- |
-
- Default value : 0
+
|
| - - | -
|
- upload percentage - |
-
| - - - - uploadComplete - - - - | -
|
+ upload percentage + |
+
| + + + + uploadComplete + + + + | +
+ uploadComplete:
+ |
+
- uploadComplete:
+ Default value : true
|
- Default value : true
+
|
| - - | -
|
- set to false when image is being uploaded - |
-
| - - - - urlForm - - - - | -
|
+ set to false when image is being uploaded + |
+
| + + + + urlForm + + + + | +
+ urlForm:
+ |
+
- urlForm:
+ Type : FormGroup
+
|
- Type : FormGroup
-
+
|
| - - | -
|
- holds values of the insert link form - |
-
| - - - - urlPopover - - - - | -
|
+ holds values of the insert link form + |
+
| + + + + urlPopover + + + + | +
+ urlPopover:
+ |
+
- urlPopover:
+ Decorators : ViewChild
|
- Decorators : ViewChild
+
|
| - - | -
| - - - - videoForm - - - - | -
| + + + + videoForm + + + + | +
+ videoForm:
+ |
+
- videoForm:
+ Type : FormGroup
+
|
- Type : FormGroup
-
+
|
| - - | -
|
- holds values of the insert video form - |
-
| - - - - videoPopover - - - - | -
|
+ holds values of the insert video form + |
+
| + + + + videoPopover + + + + | +
+ videoPopover:
+ |
+
- videoPopover:
+ Decorators : ViewChild
|
- Decorators : ViewChild
+
|
| - - | -
app-ngx-grippie
Properties@@ -482,6 +532,11 @@Properties |
HostListeners@@ -502,302 +557,303 @@HostListeners |
- constructor(_editorComponent: NgxEditorComponent)
- |
- ||||||||||||||||||
| - - | -||||||||||||||||||
|
- Constructor -
- Parameters :
-
+
+ no
+ |
+
+
+ |
+
+
+ |
+
| + + + + document:mousemove + + + + | +
-
-
-
- document:mousemove
-
-
-
+ Arguments : '$event'
|
+document:mousemove(event: MouseEvent)
+ |
+
- Arguments : '$event'
+
|
| + + + + document:mouseup + + + + | +
- document:mousemove(event: MouseEvent)
- |
-
| - - | -
-
-
-
- document:mouseup
-
-
-
+ Arguments : '$event'
|
+document:mouseup(event: MouseEvent)
+ |
+
- Arguments : '$event'
+
|
| + + + + mousedown + + + + | +
- document:mouseup(event: MouseEvent)
- |
-
| - - | -
-
-
-
- mousedown
-
-
-
+ Arguments : '$event'
|
+mousedown(event: MouseEvent, resizer?: Function)
+ |
+
- Arguments : '$event'
+
|
- mousedown(event: MouseEvent, resizer?: Function)
- |
-
| - - | -
| - - - - grabber - - - - | -
| + + + + grabber + + + + | +
+ grabber:
+ |
+
- grabber:
+ Default value : false
|
- Default value : false
+
|
| - - | -
|
- set to true on mousedown event - |
-
| - - - - height - - - - | -
|
+ set to true on mousedown event + |
+
| + + + + height + + + + | +
+ height:
+ |
+
- height:
+ Type : number
+
|
- Type : number
-
+
|
| - - | -
|
- height of the editor - |
-
|
+ height of the editor + |
+
| + + + + oldY + + + + | +
+ oldY:
+ |
+
-
-
-
- oldY
-
-
-
+ Type : number
+
|
- oldY:
+ Default value : 0
|
- Type : number
-
- |
-
- Default value : 0
+
|
| - - | -
|
- previous value befor resizing the editor - |
-
previous value befor resizing the editor
+