Code Monkey home page Code Monkey logo

react-spiral's Introduction

react-spiral

This React component renders a spiral of text. You choose the shape and the size of the spiral, and the component takes care of the rest.

Installation

npm i react-spiral

Usage

import Spiral from 'react-spiral';

function MyComponent() {
  return (
    <Spiral
      sides={3}
      boxSize={500}
      fontSize={30}
      spacing={20}
    >
      I'm a spiral
    </Spiral>
  );
}

Configuration

All of the following props are required to properly render a spiral:

Name Type Description
sides number The number of sides that the shape has. A triangle has 3 sides, a square has 4, a pentagon has 5, and so on.
children string The text to be rendered in the spiral. The text will continue to repeat itself until there's no room left.
boxSize number The size, in pixels, of the square that the spiral will be rendered within
fontSize number The size of the font, in pixels
spacing number The amount of space, in pixels, between parallel lines in the spiral

Further reading

If you're interested to learn how this component works, I wrote a blog post explaining all of the techniques that were involved in its creation. I learned a ton about math and trigonometry in the process, and I hope I can share some of my learnings in a digestible way. There's also a few interactive demos in there that are pretty fun to play with. ๐Ÿ˜Š

react-spiral's People

Contributors

trevorblades avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

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.