tramway 4.1.1 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157c85b21871fba844d2da67a40213a63b7613a9110e5fd8e72b430eea52c1cb
-  data.tar.gz: 19448d06038afe21efe938b9abe4db4eca02bb37c79b63a6d3dabc303fbff362
+  metadata.gz: aba7799f773e66098f92d1471963e6fe5da4079b095264c249dc4545a1a84a00
+  data.tar.gz: 98866e7d39aa6d9a31eb9b750949d69ccd16cd2d2f8cb2421f9eb9b96b450046
 SHA512:
-  metadata.gz: d0c54e34d0017715e2b4d0b0f351abebf0f02a3029cc4762bf40c07abd0198e8945b7b1bf3e474051263afddb9a65e518fa8febdae127b323e755c67c814049f
-  data.tar.gz: 8acef7a5b516284dfa3d44901cf059f8c9632aedc41bf2bbe1a93f8c7b840bb6988f424449e9fde2f53558e0f78a5dba2cc02b61d478669bdb05318d33d6102e
+  metadata.gz: 27c456947b97709869bf23bab9eb3f72b4f30799766755fd53c58dad2ec070f0df73b574c16cea5983d3f560983ee9adb0194d84535553ba89d1748a90490005
+  data.tar.gz: b3b705af11f591965764edac7608d8af72e156d1a78d029a887e96b20b30945818df89f4ea947a0f6d945f06f90bf6db702b1a8951597c5cadb9f196c45e6227

data/README.md

@@ -177,6 +177,30 @@ Tramway.configure do |config|
 end
 ```
 
+**icon**
+
+Set `icon` on an entity to render a Font Awesome class string before its auto-generated link in the Tramway Navbar
+(the entity-based items rendered when `tramway_navbar` is called with `with_entities: true`, the default — see
+[Icons on navbar items](#icons-on-navbar-items)):
+
+*config/initializers/tramway.rb*
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :campaign,
+      namespace: :admin,
+      icon: 'fa-solid fa-bullhorn',
+      pages: [
+        { action: :index }
+      ]
+    }
+  ]
+end
+```
+
+Entities without an `icon` keep rendering as plain text links.
+
 **scope**
 
 By default, Tramway lists all records for an entity on the index page. You can narrow the records displayed by providing a
@@ -1058,7 +1082,9 @@ will render [this](https://play.tailwindcss.com/UZPTCudFw5)
 
 #### Icons on navbar items
 
-`nav.item` accepts an optional `icon:` option with a Font Awesome class string, rendered before the item's label:
+`nav.item` accepts an optional `icon:` option with a Font Awesome class string, rendered before the item's label.
+This also applies to the auto-generated entity links described in [Define entities with options](#define-entities-with-options) —
+set `icon` on an entity in `config/initializers/tramway.rb` to add an icon to its link without writing a custom `nav.item` call.
 
 ```ruby
 nav.left do

data/lib/tramway/configs/entity.rb

@@ -11,6 +11,7 @@ module Tramway
       attribute? :pages, Types::Array.of(Tramway::Configs::Entities::Page).default([].freeze)
       attribute? :route, Tramway::Configs::Entities::Route
       attribute? :namespace, Types::Coercible::String
+      attribute? :icon, Types::Coercible::String
 
       # Route Struct contains implemented in Tramway CRUD and helpful routes for the entity
       ACTIONS = %i[index show new create edit update destroy].freeze

data/lib/tramway/navbar.rb

@@ -59,7 +59,8 @@ module Tramway
       entities.each do |entity|
         next if entity.routes.index.blank?
 
-        item entity.human_name.plural, Tramway::Engine.routes.url_helpers.public_send(entity.routes.index)
+        item entity.human_name.plural, Tramway::Engine.routes.url_helpers.public_send(entity.routes.index),
+             icon: entity.icon
       end
 
       reset_filling

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '4.1.1'
+  VERSION = '4.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.2
 platform: ruby
 authors:
 - kalashnikovisme