phlex-remixicon

Phlex Remix Icon

Remix Icon implementation for Phlex

Highlights

• 🎨 2800+ icons
• 🚀 Lazy Loading

Installation

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

bundle add phlex-remixicon

Or add this line to your application's Gemfile:

gem "phlex-remixicon"

Then add the following to your ApplicationComponent:

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

Usage

class Home::IndexView < ApplicationView
  def view_template
    # Render "award" icon
    render AwardFillIcon.new(size: 128, class: "text-amber-500")
  end
end

Configuration

You can configure the icon pack by creating an initializer:

# config/initializers/phlex_remixicon.rb

Phlex::Remixicon.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/remixicon/version.rb to match the Remix Icon version, and then open a pull request.

Thanks! ✌️

Roadmap

• GitHub Actions to automatically update icons
• Tests

Inspiration

This project was inspired by other icon implementations for Phlex:

• phlex-lucide - A great implementation of Lucide Icons for Phlex.
• phlex-heroicons - Another excellent implementation, focusing on Heroicons.

Both projects influenced the design and structure of Phlex::Remixicon. We thank the authors for their inspiration and contributions to the Phlex ecosystem.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phlex-remixicon. 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::Remixicon project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.