org.jooby.assets

Class SvgSymbol

java.lang.Object

org.jooby.assets.AssetOptions

org.jooby.assets.AssetAggregator

org.jooby.assets.SvgSymbol

public class SvgSymbol
extends AssetAggregator

svg-symbol

SVG symbol for icons: merge svg files from a folder and generates a sprite.svg and sprite.css files.

usage

 assets {
   fileset {
     sprite: svg-symbol
   }

   svg-symbol {
     input: "images/svg"
   }
 }
 

Previous example looks for *.svg files inside the images/svg folder and generate a sprite.svg and sprite.css files.

You can display the svg icons using id reference:

 <svg>
   <use xlink:href="#approved" />
 </svg>
 

This technique is described here: SVG symbol a Good Choice for Icons

options

output

Defines where to write the svg and css files. Default value is: sprite.

 svg-symbol {
   output: "folder/symbols"
 }
 

There are two more specific output options: svg.output and css.output if any of these options are present the output option is ignored:

 svg-symbol {
   css {
     output: "css/sprite.css"
   },
   svg {
     output: "img/sprite.svg"
   }
 }
 

id prefix and suffix

ID is generated from svg file names. These options prepend or append something to the generated id.

 svg-symbol {
   output: "sprite"
   id {
     prefix: "icon-"
   }
 }
 

Generates IDs like: icon-approved, while:

 svg-symbol {
   output: "sprite"
   id {
     suffix: "-icon"
   }
 }
 

Generates IDs like: approved-icon

css prefix

Prepend a string to a generated css class. Here is the css class for approved.svg:

 .approved {
   width: 18px;
   height: 18px;
 }
 

If we set a svg css prefix:

 {
   svg-symbol: {
     css {
       prefix: "svg"
     }
   }
 }
 

The generated css class will be:

 svg.approved {
   width: 18px;
   height: 18px;
 }
 

This option is useful for generating more specific css class selectors.

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SvgSymbol.Tuple<T1,T2>

Constructor Summary

Constructors

Constructor and Description
SvgSymbol() Creates a new SvgSymbol.

Method Summary

Modifier and Type	Method and Description
List<String>	fileset()
void	run(com.typesafe.config.Config conf)

Methods inherited from class org.jooby.assets.AssetAggregator

name, set, set, toString

Methods inherited from class org.jooby.assets.AssetOptions

excludes, get, options

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SvgSymbol

public SvgSymbol()

Creates a new SvgSymbol.

Method Detail

fileset

public List<String> fileset()

Specified by:

fileset in class AssetAggregator

run

public void run(com.typesafe.config.Config conf)
         throws Exception

Specified by:

run in class AssetAggregator

Throws:

Exception