Code Monkey home page Code Monkey logo

svg-path-builder's Introduction

svg-path-builder

minimal utility for building path data using a declarative api.

Installation

$ yarn add svg-path-builder

Usage

import PathBuilder from 'svg-path-builder';

function renderSvgPath() {
    const pathData = new PathBuilder()
        .moveTo(10, 10)
        .lineTo(20, 20)
        .relative()
        .horizontalLineTo(100)
        .toString()
        
    return <Path d={pathData}/>
}

API

new PathBuilder()

create an instance of the path builder

  • relative() switch to relative path mode
  • aboslute() switch to absolute path mode
  • moveTo(x, y) move to position without drawing a line
  • lineTo(x, y) draw a line from current position to point(x, y)
  • horizontalLineTo(x) draw line from current position to point(x, currentY)
  • verticalLineTo(y) draw a line from current position to point(currentX, y);
  • toString() return the path as an Svg formatted string (e.g. d={path.toString()))

Note: I quickly wrote this for a particular use case, so there is currently no support for Curve or Arc path data. It would be very simple to add, which I will hopefully have time to to get to. Otherwise feel free to PR.

svg-path-builder's People

Watchers

 avatar  avatar  avatar

Forkers

jacobbubu rob10e

svg-path-builder's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.