rails_iowaicon 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3ee7e63831c77ae5bc46c22e6d0cf1ba3f68df8801eaa37fdca2bef776e92c9
+  data.tar.gz: 879988f6c79d03e91e7cb9db17ef6370cbea3152a0c5854d156e80b9a1d394ac
+SHA512:
+  metadata.gz: 4858e690b38a0ed2a4971a1f603869bcc55a8fb2d4c7dd702ba49d82cee9d4ff9a599f0dee0f85ff98dae1f5076d72f16467527085f6bd84b7debe0a6033b21c
+  data.tar.gz: '0081101a7a402f42a43b11fd0711c533896780d03104bdb281000c3f583ad4e0fc96061a6ec05da59207ffd17ee1eb671a058638f58edf31cabeaddc05bd8dc9'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 abeidahmed
+
+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.

data/README.md

@@ -0,0 +1,117 @@
+# Rails Heroicon ![ci](https://github.com/abeidahmed/rails-heroicon/actions/workflows/ci.yml/badge.svg)
+
+Ruby on Rails views helper for Iowa branded icons. To see
+all the icons visit [Iowa Branding](https://brand.uiowa.edu/).
+
+500 icons included as of today.
+
+> This gem started as a fork of [rails_heroicon](https://github.com/abeidahmed/rails-heroicon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_iowaicon"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rails_iowaicon
+```
+
+## Usage
+
+After installing the gem, call `<%= heroicon "user" %>` on your `erb` template.
+The first argument is the icon name. All the icons are listed [here](https://heroicons.com/).
+
+This will generate the following html:
+
+```html
+<svg
+  width="24"
+  height="24"
+  viewBox="0 0 24 24"
+  fill="none"
+  stroke="currentColor"
+  version="1.1"
+>
+  <path
+    d="M16 7C16 9.20914 14.2091 11 12 11C9.79086 11 8 9.20914 8 7C8 4.79086 9.79086 3 12 3C14.2091 3 16 4.79086 16 7Z"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  />
+  <path
+    d="M12 14C8.13401 14 5 17.134 5 21H19C19 17.134 15.866 14 12 14Z"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  />
+</svg>
+```
+
+### Variant
+
+`rails_iowaicon` provides 2 variants, `outline` and `solid`, `outline` being
+the default.
+
+To change the variant `<%= iowaicon "graduation-cap", variant: "solid" %>`.
+
+### HTML attributes
+
+Any `html` and `eruby` attribute is supported, for eg:
+
+```erb
+<%= graduation-cap "graduation-cap", class: "text-gray-500", aria: { label: "user-icon" } %>
+```
+
+### Handling the size of the icon
+
+Normally, if you're just using vanilla iowaicon with [Tailwind CSS](https://tailwindcss.com/),
+you'd add `w-5 h-5` as classes on the svg element. With `rails_iowaicon`, you just
+need to set the `size` attribute on the helper method.
+
+```erb
+<%= iowaicon "user", size: 20 %>
+```
+
+If the `variant` is set as `outline`, `size` automatically defaults to `24`,
+and if the `variant` is set as `solid`, `size` automatically defaults to `20`.
+However, this can be over-written with the `size` attribute.
+
+### Accessibility
+
+`rails_iowaicon` automatically sets `aria-hidden="true"` if `aria-label` is not
+set, and if `aria-label` is set, then `role="img"` is set.
+
+### Tooltip
+
+You can provide tooltips on hover if you pass in a `title` option. Anything
+passed into the `title` option will be rendered inside of a
+`<title>` tag within the rendered SVG, which modern browsers will lean on to
+display a tooltip on hover.
+
+## Development
+
+- Clone the repo
+- Run `bundle install`, or run `./bin/setup`
+- Run `bundle exec rake` to run the tests to see if it passing
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Similar projects
+
+- [rails_heroicon](https://github.com/abeidahmed/rails_heroicon)Ruby on Rails views helper method for rendering heroicons
+- [rails_feather](https://github.com/abeidahmed/rails_feather) - Ruby on Rails
+  views helper method for rendering beautiful feather icons.