[ { "path": ".gitignore", "content": "/coverage\n/demo/dist\n/es\n/lib\n/node_modules\n/umd\nnpm-debug.log*\n.vscode/" }, { "path": ".travis.yml", "content": "sudo: false\n\nlanguage: node_js\nnode_js:\n - 8\n\nbefore_install:\n - npm install codecov.io coveralls\n\nafter_success:\n - cat ./coverage/lcov.info | ./node_modules/codecov.io/bin/codecov.io.js\n - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js\n\nbranches:\n only:\n - master\n" }, { "path": "CHANGELOG.md", "content": "## 0.9.8\n\n### Improvements\n\n- Add Type Definitions for Typescript (#12) (thanks @danilofuchs)\n- Add support for `children` property (#13) (thanks @federico-bohn)\n\n## 0.9.7\n\n### Fixes\n\n- [Interaction] Fix bug where point annotation would fail abort (#8) (thanks @joshuadeguzman)\n\n## 0.9.6\n\n### Breaking change\n\n- [Interaction] Change annotation click action to click and drag (#6)\n" }, { "path": "CONTRIBUTING.md", "content": "## Prerequisites\n\n[Node.js](http://nodejs.org/) >= v4 must be installed.\n\n## Installation\n\n- Running `npm install` in the component's root directory will install everything you need for development.\n\n## Demo Development Server\n\n- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.\n\n## Running Tests\n\n- `npm test` will run the tests once.\n\n- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.\n\n- `npm run test:watch` will run the tests on every change.\n\n## Building\n\n- `npm run build` will build the component for publishing to npm and also bundle the demo app.\n\n- `npm run clean` will delete built resources.\n" }, { "path": "LICENSE.md", "content": "The MIT License (MIT)\n\nCopyright (c) 2018-present, Arian Allenson Valdez.\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n" }, { "path": "README.md", "content": "React Image Annotation\n=========================\n\nAn infinitely customizable image annotation library built on React\n\n![Annotation demo](demo.gif)\n\n## Installation\n\n```\nnpm install --save react-image-annotation\n# or\nyarn add react-image-annotation\n```\n\n## Usage\n\n```js\nexport default class Simple extends Component {\n state = {\n annotations: [],\n annotation: {}\n }\n\n onChange = (annotation) => {\n this.setState({ annotation })\n }\n\n onSubmit = (annotation) => {\n const { geometry, data } = annotation\n\n this.setState({\n annotation: {},\n annotations: this.state.annotations.concat({\n geometry,\n data: {\n ...data,\n id: Math.random()\n }\n })\n })\n }\n\n render () {\n return (\n \n \n \n )\n }\n}\n```\n\n\n### Props\n\nProp | Description | Default\n---- | ----------- | -------\n`src` | Image src attribute |\n`alt` | Image alt attribute |\n`annotations` | Array of annotations |\n`value` | Annotation object currently being created. See [annotation object](#annotation-object) |\n`onChange` | `onChange` handler for annotation object |\n`onSubmit` | `onSubmit` handler for annotation object |\n`type` | Selector type. See [custom shapes](#using-custom-shapes) | `RECTANGLE`\n`allowTouch` | Set to `true` to allow the target to handle touch events. This disables one-finger scrolling | `false`\n`selectors` | An array of selectors. See [adding custom selector logic](#adding-custom-selector-logic) | `[RectangleSelector, PointSelector, OvalSelector]`\n`activeAnnotations` | Array of annotations that will be passed as 'active' (active highlight and shows content) |\n`activeAnnotationComparator` | Method to compare annotation and `activeAnnotation` item (from `props.activeAnnotations`). Return `true` if it's the annotations are equal | `(a, b) => a === b`\n`disableAnnotation` | Set to `true` to disable creating of annotations (note that no callback methods will be called if this is `true`) | `false`\n`disableSelector` | Set to `true` to not render `Selector` | `false`\n`disableEditor` | Set to `true` to not render `Editor` | `false`\n`disableOverlay` | Set to `true` to not render `Overlay` | `false`\n`renderSelector` | Function that renders `Selector` Component | See [custom components](#using-custom-components)\n`renderEditor` | Function that renders `Editor` Component | See [custom components](#using-custom-components)\n`renderHighlight` | Function that renders `Highlight` Component | See [custom components](#using-custom-components)\n`renderContent` | Function that renders `Content` | See [custom components](#using-custom-components)\n`renderOverlay` | Function that renders `Overlay` | See [custom components](#using-custom-components)\n`onMouseUp` | `onMouseUp` handler on annotation target |\n`onMouseDown` | `onMouseDown` handler on annotation target |\n`onMouseMove` | `onMouseMove` handler on annotation target |\n`onClick` | `onClick` handler on annotation target |\n\n#### Annotation object\n\nAn Annotation object is an object that conforms to the object shape\n\n```js\n({\n selection: T.object, // temporary object for selector logic\n geometry: T.shape({ // geometry data for annotation\n type: T.string.isRequired // type is used to resolve Highlighter/Selector renderer\n }),\n // auxiliary data object for application.\n // Content data can be stored here (text, image, primary key, etc.)\n data: T.object\n})\n```\n\n## Using custom components\n\n`Annotation` supports `renderProp`s for almost every internal component.\n\nThis allows you to customize everything about the the look of the annotation interface, and you can even use canvas elements for performance or more complex interaction models.\n\n- `renderSelector` - used for selecting annotation area (during annotation creation)\n- `renderEditor` - appears after annotation area has been selected (during annotation creation)\n- `renderHighlight` - used to render current annotations in the annotation interface. It is passed an object that contains the property `active`, which is true if the mouse is hovering over the higlight\n- `renderComponent` - auxiliary component that appears when mouse is hovering over the highlight. It is passed an object that contains the annotation being hovered over. `{ annotation }`\n- `renderOverlay` - Component overlay for Annotation (i.e. 'Click and Drag to Annotate')\n\nYou can view the default renderProps [here](src/components/defaultProps.js)\n\n**Note**: You cannot use `:hover` selectors in css for components returned by `renderSelector` and `renderHighlight`. This is due to the fact that `Annotation` places DOM layers on top of these components, preventing triggering of `:hover`\n\n## Using custom shapes\n\n`Annotation` supports three shapes by default, `RECTANGLE`, `POINT` and `OVAL`.\n\nYou can switch the shape selector by passing the appropriate `type` as a property. Default shape `TYPE`s are accessible on their appropriate selectors:\n\n```js\nimport {\n PointSelector,\n RectangleSelector,\n OvalSelector\n} from 'react-image-annotation/lib/selectors'\n\n\n```\n\n### Adding custom selector logic\n\n#### This is an Advanced Topic\n\nThe Annotation API allows support for custom shapes that use custom logic such as polygon or freehand selection. This is done by defining your own selection logic and passing it as a selector in the `selectors` property.\n\nSelectors are objects that must have the following properties:\n\n- `TYPE` - string that uniquely identifies this selector (i.e. `RECTANGLE`)\n- `intersects` - method that returns true if the mouse point intersects with the annotation geometry\n- `area` - method that calculates and returns the area of the annotation geometry\n- `methods` - object that can contain various listener handlers (`onMouseUp`, `onMouseDown`, `onMouseMove`, `onClick`). These listener handlers are called when triggered in the annotation area. These handlers must be reducer-like methods - returning a new annotation object depending on the change of the method\n\nYou can view a defined `RectangleSelector` [here](src/hocs/RectangleSelector.js)\n\n### Connecting selector logic to Redux/MobX\n\nFirst see [Selectors](#adding-custom-selector-logic)\n\nYou can use `Selector` methods to connect these method logic to your stores. This is due to the fact that selector methods function as reducers, returning new state depending on the event.\n\n***Note that it is not necessary to connect the selector logic with redux/mobx. Connecting the annotation and annotations state is more than enough for most use cases.***\n\n## License\n\nMIT\n" }, { "path": "demo/public/404.html", "content": "\n\n \n \n Single Page Apps for GitHub Pages\n \n \n \n \n\n" }, { "path": "demo/src/App.js", "content": "import React from 'react'\nimport { BrowserRouter as Router, Route } from 'react-router-dom'\nimport styled from 'styled-components'\n\nimport NavBar from './components/NavBar'\nimport Root from './components/Root'\nimport Home from './components/Home'\nimport Docs from './components/Docs'\nimport Footer from './components/Footer'\n\nconst Main = styled.main`\n margin: 0 16px;\n margin-top: 51px;\n`\n\nexport default () => (\n \n \n \n
\n \n \n
\n