heroicons_helper 0.7.0 → 0.7.1
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 +4 -4
- data/.ruby-version +1 -0
- data/.vscode/settings.json +8 -0
- data/README.md +7 -6
- data/Rakefile +6 -0
- data/lib/heroicons_helper/cache.rb +2 -2
- data/lib/heroicons_helper/data.json +1 -1
- data/lib/heroicons_helper/icon.rb +0 -1
- data/lib/heroicons_helper/version.rb +1 -1
- data/lib/heroicons_helper.rb +1 -2
- data/package-lock.json +38 -639
- metadata +9 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ac5d87867f1aefd58513112eca2bdf6f8e6e54800bedef9d34be407f06f9f36c
|
4
|
+
data.tar.gz: 51184fcc333b5dfe492a312677338c8035b5a0f5d658bbb7c4c1247388976311
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ea63f9c2fb9d2983168f13bb9fc14e86c23c1e142c4a5d1e354a079038b00e82d51c0655d893c7bd913814963b9850b2df81d3627e51909932bdc91b4f9743e9
|
7
|
+
data.tar.gz: 331963ec48860c5eefb19461232da7628927ea7f7eac29856090559bb6b112f659551f02f9d55c2a6641d779e0adcc6eebc264cbf4143991eda9db506c821a90
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
3.2.1
|
data/README.md
CHANGED
@@ -30,9 +30,9 @@ heroicon(icon, variant, attributes: {})
|
|
30
30
|
|
31
31
|
where
|
32
32
|
|
33
|
-
|
34
|
-
|
35
|
-
|
33
|
+
- `icon` is the Heroicon name (eg. `:bell` or `"bell")
|
34
|
+
- `variant` is the type of Heroicons (eg., `outline`, `solid`, or `mini`)
|
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
|
|
@@ -40,6 +40,7 @@ This one method call returns an object that represents the Heroicon, and you sho
|
|
40
40
|
outline_icon = heroicon("x-mark", variant: HeroiconsHelper::Icon::VARIANT_OUTLINE)
|
41
41
|
puts outline_icon.to_svg
|
42
42
|
```
|
43
|
+
|
43
44
|
```
|
44
45
|
=> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M6 18L18 6M6 6l12 12"></path></svg>
|
45
46
|
```
|
@@ -48,7 +49,7 @@ puts outline_icon.to_svg
|
|
48
49
|
|
49
50
|
This gem also comes with a simple caching system, which can be useful to preload icons. It works like this:
|
50
51
|
|
51
|
-
```
|
52
|
+
```ruby
|
52
53
|
icons_to_preload = [{
|
53
54
|
name: "thumb-down",
|
54
55
|
variant: "outline",
|
@@ -65,8 +66,8 @@ end
|
|
65
66
|
|
66
67
|
`HeroiconsHelper::Cache.preload!` does one of two things:
|
67
68
|
|
68
|
-
|
69
|
-
|
69
|
+
- If, given the `icons_to_preload` array, an item is located in the cache, `found` is true and `icon` is the cached item
|
70
|
+
- Otherwise, `found` is false, and `icon` is the element currently being iterated. Also, the last line of the block sets the cache
|
70
71
|
|
71
72
|
The Hash elements within `icons_to_preload` can also take `height` and `width` keys.
|
72
73
|
|
data/Rakefile
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require "bundler/gem_tasks"
|
4
|
+
require "rubygems/package_task"
|
4
5
|
require "rake/testtask"
|
5
6
|
|
6
7
|
Rake::TestTask.new(:test) do |t|
|
@@ -12,3 +13,8 @@ end
|
|
12
13
|
require "rubocop/rake_task"
|
13
14
|
|
14
15
|
RuboCop::RakeTask.new
|
16
|
+
|
17
|
+
GEMSPEC = Bundler.load_gemspec("heroicons_helper.gemspec")
|
18
|
+
gem_path = Gem::PackageTask.new(GEMSPEC).define
|
19
|
+
desc "Package the ruby gem"
|
20
|
+
task "package" => [gem_path]
|
@@ -6,8 +6,8 @@ module HeroiconsHelper
|
|
6
6
|
LOOKUP = {}
|
7
7
|
|
8
8
|
class << self
|
9
|
-
def get_key(name:, variant:, unsafe: false,
|
10
|
-
attrs = { name: name, variant: variant, unsafe: unsafe
|
9
|
+
def get_key(name:, variant:, unsafe: false, **attributes)
|
10
|
+
attrs = { name: name, variant: variant, unsafe: unsafe }.merge(attributes)
|
11
11
|
if unsafe
|
12
12
|
attrs[:unsafe] = true
|
13
13
|
else
|