Code Monkey home page Code Monkey logo

react-spectrum's Introduction

1 2 3 4 5 6

React Spectrum

A tiny(around 1.3kb gzip) React library to generate colorful text placeholders ๐ŸŽจ

Inspired by this code illustration on CodeSandbox homepage ๐Ÿ™

Try out the generator at react-spectrum.netlify.com ๐ŸŽŠ Also, check out @BotSpectrum twitter bot that tweets randomly generated colorful text placeholders for inspiration ๐ŸŽŠ

MIT Licence Open Source Love Build Status npm version GitHub version Greenkeeper badge

Demo

Table of Contents

Install

NPM

npm install react-spectrum

Yarn

yarn add react-spectrum

UMD build

<script src="https://unpkg.com/react-spectrum/dist/react-spectrum.umd.js"></script>

Usage

import React from "react";
// Import library
import Spectrum from "react-spectrum";
// or const Spectrum = require('react-spectrum');

// Render the placeholder
function Placeholder() {
  return (
    <Spectrum
      width={500}
      colors={["#757575", "#999999", "#0871F2", "#BF5AF2"]}
    />
  );
}

Props

Property Type Default Description
width number 500 Width of the placeholder container
colors Array<string> ['#eee'] Possible colors of words, will be picked randomly
wordWidths Array<number> [30, 60, 90, 120, 150] Possible widths of words, will be picked randomly
wordDistances Array<number> [4, 8, 12] Possible distance between words, will be picked randomly
wordHeight number 12 Height of every word placeholder
wordRadius number 20 Border radius of every word
lineDistance number 12 Distance(margin) between the lines
linesPerParagraph number 8 Lines per paragraph. if there are multiple paragraphs, all of them will have same number of lines
paragraphs number 1 Number of paragraphs in the placeholder
paragraphDistance number 24 Distance(margin) between the paragraphs
truncateLastLine boolean true Show less words in the last line for more natural feel
renderWord function ({ key, style}) => <span key={key} style={style} /> Render word with customizations(avoid overriding passed style properties. it might break the functionality)

Contribute

Thanks for taking the time to contribute, please check out the src to understand how things work.

Reporting Issues

Found a problem? Want a new feature? First of all, see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope and do avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/react-spectrum
  • Navigate to the newly cloned directory: cd react-spectrum
  • Create a new branch for the new feature: git checkout -b my-new-feature
  • Install the tools necessary for development: yarn
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes

License

This project is licensed under The MIT License (MIT), see the LICENSE file for more details.

This project is tested with BrowserStack.

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.