phlex-icons-remix 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6c21eca776c471d855307fec09079b679cdcf48791101eb8507c72ca0e0e301
-  data.tar.gz: 11667fb9034a1516d5ca339d256896bd342cff93b8d740ff70c760b85073db29
+  metadata.gz: 145649f881c1c518d275b84f1d6e6851b67161551267fa23516d99fd56b458ff
+  data.tar.gz: 1b46c3366238af6758be4673b8714e50f4ff2cbd3fd2588dca599bedfe084b67
 SHA512:
-  metadata.gz: e7fbede384fae5afb92579012f853798b9a83ecca222d127a4ac94bfedc4192a1a961dfaf01a58de5e809517207ef044351a1dd7af87e028438e43eacdfa4b20
-  data.tar.gz: c98480dab4e08aa020d2c73a93c41be4ccf1dc0d765dba42f2a8260c47455abf4dd44ccf5105e20e525f7c16d312f3f38acaec24d668242af9fd5cf075f599ce
+  metadata.gz: 2ba56169b4d9a8f7bf56e86ff7e73b4c1abd47c1ebf5c1368a5a1cb59cd7362eaea42919ebf3203c9910d3e09f11f203f34ad0b5ed9dfc45b48c9c45e3b4ce0d
+  data.tar.gz: 2151577b49601a4088c7a677cf6a0a6c0a5b4f0447f0a0fefeff77368050ae6518e206c8a4cf115b41e61f44edc89b61b07af69e449265f093466ec8ccb7fed4

data/README.md

@@ -21,6 +21,16 @@ General icons extension for [Phlex](https://phlex.fun). Includes more than 🎨
 
 And happy to extend to other icon packs!
 
+If you don't want to add all icon packs to your application, you can add a specific icon pack by using one (or multiple) of the following gems:
+
+- [phlex-icons-bootstrap](https://rubygems.org/gems/phlex-icons-bootstrap)
+- [phlex-icons-flag](https://rubygems.org/gems/phlex-icons-flag)
+- [phlex-icons-hero](https://rubygems.org/gems/phlex-icons-hero)
+- [phlex-icons-lucide](https://rubygems.org/gems/phlex-icons-lucide)
+- [phlex-icons-radix](https://rubygems.org/gems/phlex-icons-radix)
+- [phlex-icons-remix](https://rubygems.org/gems/phlex-icons-remix)
+- [phlex-icons-tabler](https://rubygems.org/gems/phlex-icons-tabler)
+
 Thanks [nejdetkadir](https://github.com/nejdetkadir) for creating [Phlex::Heroicons](https://github.com/nejdetkadir/phlex-heroicons) as it was the base for this gem.
 
 Other Phlex icon gems:
@@ -41,16 +51,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install phlex-icons
 ```
 
-If you don't want to add all icon packs to your application, you can add a specific icon pack by using one (or multiple) of the following gems:
-
-- [phlex-icons-bootstrap](https://rubygems.org/gems/phlex-icons-bootstrap)
-- [phlex-icons-flag](https://rubygems.org/gems/phlex-icons-flag)
-- [phlex-icons-hero](https://rubygems.org/gems/phlex-icons-hero)
-- [phlex-icons-lucide](https://rubygems.org/gems/phlex-icons-lucide)
-- [phlex-icons-radix](https://rubygems.org/gems/phlex-icons-radix)
-- [phlex-icons-remix](https://rubygems.org/gems/phlex-icons-remix)
-- [phlex-icons-tabler](https://rubygems.org/gems/phlex-icons-tabler)
-
 ## Configuration
 
 The gem provides global configuration options, and per icons pack configuration options.
@@ -124,7 +124,7 @@ Phlex::Icons::Tabler.configuration.default_variant = :outline # or :filled
 ### With `Phlex::Kit`
 
 ```ruby
-require 'phlex_icons'
+require 'phlex-icons'
 
 class PhlexIcons < Phlex::HTML
   include Phlex::Icons
@@ -146,7 +146,7 @@ end
 ### Without `Phlex::Kit`
 
 ```ruby
-require 'phlex_icons'
+require 'phlex-icons'
 
 class PhlexIcons < Phlex::HTML
   def view_template
@@ -163,6 +163,71 @@ class PhlexIcons < Phlex::HTML
 end
 ```
 
+### Specific icon pack(s)
+
+Let's say you want to use only Heroicons and Flag Icons, you can use the following gems:
+- [phlex-icons-flag](https://rubygems.org/gems/phlex-icons-flag)
+- [phlex-icons-hero](https://rubygems.org/gems/phlex-icons-hero)
+
+Then, in your application, you can use the icons like this:
+
+```ruby
+require 'phlex-icons-flag'
+require 'phlex-icons-hero'
+
+class PhlexIcons < Phlex::HTML
+  include Phlex::Icons # If you want to use Phlex::Kit.
+
+  def view_template
+    div do
+      # With Phlex::Kit.
+      Flag::Sa(variant: :rectangle, classes: 'size-4')
+      Hero::Home(variant: :solid, classes: 'size-4')
+
+      # Without Phlex::Kit.
+      render Phlex::Icons::Flag::Sa.new(variant: :rectangle, classes: 'size-4')
+      render Phlex::Icons::Hero::Home.new(variant: :solid, classes: 'size-4')
+    end
+  end
+end
+```
+
+### Add custom icons to your Rails application
+
+You can extend the gem in your Rails application to add new icons by creating a `phlex/icons/custom` directory inside `views/components` directory. Then, you can create a new component for each icon you want to add. For example:
+
+```ruby
+# app/views/components/phlex/icons/custom/icon_class_name.rb
+
+module Phlex
+  module Icons
+    module Custom
+      class IconClassName < Phlex::Icons::Base
+        def view_template
+          # SVG code here.
+        end
+      end
+    end
+  end
+end
+```
+
+Finally, you will need to create a `Phlex::Icons::Custom` module in `phlex/icons/custom.rb` file to include your custom icons and make them a `Phlex::Kit`:
+
+```ruby
+# app/views/components/phlex/icons/custom.rb
+
+module Phlex
+  module Icons
+    module Custom
+      extend Phlex::Kit
+    end
+  end
+end
+```
+
+Now, you can use your custom icons like any other icon pack as described above.
+
 ## Update icon packs
 
 All icon packs provided in this gem are auto-generated by their generator under [`generators`](/generators) directory. You just need to clone the repo and run the generator for the icon pack you want to update. In future, I'm planning to add GitHub Actions to automatically generate the icon packs and update the gem.

data/lib/phlex/icons/remix/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../base'
+
 module Phlex
   module Icons
     module Remix

data/lib/phlex/icons/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Icons
-    VERSION = '0.13.0'
+    VERSION = '0.15.0'
   end
 end

data/lib/{phlex_icons_remix.rb → phlex-icons-remix.rb}

@@ -1,3 +1,6 @@
+# rubocop:disable Naming/FileName
+# rubocop:enable Naming/FileName
+
 # frozen_string_literal: true
 
 require 'phlex'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-icons-remix
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -49,6 +49,7 @@ files:
 - generators/radix.rb
 - generators/remix.rb
 - generators/tabler.rb
+- lib/phlex-icons-remix.rb
 - lib/phlex/icons/base.rb
 - lib/phlex/icons/configuration.rb
 - lib/phlex/icons/remix.rb
@@ -2946,7 +2947,6 @@ files:
 - lib/phlex/icons/remix/zzz_fill.rb
 - lib/phlex/icons/remix/zzz_line.rb
 - lib/phlex/icons/version.rb
-- lib/phlex_icons_remix.rb
 - phlex-icons.png
 - sig/phlex/icons.rbs
 homepage: https://github.com/AliOsm/phlex-icons