0.1.1 • Published 6 years ago

react-connect-elements v0.1.1

Weekly downloads
235
License
MIT
Repository
github
Last release
6 years ago

React Connect Elements

Connect elements with SVG

Setup

yarn add react-connect-elements

Getting Started

Include ConnectElements in the parent component.

import ConnectElements from 'react-connect-elements';

const Component = () => (
  <div>
    <div className="elements">
        <div className="element element1" />
        <div className="element element2" />
    </div>
    <ConnectElements
      selector=".elements"
      elements={[{ from: '.element1', to: '.element2' }]}
    />
  </div>
);

Props

PropDescriptionTypeDefault
elementsThe connections of the elementsarrayrequired
selectorThe DOM target selector of the parent elementstringrequired
overlayz-index value of the line connecting the elementsnumber0
strokeWidthwidth of the line in pixelsnumber5
colorColor of the line connecting the elementsstring#666

Elements Syntax

AttributeDescriptionRequired
fromThe DOM target selector of the start elementtrue
toThe DOM target selector of the end elementtrue
colorColor of the line connecting the elements (overrides the prop color)false

Credits

This gist where I got how to connect two elements / draw a path between two elements with SVG path (using jQuery).