rails_heroicon 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bbf437db928e0434dc41d19883169e82e2ac71f6eb7f13b522a0b007ab985a
-  data.tar.gz: f8a32e12aed0a8e67f69010f74c9cde76dcb46ab794e47a7f9a64e5d5a72421e
+  metadata.gz: 7066330af025503037386934bb85b01ea667ac9023458537cb9b1db666454ac4
+  data.tar.gz: 1902d158e635fa54a3ede410b3660f73471d3fcc49b19cc7a864741b6cc1d3c9
 SHA512:
-  metadata.gz: f94f30823842910c911de2d7ae79c4b786040b5867638c3f38d1b584fffbaa7d20c8c9fcc22fc8587bd9d2bd99a079def7bf9941c048f6f483b86aa7c06da8de
-  data.tar.gz: 54e09b7c5a9714ff481412c9b50a2233a70e5fe44424c1422320f9bcd386e78a569545a8b12c304c6c5fe72cfe5cb2e1cd57823b94782f9af7184c9d1a4bab2f
+  metadata.gz: 01d011fe25319a09ece1123468633742129add088978676ebb6d436d7d964bb2e4e260e5b75c87c023819642935046f707d4f811a915037bcfe030245c260772
+  data.tar.gz: 0bea7dda8f59600433cf0828405cc73504b028f0cc9848a00f6ab148e96c038f358fbe92e1adf166e43d8138169598d98e06d22e91362f370a93fc0d1077fe02

data/README.md

@@ -3,7 +3,7 @@
 Ruby on Rails views helper for the awesome heroicons by Steve Schoger. To see
 all the icons visit [heroicons](https://heroicons.com/).
 
-All icons are included upto heroicons v0.4.2
+280 icons included as of today.
 
 > This gem has no official affiliation with [Tailwind Labs](https://github.com/tailwindlabs),
 > yet.
@@ -37,11 +37,13 @@ This will generate the following html:
 
 ```html
 <svg
+  aria-hidden="true"
   width="24"
   height="24"
   viewBox="0 0 24 24"
   fill="none"
   stroke="currentColor"
+  stroke-width="1.5"
   version="1.1"
 >
   <path
@@ -59,9 +61,11 @@ This will generate the following html:
 </svg>
 ```
 
+> Note: Indentation is for readibility purpose.
+
 ### Variant
 
-`rails_heroicon` provides 2 variants, `outline` and `solid`, `outline` being
+`rails_heroicon` provides 3 variants, `outline`, `solid`, and `mini`, `outline` being
 the default.
 
 To change the variant `<%= heroicon "user", variant: "solid" %>`.
@@ -84,8 +88,8 @@ need to set the `size` attribute on the helper method.
 <%= heroicon "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`.
+If the `variant` is set as `outline` or `solid`, `size` automatically defaults to `24`,
+and if the `variant` is set as `mini`, `size` automatically defaults to `20`.
 However, this can be over-written with the `size` attribute.
 
 ### Accessibility
@@ -93,6 +97,13 @@ However, this can be over-written with the `size` attribute.
 `rails_heroicon` 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