0.0.3 • Published 8 years ago

react-trimicon v0.0.3

Weekly downloads
3
License
MIT
Repository
github
Last release
8 years ago

CircleCI Code Climate

react-trimicon

react.js component to trim an image into a square icon

quick start

##try

$ git clone git@github.com/YoshiyukiKato/react-trimicon
$ cd react-trimicon && npm install
$ $(npm bin)/webpack-dev-server 

Then the server runs on http://localhost:8080.

##install

$ npm install --save react-trimicon

#usage

//app.jsx
import React from "react";
import ReactDOM from "react-dom";
import { Editor } from "react-trimicon";

const App = React.createClass({
  getInitialState: function(){
    return {
      imageSrc: ""
    }
  },

  render: function(){
    return (
      <div id="app">
        <img src={this.state.imageSrc}/>
        <button className="trimicon-button" onClick={this.selectImage}>Select Image</button>
        <Editor ref="editor" onSubmit={this.handleSubmit}/>
      </div>
    );
  },

  selectImage: function(){
    this.refs.editor.selectImage();
  },

  handleSubmit: function(dataURL){
    this.setState({ imageSrc: dataURL });
  },
});

ReactDOM.render(
  <App/>,
  document.querySelector("#main")
);

##props ###onSubmit function(dataURL){ }
The callback function will be invoked when a user finished editing image by clicking Done button. This function receives the result(square icon) as dataURL.

###resultSize number
The length (px) of side (width and height) of the square icon. The default value is 512.

###caption { zoomRatio:string, changeImage:string, done:string }
The captions for some controllers. The default value is { zoomRatio: "Zoom Ratio", changeImage: "Change Image", done: "Done" }

#TODO

  • add rgb-filter function
  • expand test cases

#LICENSE MIT