Categorygithub.com/pravj/geopattern
modulepackage
1.4.1
Repository: https://github.com/pravj/geopattern.git
Documentation: pkg.go.dev

# 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

# Packages

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 svg provide methods to work effortlessly with SVG.
Package utils provide utility functions that helps development across the project.

# Functions

Base64String returns pattern's Base64 encoded string.
Generate returns pattern's SVG string.
URIimage returns pattern's uri image string.