Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 4.46 KB

README.md

File metadata and controls

114 lines (79 loc) · 4.46 KB
Raw

lucide-rails

lucide-rails provides a view helper for using Lucide icons on Rails applications

Installation

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

    $ bundle add lucide-rails

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

    $ gem install lucide-rails

Usage

Quickstart

The gem default options should be enough for most applications. Simply add it to your Gemfile, and, in any view:

<%= lucide_icon('accessibility') %>

Which renders:

<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="16" cy="4" r="1"></circle><path d="m18 19 1-7-5.87.94"></path><path d="m5 8 3-3 5.5 3-2.21 3.1"></path><path d="M4.24 14.48c-.19.58-.27 1.2-.23 1.84a5 5 0 0 0 5.31 4.67c.65-.04 1.25-.2 1.8-.46"></path><path d="M13.76 17.52c.19-.58.27-1.2.23-1.84a5 5 0 0 0-5.31-4.67c-.65.04-1.25.2-1.8.46"></path></svg>

Providing Extra Attributes to a Single Icon

To provide extra attributes to a single SVG, pass them through the helper:

<%= lucide_icon('accessibility', 'extra-attr' => 'test') %>

Which yields the following HTML:

<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" extra-attr="test"><circle cx="16" cy="4" r="1"></circle><path d="m18 19 1-7-5.87.94"></path><path d="m5 8 3-3 5.5 3-2.21 3.1"></path><path d="M4.24 14.48c-.19.58-.27 1.2-.23 1.84a5 5 0 0 0 5.31 4.67c.65-.04 1.25-.2 1.8-.46"></path><path d="M13.76 17.52c.19-.58.27-1.2.23-1.84a5 5 0 0 0-5.31-4.67c-.65.04-1.25.2-1.8.46"></path></svg>

Providing Extra Attributes to All Icons

In case an application needs to add an extra attribute on every icon output by this library, create a new initializer, and use LucideRails.default_options=:

# config/initializers/lucide_rails.rb
LucideRails.default_options = LucideRails.default_options.merge(
  'class' => 'lucide-icon',
  'some-extra-attr' => 'some-other-value',
)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rspec to run the tests. You can also run bundle exec 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.

Updating Bundled Icons

To sync the library with the official icon repository, and regenerate all files from icons/, use bundle exec bin/fetch-icons.

Contributing

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

Code of Conduct

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

License

The MIT License (MIT)

Copyright (c) 2022 Victor Gama

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.