npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

geopattern

v1.2.3

Published

Generate beautiful SVG patterns

Downloads

38,227

Readme

GeoPattern

This is a JavaScript port of jasonlong/geo_pattern with a live preview page and is derived from the background generator originally used for GitHub Guides.

Usage

Web

Include the minified script. jQuery is optional.

<script src="js/jquery.min.js"></script> <!-- optional -->
<script src="js/geopattern.min.js"></script>

Use either the GeoPattern browser global or the jQuery plugin:

// Use the global...
var pattern = GeoPattern.generate('GitHub');
$('#geopattern').css('background-image', pattern.toDataUrl());

// ...or the plugin
$('#geopattern').geopattern('GitHub');

For backwards compatibility with the script on the Guides, the source hash for generation can be supplied with a data-title-sha attribute on the element. If the attribute exists, the generator will ignore the input string and use the supplied hash.

View geopattern.html for a complete example.

Node.js

npm install geopattern

After requiring geopattern, the API is identical to the browser version, minus the jQuery plugin.

var GeoPattern = require('geopattern');
var pattern = GeoPattern.generate('GitHub');
pattern.toDataUrl(); // url("data:image/svg+xml;...

API

GeoPattern.generate(string, options)

Returns a newly-generated, tiling SVG Pattern.

  • string Will be hashed using the SHA1 algorithm, and the resulting hash will be used as the seed for generation.

  • options.color Specify an exact background color. This is a CSS hexadecimal color value.

  • options.baseColor Controls the relative background color of the generated image. The color is not identical to that used in the pattern because the hue is rotated by the generator. This is a CSS hexadecimal color value, which defaults to #933c3c.

  • options.generator Determines the pattern. All of the original patterns are available in this port, and their names are camelCased.

Pattern.color

Gets the pattern's background color as a hexadecimal string.

GeoPattern.generate('GitHub').color // => "#455e8a"

Pattern.toString() and Pattern.toSvg()

Gets the SVG string representing the pattern.

Pattern.toBase64()

Gets the SVG as a Base64-encoded string.

Pattern.toDataUri()

Gets the pattern as a data URI, i.e. data:image/svg+xml;base64,PHN2ZyB....

Pattern.toDataUrl()

Gets the pattern as a data URL suitable for use as a CSS background-image, i.e. url("data:image/svg+xml;base64,PHN2ZyB...").

License

Licensed under the terms of the MIT License, the full text of which can be read in LICENSE.