Skip to content
This repository has been archived by the owner on Apr 9, 2018. It is now read-only.

Latest commit

 

History

History
87 lines (56 loc) · 2.34 KB

README.md

File metadata and controls

87 lines (56 loc) · 2.34 KB

Angular 2 UI Utility Functoins

utility functions

IMPORTANT NOTICE

After 0.7.0 or higher, ng2-utils has been changed to @ngui/utils like the same Angular version is more than 2. Here are the changes;

  • Module name ng2-utils has been changed to @ngui/utils.
  • Direvtive name ng2-utils-X is moved to ngui-utils-X. e.g., ngui-utils-1
  • Class name Ng2Util is moved to NguiUtils.

Install

  1. install @ngui/utils

     $ npm install @ngui/utils --save
    

Use it in your code

App Component

    import { NguiUtilsModule } from '@ngui/utils';

    import { AppComponent }   from './app.component';

    @NgModule({    imports: [BrowserModule, NguiUtilsModule],
      declarations: [AppComponent],
      bootstrap: [ AppComponent ]
    })
    export class AppModule { }

    platformBrowserDynamic().bootstrapModule(AppModule);

Javascript

    import { elementVisible, computedStyle, scrollTo, outerHeight, outerWidth } from '@ngui/utils';

HTML

    {{myHtml | htmlCode}}
    {{myHtml | htmlCode:'include'}}
    {{myHtml | htmlCode:'-include'}}
    {{ngOnInit | jsCode}}

DOM-related functions

  • computedStyle(element, styleName)

    • returns style value
  • elementVisible(innerElement, outerElement)

    • returns visiblility of top, bottom, left, and right
  • outerHeight(element)

    • return height in number
  • outerWidth(element)

    • return width in number
  • scrollTo(selector, parentCssSelector)

    • scrolls to a certain section in a second
    • returns void

Pipes

  • string | htmlCode:'include,-exclude'

    • returns html string with tags included and excluded
  • string | jsCode

    • returns beautified Javascript code

Services

* MemoryStorage
  memory storage without using localStorage or sessionStorage with following functions
    * getItem(key: string) : returns string value of stored value
    * setItem(key: string, value: string): store value of key into memory
    * clear(): reset memory storage

* Storage
  session storage using sessionStorage with fallback to MemoryStorage with following functions
    * getItem(key: string) : returns string value of stored value
    * setItem(key: string, value: string): store value of key into memory
    * clear(): reset storage