expand

Themebuilder Configuration Functions Syntax

Theme configuration syntax reference.

Reference

Configuration functions

Portions of the theme configuration may be derivations of other values in the config. Rather than calculating these values manually, several configuration functions are available under the util package. The util package provides convenience functions that can pre-calculate values in the theme during theme construction, rather than affecting any runtime performance.

util.darkenGradient(gradientDetails, scale)

Darkens a given gradient data structure by the scale amount

Parameters

Name Description
gradientDetails The gradient structure to darken
scale A double representing the percentage to darken. For example: 0.2 will make the color 20% darker

Example

activeGradientDetails {
    stops = [
      "#1e5799 0%",
      "#2989d8 50%",
      "#207cca 51%",
      "#7db9e8 100%"
      ]
  }
  inactiveGradientDetails = util.darkenGradient(activeGradientDetails, 0.2)

The above example will evaluate to the following:

activeGradientDetails {
    stops = [
      "#1e5799 0%",
      "#2989d8 50%",
      "#207cca 51%",
      "#7db9e8 100%"
      ]
  }
  inactiveGradientDetails {
    stops = [
      "#18457a 0%",
      "#206dac 50%",
      "#1963a1 51%",
      "#6494b9 100%"
      ]
  }

util.lightenGradient(gradientDetails, scale)

Lightens the gradient data structure by the scale amount. See darkenGradient above for details on how to use it.

util.solidGradient(colorString)

Convenience method to create a single-color gradient from the specified color. Returns the gradient data structure.

Parameters

Name Description
colorString Hex color to use to build a solid gradient object

util.solidGradientString(colorString)

Convenience method to create a single-color gradient from the specified color. Returns a gradient string, suitable for use in CSS.

Parameters

Name Description
colorString Hex color to use to build a solid gradient string

util.darkenColor(colorString, scale)

Darkens a hex valued color String by scale amount.

Parameters

Name Description
colorString Hex color to darken
scale A double representing the percentage to darken. For example: 0.2 will make the color 20% darker.

Example

textColor = "#1e5799"
inactiveTextColor = util.darkenColor(textColor, 0.2)

The above example will evaluate to the following:

textColor = "#1e5799"
inactiveTextColor = "#6494b9"

util.lightenColor(colorString, scale)

Lightens a hex valued color String by scale amount.

Parameters

Name Description
colorString Hex color to lighten
scale A double representing the percentage to lighten. For example: 0.2 will make the color 20% lighter.

Example

textColor = "#1e5799"
overTextColor = util.lightenColor(textColor, 0.2)

The above example will evaluate to the following:

textColor = "#1e5799"
overTextColor = "#4b78ad"

util.mixColors(color1, color2, <ratio>)

Mixes two hex colors with the optional ratio.

Parameters

Name Description Default value
color1 first hex string color to mix
color2 second hex string color to mix
ratio The ratio of the mix 0.5

Example

red = "#ff0000"
blue = "#0000ff"

eggplant = util.mixColors(red, blue)
lipstick = util.mixColors(red, blue, 0.3)
purple = util.mixColors(red, blue, 0.7)

The above example will evaluate to the following:

red = "#ff0000"
blue = "#0000ff"

eggplant = "#7f007f"
lipstick = "#b2004c"
purple = "#4c00b2"

util.gradientString(gradientDetails)

Converts the gradient data structure into a CSS friendly string.

Parameters

Name Description
gradientDetails The gradient data structure

Example

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

activeGradient = util.gradientString(activeGradientDetails)

The above example will evaluate to the following:

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

activeGradient = "#1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%"

util.lastStopColor(gradientDetails)

Returns the last stop color of a gradient data structure. Useful if the gradient needs to blend into the background.

Parameters

Name Description
gradientDetails The gradient data structure

Example

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

panelBackgroundColor = util.lastStopColor(activeGradientDetails)

The above example will evaluate to the following:

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

panelBackgroundColor = "#7db9e8"

util.colorNameToHex(name)

Converts a color name to its hex representation. Useful when needing to use named colors in styles.

Parameters

Name Description
name name of the color to convert to a hex string

Example

red = util.colorNameToHex('red')
blue = util.colorNameToHex('blue')
aliceblue = util.colorNameToHex('aliceblue')

The above example will evaluate to the following:

red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"

util.rgbToHex(red, green, blue)

Converts RGB color values to hex string.

Parameters

Name Description
red red value of the color in the range 0-255
green green value of the color in the range 0-255
blue blue value of the color in the range 0-255

Example

red = util.rgbToHex(255, 0, 0)
blue = util.rgbToHex(0, 0, 255)
aliceblue = util.rgbToHex(240, 248, 255)

The above example will evaluate to the following:

red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"

util.margin(top [, right [, bottom [, left]]]])

Helper function to assign all margin details in one line. All parameters beyond the first are optional, following CSS style for margin values. All values are in pixels.

Parameters

Name Description Default value
top Margin in pixels to apply to the top of the element/widget
right Margin in pixels to apply to the right of the element/widget top
bottom Margin in pixels to apply to the bottom of the element/widget top
left Margin in pixels to apply to the left of the element/widget right

