sdk-message - npm Package Compare versions

Comparing version 1.0.5 to 2.0.0

lib/sdk-message.component.d.ts

@@ -1,4 +0,7 @@
-import { ElementRef, EventEmitter, OnChanges } from '@angular/core';
+import { ElementRef, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
-export declare class SDKMessageComponent implements OnChanges {
+export declare class SDKMessageComponent {
+    /**************************************************************************
+    * Input/Output Parameters
+    **************************************************************************/
     message: string;
@@ -9,13 +12,22 @@ height: string;
     messageChange: EventEmitter<any>;
+    /**************************************************************************
+    * Component Variables
+    **************************************************************************/
     sdkmessage: ElementRef<any>;
-    showMessage: boolean;
-    _message: string;
+    protected showMessage: boolean;
+    protected _message: string;
     private _timer;
-    ngAfterViewInit(): void;
-    ngOnChanges(changes: any): void;
-    startTimer(): void;
-    clearMessage(): void;
-    stopTimer(): void;
+    /**************************************************************************
+    * Component Lifecycle Methods
+    **************************************************************************/
+    protected ngOnChanges(_args: any): void;
+    protected ngAfterViewInit(): void;
+    /**************************************************************************
+    * Protected Methods
+    **************************************************************************/
+    protected startTimer(): void;
+    protected stopTimer(): void;
+    protected clearMessage(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SDKMessageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SDKMessageComponent, "sdk-message", never, { "message": { "alias": "message"; "required": false; }; "height": { "alias": "height"; "required": false; }; "style": { "alias": "style"; "required": false; }; "timer": { "alias": "timer"; "required": false; }; }, { "messageChange": "messageChange"; }, never, never, false, never>;
 }

package.json

@@ -5,3 +5,3 @@ {
   "homepage": "https://www.soodohkohd.com?w=packages&v=sdk-message",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "license": "MIT",
@@ -8,0 +8,0 @@ "keywords": [

public-api.d.ts

@@ -1,2 +0,2 @@
-export * from './lib/sdk-message.component';
-export * from './lib/sdk-message.module';
+export { SDKMessageModule } from './lib/sdk-message.module';
+export { SDKMessageComponent } from './lib/sdk-message.component';

README.md

@@ -27,2 +27,10 @@ <img src="https://www.soodohkohd.com/assets/images/logo.png" title="soo-doh-kohd" height="200"/>
 
+## PROPERTIES:
+```typescript
+message: string = ""; // Message to display.
+height: string = ""; // Height of the message box. Default value is "35px".
+style: string = ""; // Custom style to apply to message. Default value includes blue background with white font.
+timer: number = 5; // Time (in seconds) to display the message. Default value is shown.
+```
+
 ## USAGE:
@@ -39,10 +47,4 @@ ```html
 
-List of properties:
-- ```message (string)```: Message to display. (See NOTE)
-- ```height (string)```: Height (pixel-based 'px') of the message box. Default: 35px.
-- ```style (string)```: Custom style to apply to message. Default: blue background/white font.
-- ```timer (number)```: Time (in seconds) to display the message. Default: 5 (seconds).
+**NOTE:** The ```sdk-message``` component clears the calling 'message' property be default. This is the reason for the required two-way binding [(message)].
 
-NOTE: The ```sdk-message``` component clears the calling 'message' property be default. This is the reason for the required two-way binding [(message)].
-
-The message will remain on the screen for the "timer" amount. If you click the message, it will close. If you move your mouse over the message, it will pause until you move your mouse away.
+The message will remain on the screen for the "timer" amount. If you click the message, it will close. If you move your mouse over the message, it will pause until you move your mouse away - at which point the timer (countdown) will begin again.

No alert changes

Improved metrics

Total package byte prevSize

36276

12.82%

Lines of code

296

11.28%

Number of lines in readme file

48

4.35%

No dependency changes