Skip to content

devalade/penpot-color-name-ext

Repository files navigation

Penpot Color Name Extension

A Penpot extension that helps designers instantly identify color names and suggests 4 similar color variants, making color selection effortless.

Features

  • 🎨 Instantly identify names for any selected color
  • 🔍 Get 4 suggested color variants closest to your selection
  • ⚡ Fast and lightweight implementation
  • 🎯 Seamless Penpot integration

Installation

  1. Clone this repository:
git clone https://github.com/devalade/penpot-color-name-ext.git
  1. Install dependencies:
pnpm install
  1. Preview:
pnpm run dev

Development

Prerequisites

  • Node.js 20.11.0+
  • pnpm
  • Penpot running locally or access to Penpot instance

Project Structure

src/
  ├── assets/
  │   ├── main.css
  │   └── penpot.css
  ├── lib/
  │   ├── color-utils.ts
  │   ├── color-utils.test.ts
  │   └── types.ts
  ├── App.svelte
  ├── plugin.svelte
  ├── types.svelte
  └── main.ts

Getting Started

  1. Run development server:
pnpm run dev
  1. Make changes in src directory
  2. Test your changes in your web browser and Penpot
  3. Build for production when ready

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

You can use this function to simulate the color name generation - be sure to uncomment the function simulateColorChange in the onMount function in App.svelte

License

MIT License

Contact

  • Create an issue for bug reports
  • Submit PRs for contributions
  • Shoot me a message on @dev_alade

Acknowledgments

  • Penpot team for the amazing platform
  • Color naming libraries contributors
  • Svelte team for v5 improvements

Built with ❤️ by devalade