geopattern

package module
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2015 License: MIT Imports: 3 Imported by: 12

README

geopattern

Create beautiful generative image patterns from a string in golang.

Go port of Jason Long's awesome GeoPattern library.

GoDoc

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

Nested Squares Pattern

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/geopattern

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

####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"}

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

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

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

######Get the SVG string :

Generate(args)

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

Base64String(args)

######Get uri image string :

URIimage(args)

####Available Pattern

chevrons

Chevrons

concentric-circles

Concentric-Circles

diamonds

Diamonds

hexagons

Hexagons

mosaic-squares

Mosaic-Squares

nested-squares

Nested-Squares

octagons

Octagons

overlapping-circles

Overlapping-Circles

overlapping-rings

Overlapping-rings

plaid

Plaid

plus-signs

Plus-Signs

sine-waves

Sine-Waves

squares

Squares

tessellation

Tessellation

triangles

Triangles

xes

Xes

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


Made with Muzi and Appy by Pravendra Singh

Documentation

Overview

Package geopattern creates beautiful generative image patterns from a string.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Base64String added in v1.4.0

func Base64String(args map[string]string) string

Base64String returns pattern's Base64 encoded string

func Generate

func Generate(args map[string]string) string

Generate returns pattern's SVG string

func URIimage added in v1.4.0

func URIimage(args map[string]string) string

URIimage returns pattern's uri image string

Types

This section is empty.

Directories

Path Synopsis
Package pattern implements methods to generate a new pattern background for the pattern, type of pattern and particular SVG structure for that pattern
Package pattern implements methods to generate a new pattern background for the pattern, type of pattern and particular SVG structure for that pattern
Package shapes implements some geometric shapes to be used in project
Package shapes implements some geometric shapes to be used in project
Package svg provide methods to work effortlessly with SVG.
Package svg provide methods to work effortlessly with SVG.
Package utils provide utility functions that helps development across the project.
Package utils provide utility functions that helps development across the project.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL