@crystalui/angular-modal - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "@crystalui/angular-modal",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "This module allows for show modal and dialog boxes.",
@@ -9,3 +9,6 @@ "repository": {
   },
-  "author": "Nikita Drozhzhin <[e-mail]>",
+  "author": {
+    "name": "Nikita Drozhzhin",
+    "email": "[e-mail]"
+  },
   "homepage": "http://crystalui.org/components/modal",
@@ -40,6 +43,3 @@ "keywords": [
     "tslib": "^1.9.0"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

README.md

@@ -44,15 +44,44 @@ # Modal for Angular 2
 
-| name | description |
-|------------------------|---------------------------------------------|
-| `id: string = undefined` | The identifier of the window. It will distinguish one window from another. |
-| `mode: "desktop" / "mobile" / "dialog" = "desktop"` | The type of the window template. |
-| `data: any` | Any data that needs to be pass to the window. In the window component, you can get them using `@Input() modalData: any`. |
-| `width: string = "800px"` | Width of the window. |
-| `height: string = "auto"` | Height of the window. By default, the height of the window is determined by the height of its content. |
-| `maxWidth: string = "calc(100% - 32px)"` | Maximum width of the window. |
-| `maxHeight: string = "calc(100% - 32px)"` | Maximum height of the window. |
-| `overlayBackdrop: boolean = true` | Whether the window has a backdrop. |
-| `backdropClass: string / { [key: string]: any; }` | Custom classes for the backdrop. Supports the same syntax as ngClass. |
-| `modalClass: string / { [key: string]: any; }` | Custom classes for the modal window. Supports the same syntax as ngClass. |
+```ts
+id: string = undefined
+```
+The identifier of the window. It will distinguish one window from another.
+```ts
+mode: "desktop" | "mobile" | "dialog" = "desktop"
+```
+The type of the window template.
+```ts
+data: any
+```
+Any data that needs to be pass to the window. In the window component, you can get them using `@Input() modalData: any`. 
+```ts
+width: string = "800px"
+```
+Width of the window.
+```ts
+height: string = "auto"
+```
+Height of the window. By default, the height of the window is determined by the height of its content.
+```ts
+maxWidth: string = "calc(100% - 32px)"
+```
+Maximum width of the window.
+```ts
+maxHeight: string = "calc(100% - 32px)"
+```
+Maximum height of the window.
+```ts
+overlayBackdrop: boolean = true
+```
+Whether the window has a backdrop.
+```ts
+backdropClass: string | { [key: string]: any; }
+```
+Custom classes for the backdrop. Supports the same syntax as ngClass.
+```ts
+modalClass: string | { [key: string]: any; }
+```
+Custom classes for the modal window. Supports the same syntax as ngClass.
 
+
 ## Methods
@@ -59,0 +88,0 @@

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

104

increased by38.67%

Worsened metrics

Total package byte prevSize

322925

decreased by-0.04%

No dependency changes