geo_pattern

README

geo_pattern

now create beautiful generative background images from a string in golang.

Go port of Jason Long's awesome GeoPattern library.

Read geo_pattern's development story geo_pattern: going on the Go path

Generate beautiful tiling SVG patterns from a string. The string is converted into a SHA and a color and pattern are determined based on the values in the hash. The color is determined by shifting the hue from a default (or passed in) base color. One of 16 patterns is used (or you can specify one) and the sizing of the pattern elements is also determined by the hash values.

You can use the generated pattern as the background-image for a container. Using the base64 representation of the pattern still results in SVG rendering, so it looks great on retina displays.

See the GitHub Guides site as an example of this library in action. GitHub Guides use Original Ruby implementation.

####Installation go get github.com/pravj/geo_pattern

####Usage Example directory contains sample go programs that explains use of geo_pattern

####API

#####Arguments for functions returning pattern's string

######phrase : custom pattern phrase

args := map[string]string{"phrase": "My Custom Phrase"}

######generator : custom pattern type

args := map[string]string{"generator": "plaid"}

######color : custom background color

args := map[string]string{"color": "#3b5998"}

######base_color : custom base color that decides background color

args := map[string]string{"base_color": "#ffcc00"}

---

#####Functions provided by package for pattern's string representation

######Get the SVG string :

Generate(args)

######Get the Base64 encoded string :

Base64_string(args)

######Get uri image string :

Uri_image(args)

####Available Pattern

chevrons

concentric_circles

diamonds

hexagons

mosaic_squares

nested_squares

octagons

overlapping_circles

overlapping_rings

plaid

plus_signs

sine_waves

squares

tessellation

triangles

xes

####Dependencies go-colorful : for color space conversion

---

Made with Muzi and Appy by Pravendra Singh

Documentation

Overview

Package geo_pattern creates beautiful generative background image patterns from a string.

Index

• func Base64_string(args map[string]string) string
• func Generate(args map[string]string) string
• func Uri_image(args map[string]string) string

Functions

func Base64_string

func Base64_string(args map[string]string) string

Returns pattern's Base64 encoded string

func Generate

func Generate(args map[string]string) string

Returns pattern's SVG string

func Uri_image

func Uri_image(args map[string]string) string

Returns pattern's uri image string