3.3.0 • Published 4 years ago

react-lineto v3.3.0

Weekly downloads
3,953
License
MIT
Repository
github
Last release
4 years ago

react-lineto

Draw a line between two elements in React.

Build Status

Getting Started

yarn install
yarn run demo

Browse to localhost:4567.

Demo

Demo

Components

LineTo

Draw line between two DOM elements.

Example

import LineTo from 'react-lineto';

function render() {
    return (
        <div>
            <div className="A">Element A</div>
            <div className="B">Element B</div>
            <LineTo from="A" to="B" />
        </div>
    );
}

If using multiple instances of <LineTo /> inside separate components, you must provide a unique key for each of the container divs.

Properties

NameTypeDescriptionExample Values
borderColorstringBorder color#f00, red, etc.
borderStylestringBorder stylesolid, dashed, etc.
borderWidthnumberBorder width (px)
classNamestringDesired CSS className for the rendered element
delaynumber or boolForce render after delay (ms)0, 1, 100, true
fromAnchorstringAnchor for starting point (Format: "x y")top right, bottom center, left, 100% 0
from*stringCSS class name of the first element
toAnchorstringAnchor for ending point (Format: "x y")top right, bottom center, left, 100% 0
to*stringCSS class name of the second element
withinstringCSS class name of the desired container
zIndexnumberZ-index offset

* Required

SteppedLineTo

Draw stepped line between two DOM elements.

Example

import { SteppedLineTo } from 'react-lineto';

function render() {
    return (
        <div>
            <div className="A">Element A</div>
            <div className="B">Element B</div>
            <SteppedLineTo from="A" to="B" orientation="v" />
        </div>
    );
}

Properties

NameTypeDescriptionExample Values
borderColorstringBorder color#f00, red, etc.
borderStylestringBorder stylesolid, dashed, etc.
borderWidthnumberBorder width (px)
classNamestringDesired CSS className for the rendered element
delaynumber or boolForce render after delay (ms)0, 1, 100, true
fromAnchorstringAnchor for starting point (Format: "x y")top right, bottom center, left, 100% 0
from*stringCSS class name of the first element
orientationenum"h" for horizonal, "v" for verticalh or v
toAnchorstringAnchor for ending point (Format: "x y")top right, bottom center, left, 100% 0
to*stringCSS class name of the second element
withinstringCSS class name of the desired container
zIndexnumberZ-index offset

* Required

Line

Draw line using pixel coordinates (relative to viewport).

Example

import { Line } from 'react-lineto';

function render() {
    return (
        <Line x0={0} y0={0} x1={10} y1={10} />
    );
}

Properties

NameTypeDescriptionExample Values
borderColorstringBorder color#f00, red, etc.
borderStylestringBorder stylesolid, dashed, etc.
borderWidthnumberBorder width (px)
classNamestringDesired CSS className for the rendered element
withinstringCSS class name of the desired container
x0*numberFirst X coordinate
x1*numberSecond X coordinate
y0*numberFirst Y coordinate
y1*numberSecond Y coordinate
zIndexnumberZ-index offset

* Required

Release Checklist

  1. Bump version in package.json
  2. Update CHANGELOG.md
  3. Run yarn build or ./scripts/update
  4. Create version commit (ex. "2.0.0")
  5. Create matching tag (ex. "2.0.0")
  6. Push master branch and tags to origin
  7. Verify Travis CI published NPM package
3.3.0

4 years ago

3.2.1

4 years ago

3.2.0

5 years ago

3.1.4

5 years ago

3.1.3

6 years ago

3.1.2

7 years ago

3.1.1

7 years ago

3.1.0

7 years ago

3.0.0

7 years ago

2.1.0

7 years ago

2.0.0

7 years ago

1.2.0

8 years ago

1.1.1

8 years ago

1.1.0

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago