https://github.com/bhathiyaprasad/bp-color-library

A simple JavaScript library created by Me to retrieve color names from HEX color codes. Easily convert color codes to human-readable names for your web or app projects. Published and available on npm.
https://github.com/bhathiyaprasad/bp-color-library

bp-color-library color-library hex hex-color-code javascript open-source

Last synced: about 1 month ago
JSON representation

A simple JavaScript library created by Me to retrieve color names from HEX color codes. Easily convert color codes to human-readable names for your web or app projects. Published and available on npm.

• Host: GitHub
• URL: https://github.com/bhathiyaprasad/bp-color-library
• Owner: BhathiyaPrasad
• License: apache-2.0
• Created: 2024-11-21T06:42:58.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-11-22T07:18:07.000Z (about 1 month ago)
• Last Synced: 2024-11-22T08:21:34.442Z (about 1 month ago)
• Topics: bp-color-library, color-library, hex, hex-color-code, javascript, open-source
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/bp-color-library
• Size: 342 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# BP Color Library 🌈

**BP Color Library** is a lightweight and straightforward utility for developers to fetch color names by providing HEX color codes. Simplify your design and development workflows with this easy-to-use library.

## 🌟 Features

1. Lightweight: Designed to be fast and minimal.

2. Flexible: Works seamlessly with JavaScript and modern frameworks.

3. Useful: Ideal for design systems, educational tools, or any project dealing with colors.

## 🛠 Usage

```bash

const { getColorName } = require('bp-color-library');

```

For testing

```bash

console.log(getColorName('#add8e6')); 

```

## 📝 Documentation

### Function : getColorName

1. Parameters:

hex (string): A valid HEX color code (e.g., #FF5733).

2. Returns:

string: The corresponding color name, or "Unknown color" if the HEX code is not recognized.

## 📦 Contributing

1. Fork the repository.

2. Create a new branch (feature/my-new-feature).

3. Commit your changes (git commit -am 'Add some feature').

4. Push your branch (git push origin feature/my-new-feature).

5. Create a pull request to the main repository.

## ❤️ Support

1. Giving the repository a ⭐ on GitHub.

2. Sharing it with your friends and colleagues.

3. Providing feedback or reporting issues to help us improve.

4. **Sponsor me on GitHub**  

   If you'd like to support my work, you can sponsor me on GitHub:  

   [Sponsor Bhathiya Prasad on GitHub](https://github.com/sponsors/BhathiyaPrasad)

5. If you enjoy my work, consider buying me a coffee to show your support:

   [Buy Me a Coffee](https://buymeacoffee.com/bhathiyaprasad)

## Visit the repository here

[BP Color Library GitHub Repository](https://github.com/BhathiyaPrasad/bp-color-library)

## 📧 Feedback

**If you have any questions, suggestions, or feedback, feel free to reach out:**

1. Open an issue on GitHub: GitHub Issues

2. Contact the author: [Bhathiya Prasad](@BhathiyaPrasad)