README.md

TornPaper

Creating torn edge and grunge paper effect using SVG and JavaScript.

Demo

• TornPaper.js demo https://codepen.io/wakana-k/full/PogRqLx

• clip-path animation demo https://codepen.io/wakana-k/full/RwOMdoY

• Torn paper photo gallery https://codepen.io/wakana-k/full/ExJEvor

Usage

html:

<script src="https://cdn.jsdelivr.net/gh/happy358/TornPaper@v0.0.3/tornpaper.min.js"></script>
<script>
    new Tornpaper();
</script>

css:

.your-class {
   filter: url(#filter_tornpaper);
}

e.g. With background-color

.your-class {
    filter: url(#filter_tornpaper);
    background-color: pink;
}

e.g. With background-image

.your-class {
    filter: url(#filter_tornpaper);
    background: url("https://source.unsplash.com/random/") center/cover;
}

Options

new Tornpaper({
    filterName : "filter_tornpaper", // cunstom filter-id, default:"filter_tornpaper"
    seed : 1, // random seed, default:random number
    tornFrequency : 0.05, // 0=no torn edge, default:0.05
    tornScale : 10,
    grungeFrequency : 0.03, // 0=no grunge texture, default:0.03
    grungeScale : 3
});

References

• Inspired by fguilleme. https://codepen.io/fguilleme/pen/MMyKXB

• SVG Filter Effects: Creating Texture with <feTurbulence> https://tympanus.net/codrops/2019/02/19/svg-filter-effects-creating-texture-with-feturbulence/

Thanks!