clip-path-polygon
v0.1.14
Published
jQuery plugin that makes easy to use clip-path on whatever tag under different browsers
Downloads
268
Readme
clip-path-polygon 
This is a jQuery plugin that makes using clip-path property easy on whatever tag under different browsers.
Tested on latest Chrome, Safari, Firefox and Opera.
It should work on Chrome ≥31, Firefox ≥31, Safari ≥7 and Opera ≥30.
What it does?
Let's say that you want to achieve something like this:
Take a look at the example html file!
So you need to have a rectangle (e.g. 300x200) and you have to crop this image with such coordinates:
(0; 0), (145; 0), (150; 20), (155; 0), (300; 0), (300; 200), (0; 200), (0; 0)
Absolute values
In Webkit all you have to do is to write a css style:
-webkit-clip-path: polygon(0 0, 145px 0, 150px 20px, 155px 0, 300px 0, 300px 200px, 0 200px, 0 0)
In Firefox and in W3C standard what you should do is:
clip-path: url(#my-definition) and somewhere in the file:
<svg>
<defs>
<clippath id="my-definition">
<polygon points="0 0, 145 0, 150 20, 155 0, 300 0, 300 200, 0 200, 0 0"></polygon>
</clippath>
</defs>
</svg>Relative values
If your design is resposive, you might want to use relative unit - percents. Then, the expected values would be:
- Webkit:
polygon(0 0, 49% 0, 50% 10%, 51% 0, 100% 0, 100% 100%, 0 100%, 0 0) - Firefox:
<polygon points="0 0, 0.49 0, 0.5 0.1, 0.51 0, 1 0, 1 1, 0 1, 0 0"></polygon>
clip-path-polygon does this job for you!
Installation
Npm
Install with https://npmjs.org or add it to your package.json:
$ npm install clip-path-polygon
Then require it:
require('clip-path-polygon');and use:
$myElement.clipPath();Bower
$ bower install clip-path-polygon --save
and then add bower_components/clip-path-polygon/build/clip-path-polygon.min.js to your scripts.
<script src="bower_components/clip-path-polygon/build/clip-path-polygon.min.js"></script>I'm assuming here that your bower installation folder is called bower_components.
Browser
Download clip-path-polygon.min.js (minified) or clip-path-polygon.js (dev) and add it to you HTML file:
<script src="clip-path-polygon.min.js"></script>Compilation
If you want to compile the whole package with unit tests, run:
npm install and then grunt (compilation) or grunt test (tests).
I use mocha, sinonjs and expect.js for testing.
Changelog
Changlelog is available here: CHANGELOG.md
API
Definition:
clipPath(points [, options])
You can call it on a jQuery element:
$('#my-element').clipPath(points);where points is an array of two-elements arrays: [[x0, y0], [x1, y1], [x2, y2]...] crops the element to this area defined by these points.
There are some options that you can use:
Examples
Basic
<html>
<head>
<script src="jquery.min.js"></script>
<script src="clip-path-polygon.min.js"></script>
<script>
$(function() {
var points = [[0, 0], [145, 0], [150, 20], [155, 0], [300, 0], [300, 200], [0, 200], [0, 0]];
$('#test').clipPath(points);
});
</script>
</head>
<body>
<div style="width: 300px; height: 200px">
<div id="test" style="width: 100%; height: 100%; background-color: green"></div>
</div>
</body>
</html>which gives you such an html code (remember that svg element has to have http://www.w3.org/2000/svg namespace!):
<div style="width: 300px; height: 200px">
<div id="test" style="width: 100%; height: 100%; background-color: green;
-webkit-clip-path: polygon(0 0, 145px 0, 150px 20px, 155px 0, 300px 0, 300px 200px, 0 200px, 0 0);
clip-path: url(#clipPathPolygonGenId)"></div>
</div>
<svg>
<defs>
<clippath id="clipPathPolygonGenId">
<polygon points="0 0, 145 0, 150 20, 155 0, 300 0, 300 200, 0 200, 0 0"></polygon>
</clippath>
</defs>
</svg>Relative values
To use relative values, you have to pass isPercentage option. You might want to name the SVG clippath definition differently too:
<html>
<head>
<script src="jquery.min.js"></script>
<script src="clip-path-polygon.min.js"></script>
<script>
$(function() {
var points = [[0, 0], [49, 0], [50, 10], [51, 0], [100, 0], [100, 100], [0, 100], [0, 0]];
$('#test').clipPath(points, {
isPercentage: true,
svgDefId: 'mySvg'
});
});
</script>
</head>
<body>
<div style="width: 300px; height: 200px">
<div id="test" style="width: 100%; height: 100%; background-color: green"></div>
</div>
</body>
</html>which gives you such an html code (remember that svg element has to have http://www.w3.org/2000/svg namespace!):
<div style="width: 300px; height: 200px">
<div id="test" style="width: 100%; height: 100%; background-color: green;
-webkit-clip-path: polygon(0 0, 49% 0, 50% 10%, 51% 0, 100% 0, 100% 100%, 0 100%, 0 0);
clip-path: url(#mySvg)"></div>
</div>
<svg>
<defs>
<clippath id="mySvg">
<polygon points="0 0, 0.49 0, 0.5 0.1, 51% 0, 1 0, 1 1, 0 1, 0 0"></polygon>
</clippath>
</defs>
</svg>