Options
All
  • Public
  • Public/Protected
  • All
Menu

Line Maker library

styled with prettier Greenkeeper badge Build Status Dev Dependencies

A library for creating and animating decorative lines on websites.

The main idea is based on LineMaker but this library use power of the mo-js.

Install

npm install --save line-maker

OR

<script src="https://unpkg.com/line-maker@1.0.1/dist/line-maker.umd.min.js"></script>

Usage

var lineMaker = new LinaMaker([
  {
    /* line options */
  }
])

LineOption

{
  origin?: string // origin of the line animation
  displaySettings: {
    color?: string | { [delta: string]: string } // color of the line [String | mojs Delta Object]
    width?: number | string // Width of the line
    start?: { // line start position relative to parent
      x: number | string
      y: number | string
    }
    end?: { // line end position relative to parent
      x: number | string
      y: number | string
    }
    zIndex?: number // line object z-index
  }
  // and any other option for mo-js html
}

DEMO

demo1

TODO

find a way to writing tests write document create more demos

Index

Object literals

Const lineDefaultOptions

lineDefaultOptions: object

parent

parent: HTMLElement = document.body

displaySettings

displaySettings: object

width

width: number = 1

zIndex

zIndex: number = 0

color

color: object

#fff

#fff: string = "#000"

end

end: object

x

x: string = "100%"

y

y: string = "100%"

start

start: object

x

x: number = 0

y

y: number = 0

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc