phlex-tabler_icons 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25208c4eff094e4513e3d4a4560d7e0ac9c218b163e9930762ff2771cfb48571
-  data.tar.gz: e8f5d8f72a95f789d1932795f3fffdc8b0ec0081ee5cc0c9ee10637d77c0d7bb
+  metadata.gz: ee19e92dadbd63344e0c143f5ca1b88baf2d0a073741b7f01defc435637c079a
+  data.tar.gz: 2e99fafd9e41628a950465c6ec8716f08b4339b2c553d674bd6fdc9ce1970a95
 SHA512:
-  metadata.gz: f378c9e860300d9ba097a1f831cd24dd71456cc4b1989090b6307ba7f2e186bd38526dc50219a19b330df89e3faf31739128d389c87c66d98f1527cc3c002b09
-  data.tar.gz: f6d66e458ab0a5cbecbbdcb875a3e81daa09b395191f167576d36fa2c0a0fc5b5610240d3ea325aec7a1c6a00ce64095cbd765f9da06cc6c3e540f5a2b1d6aae
+  metadata.gz: 27762634b5036b663da38f01f0c12b55243b4f3afa6e20394bf9bb247efe63f35d7f444b3386ba0e1fae33308b85eef7dddbf1e8d1560a636310b5252ce9adfd
+  data.tar.gz: 7484d3722956c5a8b0e9151265a7769d3f0ded71d5958996858f861aa74ef3926236157ab1a272598e7390f45ecf2392c1e55ea7a924e65a84a565ed95b6b4d7

data/README.md

@@ -1,17 +1,32 @@
 # Phlex Tabler Icons
 
+[![Gem Version](https://badge.fury.io/rb/phlex-tabler_icons.svg)](https://badge.fury.io/rb/phlex-tabler_icons)
+
 This is a port of [Tabler Icons](https://tabler.io/icons) to [Phlex](https://www.phlex.fun/)
 
-NOTE: Currently it only supports outlined icons. Will add filled icons soon.
+> [!NOTE]
+> Currently the gem only supports outlined icons. Filled icon variants will be introduced soon.
 
 ## Instructions
 
-Add the gem to your application
+### Installation
+
+Add the gem to your application:
 
 ```bash
 bundle add phlex-tabler_icons
 ```
 
+That's it!
+
+### Usage
+
+Simply render the desired icon in your views. The name of the icon is the same as in the Tabler Icons library, just in pascal case.
+
+```ruby
+render Phlex::TablerIcons::Rocket.new(class: "h-8 w-8", stroke_width: 1.5)
+```
+
 ## Configuration
 
 Add the following to your initializers

data/lib/phlex/tabler_icons/icon.rb

@@ -3,18 +3,12 @@ require "phlex"
 module Phlex
   module TablerIcons
     class Icon < Phlex::SVG
-      attr_reader :classes, :height, :width, :stroke_width
-
-      def initialize(
-        classes: Phlex::TablerIcons.configuration.default_class,
-      	height: Phlex::TablerIcons.configuration.default_height,
-        width: Phlex::TablerIcons.configuration.default_width,
-        stroke_width: Phlex::TablerIcons.configuration.default_stroke_width
-      )
-        @class = classes
-      	@height = height
-        @width = width
-        @stroke_width = stroke_width
+      # TODO Remove options[:classes] in future versions
+      def initialize(**options)
+        @class = options[:class] || options[:classes] || Phlex::TablerIcons.configuration.default_class # :classes are for backward compatibility - will be removed in future versions
+        @width = options[:width] || Phlex::TablerIcons.configuration.default_width
+      	@height = options[:height] || Phlex::TablerIcons.configuration.default_height
+        @stroke_width = options[:stroke_width] || Phlex::TablerIcons.configuration.default_stroke_width
       end
     end
   end

data/lib/phlex/tabler_icons/version.rb

@@ -1,5 +1,5 @@
 module Phlex
 	module TablerIcons
-	  VERSION = "0.2.0"
+	  VERSION = "0.2.2"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-tabler_icons
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Elvinas Predkelis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex