jekyll-heroicons 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f9892ee0260b9ee330b410ed33a452cb7ca59619e2eb4545f3c769bcaa28a84
-  data.tar.gz: 10675f3ab7d06b9a2f877a56b7fca7fe605b992f7b88cf072014cafe60611a4a
+  metadata.gz: 1ea6e91e6cb36a520dca76e702ba049bace4d58ca10d9b4e052835d0326c0152
+  data.tar.gz: 2920e68dfc8f15f74915288bce410bd3ef9dd8cdfb02a3db977c9ef565f59846
 SHA512:
-  metadata.gz: 00f81defdf20e8393da9bf39347cd4a9cc083a4b4246201d8e910d0ba85d7565c6a11ba45b7346de9dc1a30f89f6481257661467385ac6b34d36e1e98a11761d
-  data.tar.gz: f280231e9dd755e81c3929f0e2338505dcb0e1c7d0c6ba0b1ed6f606a71eb84b0591ceb4647d8119ab9b437b8402928ca17f06a5ba6456261b6cc9229cbf9e72
+  metadata.gz: f9903507c9e0ebb0ec11078792689b8f3aa82544583000934e066bb254e059cfe0595e067cf58303b1540e167d857f9004c632e79ca84f5cccc2dadfeea7d372
+  data.tar.gz: 8cf3485c9eea35f1b84fd1d103ae14e3b259c5acb2d609ecd33cfc4ff5a4bc89a18217f5da8ecd7d150b3d5c70fc54298dc33bbaac50613e6346ff03640b742a

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Jekyll-Heroicons
 
+## 0.4.0
+- Add default variant as solid.
+- Adding "disable_default_class" attribute to a tag, to avoid adding default classes to the icon.
 ## 0.3.1
 - Fix Site.configuration retrieval.
 ## 0.3.0

data/README.md

@@ -25,7 +25,34 @@ This is heavily inspired by https://github.com/jclusso/heroicons
   ```
 
 ## Usage
-Configure default settings in `_config.yml`:
+```liquid
+{% heroicon bell %}
+```
+Heroicons comes in 4 variants: `solid`, `outline`, `mini`, and `micro`. The default variant is `solid`.
+This can be changed through configuration in `_config.yml`:
+
+```ruby
+heroicons:
+  variant: 'solid'
+```
+
+Another way to provide variant and override defaults defined in config is to pass 'variant' to liquid tag:
+```liquid
+{% heroicon bell variant: "mini" %}
+```
+
+It's also possible to provide classes to the icon:
+```liquid
+{% heroicon bell class: "text-red-500" %}
+```
+
+Any other attributes will be passed to the SVG tag as well. As example:
+
+```liquid
+{% heroicon bell class: "text-red-500" aria-hidden: true height:32 aria-label:hi %}
+```
+## Configuration
+Besides variants, it's also possible to define default classes for each variant. Here is a recommended default configuration for `_config.yml`:
 
 ```ruby
 heroicons:
@@ -38,17 +65,10 @@ heroicons:
   }
 ```
 
-And then you can use:
-
-```liquid
-{% heroicon bell class:"right left" %}
-```
+This default class will be applied to every icon. You can disable this on a per-icon basis by passing `disable_default_class: true`.
 
-Another way to provide variant would be like so:
 ```liquid
-{% heroicon solid/bell class:"right left"%}
-# or
-{% heroicon bell variant: "solid" class:"right left"%}
+{% heroicon bell disable_default_class: true %}
 ```
 
 ## Development

data/lib/jekyll-heroicons/version.rb

@@ -5,6 +5,6 @@ module Liquid; class Tag; end; end
 
 module Jekyll
   class Heroicons < Liquid::Tag
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/jekyll-heroicons.rb

@@ -38,7 +38,7 @@ module Jekyll
 
       return nil if @symbol.nil?
 
-      Icon.new(@symbol, @variant, @options.except(:variant)).raw
+      Icon.new(@symbol, @variant, @options.except(:variant, :disable_default_class)).raw
     end
 
     private
@@ -59,16 +59,17 @@ module Jekyll
     end
 
     def variant(markup)
-      if (match = markup.split("/")).length > 1
-        match.first
-      elsif @options.key?(:variant)
+      if @options.key?(:variant)
         @options[:variant]
-      else
+      elsif config["variant"]
         config["variant"]
+      else
+        "solid"
       end
     end
 
     def prepend_default_classes
+      return if @options[:disable_default_class].eql?('true')
       return unless config.dig("default_class", @variant)
 
       if @options[:class]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-heroicons
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll