17. icon
Prev | Chapter 5. Content objects | Next

## 17. icon

icon(name, `foreground`, `background`, `tool_tip`)

Inserts a built-in image in generated content.

name

  Required.

  The name of the icon must be one of the following identifiers: check-off, check-on, circle, collapsed-left, collapsed-right, convert, delete, diamond, disc, down, drag2, drag, drop2, drop, expand-down, expanded-down, expanded-up, expand-up, external-link, external-link-small, file, filled-square, half-disc-separator, hatch1, hatch2, hollow-diamond, image, image-small, insert-after, insert-before, insert, invisible, key, launch, left-half-disc, left-link, left, left-target, line-break, link, minus-box, minus, no-image, pin-down, pin-left, pin-right, pin-up, plus-box, plus, pop-down, pop-left, pop-ne, pop-nw, pop-right, pop-se, pop-sw, pop-up, radio-off, radio-on, replace, return, right-half-disc, right-link, right, right-target, square-3, square-5, square, up.

foreground

  Optional. Specifies the foreground color of a bitonal icon (e.g. `diamond` and not `expand-down`). Default: current foreground color, that is, the `color` property of the current CSS style.

  ### Tip

  Specify something which is not a valid color (e.g. number 0) if you want to force the style sheet engine to use the current foreground color.

background

  Optional. Specifies the background color of a bitonal icon. Default: transparent.

  ### Tip

  Specify something which is not a valid color (e.g. number 0) if you want to force the style sheet engine to use the current background color.

tool_tip

  Optional. Specifies a tool tip text of the icon. Default: no tool tip.

Examples:

    icon(drop2)

    icon(pop-right, red)

    icon(pop-down, transparent, #80000)

    icon(pin-right, 0, transparent, "Draft comments")

Prev | Up | Next
16. gadget | Home | 18. indicator