Module: Icons

Extended by:
Icons
Included in:
Icons
Defined in:
lib/icons.rb,
lib/icons/sync.rb,
lib/icons/errors.rb,
lib/icons/sprite.rb,
lib/icons/version.rb,
lib/icons/libraries.rb,
lib/icons/configuration.rb,
lib/icons/icon/file_path.rb,
lib/icons/icon/attributes.rb,
lib/icons/sprite/reference.rb,
lib/icons/icon/configurable.rb,
lib/icons/configuration/flags.rb,
lib/icons/configuration/radix.rb,
lib/icons/configuration/linear.rb,
lib/icons/configuration/lucide.rb,
lib/icons/configuration/tabler.rb,
lib/icons/sync/transformations.rb,
lib/icons/configuration/feather.rb,
lib/icons/configuration/options.rb,
lib/icons/configuration/weather.rb,
lib/icons/sync/process_variants.rb,
lib/icons/configuration/animated.rb,
lib/icons/configuration/boxicons.rb,
lib/icons/configuration/phosphor.rb,
lib/icons/configuration/heroicons.rb,
lib/icons/configuration/hugeicons.rb,
lib/icons/configuration/sidekickicons.rb

Defined Under Namespace

Classes: Configuration, Icon, IconNotFound, LibraryNotFound, Sprite, SpriteIcon, Sync

Constant Summary collapse

VERSION = 
"0.9.0"

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.configuration ⇒ Configuration

Returns:



15
16
17
 
# File 'lib/icons.rb', line 15

def configuration
  @configuration
end

Class Method Details

.config ⇒ Configuration

Returns:



27
28
29
 
# File 'lib/icons.rb', line 27

def config
  configuration || configure {}
end

.configure {|config| ... } ⇒ Object

Yields:

  • (config) —

    Yields the configuration object for customization

Yield Parameters:



20
21
22
23
 
# File 'lib/icons.rb', line 20

def configure
  self.configuration ||= Configuration.new
  yield(configuration) if block_given?
end

Instance Method Details

#libraries ⇒ Hash{Symbol => Class}

Returns A map of library names to their configuration classes.

Returns:

  • (Hash{Symbol => Class}) —

    A map of library names to their configuration classes



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/icons/libraries.rb', line 20

def libraries
  {
    boxicons: Icons::Configuration::Boxicons,
    feather: Icons::Configuration::Feather,
    flags: Icons::Configuration::Flags,
    heroicons: Icons::Configuration::Heroicons,
    hugeicons: Icons::Configuration::Hugeicons,
    linear: Icons::Configuration::Linear,
    lucide: Icons::Configuration::Lucide,
    phosphor: Icons::Configuration::Phosphor,
    radix: Icons::Configuration::Radix,
    sidekickicons: Icons::Configuration::Sidekickicons,
    tabler: Icons::Configuration::Tabler,
    weather: Icons::Configuration::Weather
  }
end