Phlex Lucide

Lucide.dev icons implementation for Phlex.

Highlights

• 🎨 1520+ icons
• 🚀 Lazy Loading

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add phlex-lucide

Or add this line to your application's Gemfile:

gem "phlex-lucide"

Then add the following to your ApplicationComponent:

class ApplicationComponent < Phlex::HTML
  include Phlex::Lucide
end

Usage

class Home::IndexView < ApplicationView
  def view_template
    # Render "award" icon
    AwardIcon()

    # Render "award" icon with props
    AwardIcon(size: 48, class: "text-amber-500")

    # Render "award" icon without using Phlex::Kit
    render Phlex::Lucide::AwardIcon.new(size: 128, class: "text-amber-500")
  end
end

Configuration

You can configure the icon pack by creating an initializer:

# config/initializers/phlex_lucide.rb

Phlex::Lucide.configure do |config|
  config.default_size = 16
  config.default_props = { stroke_width: 4 }
end

Development

To generate the latest version of icons, run:

./bin/generate

Next, update the VERSION constant in lib/phlex/lucide/version.rb to match the Lucide version, and then open a pull request.

Thanks! ✌️

Roadmap

• [ ] GitHub Actions to automatically update icons
• [ ] Tests

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phlex-lucide. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Phlex::Lucide project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.