Wondering what’s next for npm?Check out our public roadmap! »

    @mornya/ui-libs
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    @mornya/ui-libs

    npm node types downloads license

    The project of Global UI module.

    This project has been created by Vessel CLI. For a simple and quick reference about it, click here.

    About

    프론트엔드 프로젝트 개발에 사용되는 모듈들에 대해 집합적인 형태로 제공되는 패키지.

    Installation

    해당 라이브러리를 사용 할 프로젝트에서는 아래와 같이 의존성 모듈로 설치한다.

    $ npm install --save @mornya/ui-libs
    or
    $ yarn add @mornya/ui-libs

    Modules in the package

    본 패키지에는 아래와 같은 모듈들을 포함한다.
    제공되는 모듈과 메소드 사용법 등은 코드 스니핏을 참고한다.

    AnimationFrame module

    window.requestAnimationFrame를 이용한 애니메이션 프레임 구현 (requestTimeout, requestInterval)

    Easing module

    Easing 관련 각종 메소드 제공 (gizma.com/easing 참고)

    ImageLib module

    이미지 관련 처리 모듈.

    ImageLib.getImageSize

    입력 받은 URL에 대한 이미지 사이즈를 얻는다.

    function getImageSize (url: string): Promise<ImageSize> {}

    PopupLib module

    팝업 / 새 창 관련 처리 모듈.

    PopupLib.openWindow

    브라우저 새 창 열기 및 윈도우 객체 상태에 따른 콜백기능을 제공.

    function openWindow (openWindowOption: OpenWindowOption): Window | null {}

    ScrollHelper module

    브라우저 화면 스크롤 제어 및 콜백함수 제공.

    ScrollLib module

    화면 스크롤 관련 처리 모듈.

    ScrollLib.scroll

    화면에서 해당 엘리먼트 객체가 위치한 곳으로 스크롤 이동 및 콜백 리턴.

    function scroll (scrollOption: ScrollOption): Promise<ScrollResult | null> {}

    UI module

    UI 관련 처리 모듈.

    UI.documentBody

    document.body를 얻어온다 (모던/IE 브라우저 대응)

    function documentBody (): DocumentBody {}

    UI.getScrollOffsetX

    window.pageXOffset과 동일 (모던/IE 브라우저 대응)

    function getScrollOffsetX (): number {}

    UI.getScrollOffsetY

    window.pageYOffset과 동일 (모던/IE 브라우저 대응)

    function getScrollOffsetY (): number {}

    UI.getUrlToBlob

    MIME 타입으로 지정한 원격 파일을 읽어와 리턴.

    function getUrlToBlob (file: File, mimeType: string): Promise<string> {}

    UI.getImageFileToData

    원격 이미지를 파일 객체로 변환하여 저장.

    function getImageFileToData (file: File): Promise<string> {}

    UI.freezeBody

    팝업 레이어 사용시 document.body에 backface-visibility 적용 클래스를 추가.

    function freezeBody (): void {}

    UI.unfreezeBody

    document.body에서 backface-visibility 적용 클래스를 해제.

    function unfreezeBody (): void {}

    UI.createDOM

    문자열로 HTML 엘리먼트를 생성한다 (첫 child element를 리턴).

    function createDOM<E extends HTMLElement | Element> (html: string): E {}

    UI.debounce

    function debounce<F extends (...args: any[]) => void> (callback: F, debounceOption?: DebounceOption): (...args: Parameters<F>) => void {}

    Change Log

    프로젝트 변경사항은 CHANGELOG.md 파일 참조.

    License

    프로젝트 라이센스는 LICENSE 파일 참조.

    Install

    npm i @mornya/ui-libs

    DownloadsWeekly Downloads

    1

    Version

    1.1.0

    License

    ISC

    Unpacked Size

    24 kB

    Total Files

    21

    Last publish

    Collaborators

    • avatar