EVOLUTION-MANAGER
Edit File: cli_bullets.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: List of items</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for cli_bullets {cli}"><tr><td>cli_bullets {cli}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>List of items</h2> <h3>Description</h3> <p>It is often useful to print out a list of items, tasks a function or package performs, or a list of notes. </p> <h3>Usage</h3> <pre> cli_bullets(text, id = NULL, class = NULL, .envir = parent.frame()) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>text</code></td> <td> <p>Character vector of items. See details below on how names are interpreted.</p> </td></tr> <tr valign="top"><td><code>id</code></td> <td> <p>Optional id of the <code>div.bullets</code> element, can be used in themes.</p> </td></tr> <tr valign="top"><td><code>class</code></td> <td> <p>Optional additional class(es) for the <code>div.bullets</code> element.</p> </td></tr> <tr valign="top"><td><code>.envir</code></td> <td> <p>Environment to evaluate the glue expressions in.</p> </td></tr> </table> <h3>Details</h3> <p>Items may be formatted differently, e.g. they can have a prefix symbol. Formatting is specified by the names of <code>text</code>, and can be themed. cli creates a <code>div</code> element of class <code>bullets</code> for the whole bullet list. Each item is another <code>div</code> element of class <code style="white-space: pre;">bullet-<name></code>, where <code style="white-space: pre;"><name></code> is the name of the entry in <code>text</code>. Entries in <code>text</code> without a name create a <code>div</code> element of class <code>buller-empty</code>, and if the name is a single space character, the class is <code>bullet-space</code>. </p> <p>The built-in theme defines the following item types: </p> <ul> <li><p> No name: Item without a prefix. </p> </li> <li> <p><code style="white-space: pre;"> </code>: Indented item. </p> </li> <li> <p><code>*</code>: Item with a bullet. </p> </li> <li> <p><code>></code>: Item with an arrow or pointer. </p> </li> <li> <p><code>v</code>: Item with a green "tick" symbol, like <code><a href="cli_alert.html">cli_alert_success()</a></code>. </p> </li> <li> <p><code>x</code>: Item with a ref cross, like <code><a href="cli_alert.html">cli_alert_danger()</a></code>. </p> </li> <li> <p><code>!</code>: Item with a yellow exclamation mark, like <code><a href="cli_alert.html">cli_alert_warning()</a></code>. </p> </li> <li> <p><code>i</code>: Info item, like <code><a href="cli_alert.html">cli_alert_info()</a></code>. </p> </li></ul> <p>You can define new item type by simply defining theming for the corresponding <code style="white-space: pre;">bullet-<name></code> classes. </p> <div class="sourceCode r"><pre>cli_bullets(c( "noindent", " " = "indent", "*" = "bullet", ">" = "arrow", "v" = "success", "x" = "danger", "!" = "warning", "i" = "info" )) </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> noindent #> indent #> <span style="color: #2AA198;">•</span> bullet #> → arrow #> <span style="color: #859900;">✔</span> success #> <span style="color: #DC322F;">✖</span> danger #> <span style="color: #B58900;">!</span> warning #> <span style="color: #2AA198;">ℹ</span> info </pre></div> <hr /><div style="text-align: center;">[Package <em>cli</em> version 3.4.1 <a href="00Index.html">Index</a>]</div> </body></html>