Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ship-components/ship-components-highlight-click
React component that generates a visual hightlight of a click
https://github.com/ship-components/ship-components-highlight-click
babel javascript javascript-library jsx react reactjs webpack
Last synced: about 2 months ago
JSON representation
React component that generates a visual hightlight of a click
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-highlight-click
- Owner: ship-components
- License: mit
- Created: 2015-09-28T16:42:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-02T23:01:59.000Z (over 6 years ago)
- Last Synced: 2024-10-13T11:26:27.591Z (3 months ago)
- Topics: babel, javascript, javascript-library, jsx, react, reactjs, webpack
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ship-components-highlight-click
- Size: 133 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ship-components-highlight-click
[React](http://facebook.github.io/react/) component that generates a visual hightlight of a click. Exports a commonjs module that can be used with [webpack](http://webpack.github.io/) or [browserify](http://browserify.org/). Source is in ES6 and is compiled down to ES5 using [Babel](https://babeljs.io/).
[](https://www.npmjs.com/package/ship-components-highlight-click)
[](https://travis-ci.org/ship-components/ship-components-highlight-click)
[](https://codeclimate.com/github/ship-components/ship-components-highlight-click)
[](https://coveralls.io/github/ship-components/ship-components-highlight-click?branch=master)
[](https://david-dm.org/ship-components/ship-components-highlight-click?type=dev)
## Usage
### With Babel (Recommended)
The component is written using ES6/JSX therefore Babel is required to directly use it. The below example is based on using [webpack](http://webpack.github.io/) and [babel-loader](https://github.com/babel/babel-loader).
```js
import React, { Component } from 'react';
import HighlightClick from 'ship-components-highlight-click';
export default class Button extends Component {
render() {
return (
Submit
);
}
}
```
## Tests
1. `npm install`
2. `npm test`
## History
* 1.0.1 - React 16 compatibility, fixed dependencies
* 1.0.0 - Updated babel to env, switched eslint to a shared config
* 0.3.0 - Update babel preset, prop-types, Travis node versions, react-dom/test-utils
* 0.2.0 - Fixes tests to pass, adds coveralls, Travis CI and ESLint script
* 0.1.6 - Update to react >= 15
* 0.1.5 - Fixed invalid props warning and other issues related to renaming
* 0.1.4 - Initial
## License
The MIT License (MIT)
Copyright (c) 2017 Isaac Suttell
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.