Examples

Normal usage to simply express an otherwise longer set of values
buttonMargin = util.margin(0, 3, 0, 2)

The above example will evaluate to the following:

buttonMargin {
  top = 0
  right = 3
  bottom = 0
  left = 2
}
Skipping values to repeat the existing values
info {
  //...
  margin = util.margin(2, 0)
  //...
}

The above example would evaluate to

info {
  //...
  margin {
    top = 2
    right = 0
    bottom = 2
    left = 0
  }
  //...
}

util.padding(top [, right [, bottom [, left]]]])

Helper function to assign all padding details in one line. All parameters beyond the first are optional, following CSS style for padding values. All values are in pixels.

Parameters

Name Description Default value
top Padding in pixels to apply to the top of the element/widget
right Padding in pixels to apply to the right of the element/widget top
bottom Padding in pixels to apply to the bottom of the element/widget top
left Padding in pixels to apply to the left of the element/widget right

Examples

Same usage as util.margin

util.border(style, [, color [,top [, right [, bottom [, left]]]]]])

Helper function to assign all border details in one line. All paramters beyond the first are optional, though for visible borders, at least the first three should be specified. Note that not all borders are managed using this border object, as in some cases it is need to require that different details are individually described and managed. Border thickness values are integers, treated as pixels.

Parameters

Name Description Default value
style The style of the border to use, using the legal values for border-style such as none, solid, dashed, etc
color The css color of the border to use "#000000"
top The thickness of the top border. 0
right The thickness of the right border top
bottom The thickness of the bottom border top
left The thickness of the left border right

Examples

No border:

border = util.border('none')

Solid blue border on all sides:

border = util.border('solid', '#0000ff', 1)

This would evaluate to

border {
  style = 'solid'
  color = '#0000ff'
  top = 1
  right = 1
  bottom = 1
  left = 1
}

util.abs(value)

Returns the absolute value of the given number

util.min(a, b)

Returns the smaller of the two numbers passed in

util.max(a, b)

Returns the larger of the two numbers passed in

util.extend(originalObject, additionalProperties)

Creates a new object, with all of the values of the first parameter, and overwrites any properties specified in the second parameter.

Parameters

Name Description
originalObject The object to clone and then modify. This is typically a reference to an existing object already declared in the config
additionalProperties Properties that should be overwritten in the newly created object

Example

dayText = util.fontStyle('helvetica,arial,verdana,sans-serif', '13px', '#000000')
dayDisabledText = util.extend(dayText, {
  color = '#808080'
})

This would evaluate to:

dayText {
  family = 'helvetica,arial,verdana,sans-serif'
  size = '13px'
  color = '#000000'
  weight = 'normal'
}
dayDisabledText {
  family = 'helvetica,arial,verdana,sans-serif'
  size = '13px'
  color = '#808080'
  weight = 'normal'
}

util.fontStyle(family [, size [, color [, weight]]])

Helper function to declare text styling in a single line. Only the first parameter is required. Unlike most other sizes that the themer takes, font sizes are treated as a string to support the wide range of possible CSS font-size values.

Parameters

Name Description Default value
family The font family to use. Any valid CSS font-family value is legal here.
size The font size to use. Any valid CSS font-size value is legal here. "medium"
color The text color to use. Any valid CSS color is legal here. "#000000"
weight The font weight to use. Any valid CSS font-weight value is legal here "normal"

util.radiusMinusBorderWidth(borderObject, radius)

Utility method to help reconcile differences in layout between CSS3 and Sliced appearances. In order to keep padding and margin values to be consistently applied, this value lets us make sure that the CSS3 implementation will have the same sizing as the sliced version.

Parameters

Name Description
borderObject a border object, such as what util.border would return
radius an int specifying the border radius on the relevant corners

util.glossyGradient(base [, scale])

Takes a color and an optional scaling value and returns a glossy gradient string.

Parameters

Name Description Default value
base The initial color to start with.
scale The optional value to use when stretching the base color into a gradient 0.15

Example

util.glossyGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15

util.bevelGradient(base [, scale])

Takes a color and an optional scaling value and returns a bevel gradient string.

Parameters

Name Description Default value
base The initial color to start with.
scale The optional value to use when stretching the base color into a gradient 0.15

Example

util.bevelGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15

util.recessedGradient(base [, scale])

Takes a color and an optional scaling value and returns a recessed gradient string.

Parameters

Name Description Default value
base The initial color to start with.
scale The optional value to use when stretching the base color into a gradient 0.5

Example

util.recessedGradient('#157FCC')

util.matteGradient(base, [, scale])

Takes a color and an optional scaling value and returns a matte gradient string.

Parameters

Name Description Default value
base The initial color to start with.
scale The optional value to use when stretching the base color into a gradient 0.04

Example

util.matteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.03

util.reversedMatteGradient(base [, scale])

Takes a color and an optional scaling value and returns a reversed matte gradient string.

Parameters

Name Description Default value
base The initial color to start with.
scale The optional value to use when stretching the base color into a gradient 0.06

Example

util.reversedMatteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.06
Last updated