Skip to content

Gleamy is a light-weight React component library for creating shiny user interfaces with metal foils, sparkles, and other effects that responds on user interaction.

License

Notifications You must be signed in to change notification settings

gleamy-js/gleamy

Repository files navigation

gleamy license Published version snyk gleamy stats NPM Downloads NPM Minified size

🪩 Gleamy

Welcome to Gleamy, the magical React component library that's sure to make your projects sparkle! With Gleamy, you'll be able to bring a piñata to a funeral, a disco ball to a library, and even a unicorn to a board meeting! It's like adding a touch of fairy dust to even the most dull-as-dishwater projects. With its stunning colors and dynamic animations, Gleamy is sure to turn heads and leave your users mesmerized. So why settle for boring and bland when you can add a little sparkle to your life with Gleamy?

Documentation

For complete documentation, see https://www.gleamy.dev/documentation/latest

To try it before installing, use the Configurator

You can try the configurator here: https://www.gleamy.dev/components/latest. After being done, you can use the "code"-tab in the editor to copy your code and use it directly in your project, or save your swatches first.

Quick start

Installation

NPM:

npm install gleamy

Usage

Add some shine:

import { GleamyProvider, Gold } from 'gleamy';

<GleamyProvider>
    <Gold height="200" width="200" />
</GleamyProvider>

Add some sparkle:

import { GleamyProvider, Glitter } from 'gleamy';

<GleamyProvider>
    <Glitter height="200" width="200" />
</GleamyProvider>

Available components:

Metals: BlueSteel, Cobalt, Copper, Gold, Gunmetal, RoseGold, Silver, Steel Plastics: Iridescent, Lacquer Particles: Glitter Compound: Holographic

Support Gleamy

If you find Gleamy useful, please consider supporting its development! You can make a one-time donation on Ko-fi, PayPal or become a supporter on GitHub or Open Collective. Your support will help me continue to improve and maintain this project. Additionally, if you're unable to contribute financially, leaving a star on the GitHub repo or sharing Gleamy with others is also greatly appreciated. Thank you for your support!"

Fun me on OpenCollective:
Fund me using Open Collective

Sponsor me on Github:
Sponsor me on GitHub

Buy me a Coffee on KoFi:
Buy me a KoFi

Make a donation using PayPal:
Support me via PayPal

Other things

Documents