From 72dbb3ec61e9aa1792d8032f2cca76540cd4f4ab Mon Sep 17 00:00:00 2001 From: Justin Coyne Date: Fri, 19 Jul 2024 09:14:41 -0500 Subject: [PATCH] Update documentation on IconComponent --- app/components/blacklight/icons/icon_component.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/components/blacklight/icons/icon_component.rb b/app/components/blacklight/icons/icon_component.rb index 2d2f924a5c..de2eb83755 100644 --- a/app/components/blacklight/icons/icon_component.rb +++ b/app/components/blacklight/icons/icon_component.rb @@ -2,9 +2,10 @@ module Blacklight module Icons - # This is the list icon for the search button. + # This is the base class for icon components. You should extend this class for each icon. + # # You can override the default svg by setting: - # Blacklight::Icons::ListComponent.svg = 'your SVG here' + # Blacklight::Icons::MyIconComponent.svg = 'your SVG here' class IconComponent < ::ViewComponent::Base # rubocop:disable Metrics/ParameterLists def initialize(svg: nil, tag: :span, name: nil, label: nil, aria_hidden: nil, classes: nil, **options)