ngx-editor - npm Package Compare versions

Comparing version 15.2.0 to 15.3.0

CHANGELOG.md

@@ -16,2 +16,9 @@ # CHANGELOG
 
+## v15.3.0 (2023-02-26)
+
+#### Features
+
+- add option to use custom icons in menu component ([5706bc4](https://github.com/sibiraj-s/ngx-editor/commit/5706bc4)),
+  ([eda7f2f](https://github.com/sibiraj-s/ngx-editor/commit/eda7f2f))
+
 ## v15.2.0 (2023-02-06)
@@ -18,0 +25,0 @@

lib/editor-config.service.d.ts

 import * as i0 from "@angular/core";
 export declare class NgxEditorServiceConfig {
     locals: {};
+    icons: {};
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxEditorServiceConfig, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NgxEditorServiceConfig>;
 }

lib/editor.service.d.ts

@@ -9,2 +9,3 @@ import { NgxEditorConfig } from './types';
     get locals(): Locals;
+    getIcon(icon: string): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxEditorService, [{ optional: true; }]>;
@@ -11,0 +12,0 @@ static ɵprov: i0.ɵɵInjectableDeclaration<NgxEditorService>;

lib/icons/index.d.ts

@@ -1,2 +0,3 @@
-declare const icons: Record<string, any>;
+export declare const icons: Record<string, any>;
+export declare type IconsKeys = keyof typeof icons;
 declare class Icon {
@@ -3,0 +4,0 @@ static get(name: keyof typeof icons, fill?: string): string;

lib/types.d.ts

 import { EditorState } from 'prosemirror-state';
 import { EditorView } from 'prosemirror-view';
+import { IconsKeys } from './icons';
 import { LocalsKeys } from './Locals';
@@ -20,3 +21,4 @@ declare type TCR = {
     locals?: Partial<Record<LocalsKeys, string>>;
+    icons?: Partial<Record<IconsKeys, string>>;
 }
 export {};

package.json

 {
   "name": "ngx-editor",
-  "version": "15.2.0",
-  "description": "Rich Text Editor for angular using ProseMirror",
+  "version": "15.3.0",
+  "description": "The Rich Text Editor for Angular, Built on ProseMirror",
   "license": "MIT",
@@ -6,0 +6,0 @@ "repository": "https://github.com/sibiraj-s/ngx-editor.git",

README.md

@@ -8,3 +8,3 @@ # NgxEditor
 </p>
-<p align="center">Rich Text Editor for angular using ProseMirror</p>
+<p align="center">The Rich Text Editor for Angular, Built on ProseMirror</p>
 <p align="center">
@@ -29,2 +29,5 @@ <a href="https://github.com/sibiraj-s/ngx-editor/actions">
 
+> A simple rich text editor for angular applications built with ProseMirror. It is a drop in and easy-to-use editor
+> and can be easily extended using prosemirror plugins to build any additional or missing features
+
 ## Getting Started
@@ -84,8 +87,3 @@
   <ngx-editor-menu [editor]="editor"> </ngx-editor-menu>
-  <ngx-editor
-    [editor]="editor"
-    [ngModel]="html"
-    [disabled]="false"
-    [placeholder]="'Type here...'"
-  ></ngx-editor>
+  <ngx-editor [editor]="editor" [ngModel]="html" [disabled]="false" [placeholder]="'Type here...'"></ngx-editor>
 </div>
@@ -117,8 +115,3 @@ ```
 ```ts
-this.editor.commands
-  .textColor('red')
-  .insertText('Hello world!')
-  .focus()
-  .scrollIntoView()
-  .exec();
+this.editor.commands.textColor('red').insertText('Hello world!').focus().scrollIntoView().exec();
 ```
@@ -151,4 +144,4 @@
 - Mozilla Firefox
+- Safari
 - Opera
-- Safari
 
@@ -155,0 +148,0 @@ ## Angular Compatibility

No alert changes

Improved metrics

Total package byte prevSize

1365848

increased by0.34%

Lines of code

11341

increased by0.27%

Worsened metrics

Number of lines in readme file

165

decreased by-4.07%

No dependency changes