Skip to content

Commit

Permalink
Merge pull request #3231 from projectblacklight/jcoyne-patch-1
Browse files Browse the repository at this point in the history
Update documentation on IconComponent
  • Loading branch information
jcoyne authored Jul 19, 2024
2 parents 91aeb85 + 72dbb3e commit 5825c07
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions app/components/blacklight/icons/icon_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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 = '<svg>your SVG here</svg>'
# Blacklight::Icons::MyIconComponent.svg = '<svg>your SVG here</svg>'
class IconComponent < ::ViewComponent::Base
# rubocop:disable Metrics/ParameterLists
def initialize(svg: nil, tag: :span, name: nil, label: nil, aria_hidden: nil, classes: nil, **options)
Expand Down

0 comments on commit 5825c07

Please sign in to comment.