Skip to content

nejdetkadir/phlex-heroicons

BranchesTags

Repository files navigation

Gem Version test rubocop Ruby Style Guide Ruby Version

Phlex::Heroicons

Heroicons extension for Phlex. Includes all icons along with solid and outline variants found in Heroicons.

Installation

Add this line to your application's Gemfile:

gem 'phlex-heroicons'

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

$ bundle add phlex-heroicons

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install phlex-heroicons

Configuration

Phlex::Heroicons.configure do |config|
  config.default_class = 'h-6 w-6'
  config.default_variant = :solid
end

Phlex::Heroicons.configuration.default_class = 'h-4 w-4'
Phlex::Heroicons.configuration.default_variant = :outline

Usage

class Hello < Phlex::HTML
  def initialize(name:)
    @name = name
  end

  def view_template
    div do
      render Phlex::Heroicons::HandRaised.new(variant: :solid, classes: 'h-4 w-4')
      h1 { "Hello #{@name}!" }
    end
  end
end

Also

<%= render Phlex::Heroicons::HandRaised.new(variant: :solid, classes: 'h-4 w-4') %>
<h1>Hello <%= current_user.name %></h1>

Icons

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

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

About

Heroicons extension for Phlex

Topics

ruby extension view rails-views phlex heroicons view-component phlex-heroicons

Resources

Readme

License

MIT license

Code of conduct

Code of conduct
Activity

Stars

25 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases 2

v1.1.0 Latest
Dec 19, 2023
+ 1 release

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages