Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abeidahmed/rails_feather
Ruby on Rails views helper method for rendering beautiful feather icons.
https://github.com/abeidahmed/rails_feather
feather-icons icons rails rails-feather ruby-gem
Last synced: about 1 month ago
JSON representation
Ruby on Rails views helper method for rendering beautiful feather icons.
- Host: GitHub
- URL: https://github.com/abeidahmed/rails_feather
- Owner: abeidahmed
- License: mit
- Created: 2021-03-15T08:43:10.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-30T01:23:22.000Z (almost 3 years ago)
- Last Synced: 2024-11-30T10:41:51.769Z (about 2 months ago)
- Topics: feather-icons, icons, rails, rails-feather, ruby-gem
- Language: Ruby
- Homepage: https://rubygems.org/gems/rails_feather
- Size: 111 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# rails_feather
> 286 feather icons as of today on v4.28.0
Ruby on Rails views helper method for rendering beautiful feather icons. See all
the icons [here](https://feathericons.com).
## Installation
Add this line to your application's Gemfile:
```ruby
gem "rails_feather"
```
And then execute:
```bash
bundle install
```
Or install it yourself as:
```bash
gem install rails_feather
```
## Usage
After installing the gem, call `<%= feather_icon "activity" %>` on your `erb` template.
The first argument is the icon name. All the icons are listed [here](https://feathericons.com).
This will generate the following html:
```html
```
## Handling the size of the icon
Specify a `size` param in the helper method to set the `height` and `width`
on the `svg` icon.
```erb
<%= feather_icon "activity", size: 20 %>
```
`size` defaults to `24` if not defined.
## Handling the `stroke-width` of the icon
Specify a `stroke_width` param in the helper method to set the `stroke-width`
on the `svg` icon.
```erb
<%= feather_icon "activity", stroke_width: 1 %>
```
`stroke_width` defaults to `2` if not defined.
## HTML attributes
Any `html` and `eruby` attribute syntax is supported, for eg:
```erb
<%= feather_icon "activity", class: "custom-class", aria: { label: "User activity" } %>
```
## Accessibility
`rails_feather` automatically sets `aria-hidden="true"` if `aria-label` is not
set, and if `aria-label` is set, then `role="img"` is set on the `svg`.
## Development
- Clone the repo
- Run `bundle install` or `./bin/setup`
- Run `rake` to run the tests
## Contributing
Bug reports and pull requests are welcome. This project is intended to be a
safe, welcoming space for collaboration, and contributors are expected to adhere
to the [code of conduct](https://github.com/abeidahmed/rails_feather/blob/main/CODE_OF_CONDUCT.md).
Please refer to [CONTRIBUTING.md](https://github.com/abeidahmed/rails_feather/blob/main/CONTRIBUTING.md)
for further instructions.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the rails_feather project's codebases, issue trackers,
chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abeidahmed/rails_feather/blob/main/CODE_OF_CONDUCT.md).
## Similar projects
- [rails_heroicon](https://github.com/abeidahmed/rails-heroicon) - Ruby on Rails
views helper for the awesome heroicons by Steve Schoger.