# @fnet/geopattern

> **The bundled version of https://github.com/btmills/geopattern in flownet.**

Latest version **0.1.8** (published 2024-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fnet/geopattern
pnpm add @fnet/geopattern
yarn add @fnet/geopattern
bun add @fnet/geopattern
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2024-09-21 |
| First published | 2024-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 178.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gboyraz |

## Links

- npm: https://www.npmjs.com/package/@fnet/geopattern
- Repository: https://gitlab.com/fnetai/geopattern
- Homepage: https://gitlab.com/fnetai/geopattern#readme
- Issues: https://gitlab.com/fnetai/geopattern/issues
- npm.io page: https://npm.io/package/@fnet/geopattern

## Recent versions

- 0.1.8 (latest) — 2024-09-21
- 0.1.7 — 2024-09-21
- 0.1.6 — 2024-09-21
- 0.1.5 — 2024-09-21
- 0.1.4 — 2024-09-21
- 0.1.3 — 2024-09-21
- 0.1.2 — 2024-09-21
- 0.1.1 — 2024-09-21

## README

# @fnet/geopattern

**The bundled version of  https://github.com/btmills/geopattern in flownet.**

The `@fnet/geopattern` project is a source code written in JavaScript. The code is meant to *generate geometric patterns* that can add a unique, attractive visual element to an interface or a web page. 

The primary purpose of `@fnet/geopattern` is to generate SVG (Scalable Vector Graphics) geometric patterns. This library takes a string input, and returns an SVG pattern in the form of a data URL, ready to use as a CSS background-image.

The library generates a pattern based on the hash of the provided string. Therefore, the same input always produces the same output pattern, ensuring consistency across multiple uses. If no string is provided, it generates a pattern based on current date and time as the default.

The `@fnet/geopattern` library can be used to create patterns of different geometric shapes. Some forms it can generate are sine waves, octagons, overlapping circles, nested squares, concentric circles, triangles, plus signs, xes, and many others. It offers developers a high level of customization, allowing them to define pattern generator, base color, color function, and specify whether to include a specific SVG element or not.

The library further ensures that the patterns are visually appealing by calculating color based on the hash of the input string. It uses the hue-saturation-lightness (HSL) color model for this purpose.

In short, `@fnet/geopattern` is an incredibly resourceful library for developers and designers who want to incorporate unique, predictable, and appealing geometric patterns into their projects.

---
_Source: https://npm.io/package/@fnet/geopattern · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._