heroicons_helper 0.4.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80e090d354ed7b42e47a7436e723b4bd438a75aaa558856a830ed78a3fcbb3d5
4
- data.tar.gz: 475b59fd40ed8e85775eb620131fa0425f17608d6d1c8f2d1f4aa90c8327735b
3
+ metadata.gz: bbbab8ccd0d05be04deb3df081747364d962a5e21e581d427b0ebbeff67b54ae
4
+ data.tar.gz: fcff746233b82222604d54d5f5e01cfd5760de65892532c8cfb4ad4c5cc64505
5
5
  SHA512:
6
- metadata.gz: d45fea85415d4fac7ed79f0cf1563dd3fd7dabf87780714dc41d5e3bc09ca3d9581d58f1312db7be08f9803fad2389417b90d3aea1fb74acb18c0ffe8b4ad1ff
7
- data.tar.gz: 703138870cb157f666d37d3df838dfaccd1b5d12d20c2e98c78ec7db2b57ed804c074c00a220d61e431104b62ae9168eb9eb9c12c88805ab9a24581fe8c53d09
6
+ metadata.gz: e539907cca91fa6a1f9ed11651238721bb8b7949184d4f8270ea58a5b73855257714d5ed97378cc7613857e31dd1dbcf927be05bbb487dc1fbc462f3c8a990fa
7
+ data.tar.gz: 36b3b4fe61cd709b59e36c61f8a05d2a2ce024bc11d6ff6bd54bce07990954516eb63df36f4caeddb384153ae711aa496ad64d338391e1fcea0ee2cc1e79ee61
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # HeroiconsHelper
2
2
 
3
- This gem helps you use Heroicons in your Ruby projects. It's inspired by [heroicons-ruby](https://github.com/chunlea/heroicons-ruby) and [octicons](https://github.com/primer/octicons).
3
+ This gem helps you use Heroicons in your Ruby projects. It's inspired by [heroicons-ruby](https://github.com/chunlea/heroicons-ruby) and [octicons_gem](https://github.com/primer/octicons/tree/main/lib/octicons_gem).
4
4
 
5
5
  ## Installation
6
6
 
@@ -25,19 +25,19 @@ include HeroiconsHelper
25
25
  You'll have a brand new method called `heroicon` whose signature looks like this:
26
26
 
27
27
  ```ruby
28
- heroicon(symbol, variant, attributes: {})
28
+ heroicon(icon, variant, attributes: {})
29
29
  ```
30
30
 
31
31
  where
32
32
 
33
- * `symbol` is the heroicons name
34
- * `variant` is the type of Heroicons (eg., `outline` or `solid`)
33
+ * `icon` is the Heroicon name (eg. `:bell` or `"bell")
34
+ * `variant` is the type of Heroicons (eg., `outline`, `solid`, or `mini`)
35
35
  * `attributes` are any additional HTML attributes to add on to the resulting `svg` element
36
36
 
37
37
  This one method call returns an object that represents the Heroicon, and you should call `to_svg` to get the resulting SVG string:
38
38
 
39
39
  ```ruby
40
- outline_icon = heroicon("x", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
40
+ outline_icon = heroicon("x-mark", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
41
41
  puts outline_icon.to_svg
42
42
  ```
43
43
  ```