Browse Source

Update docs

master
Garrick Aden-Buie 7 years ago
parent
commit
98447847a9
26 changed files with 322 additions and 70 deletions
  1. +1
    -0
      DESCRIPTION
  2. +2
    -2
      docs/reference/bulma_color.html
  3. +4
    -4
      docs/reference/bulma_column.html
  4. +1
    -1
      docs/reference/bulma_column_narrow.html
  5. +4
    -4
      docs/reference/bulma_column_options.html
  6. +6
    -6
      docs/reference/bulma_columns.html
  7. +1
    -1
      docs/reference/bulma_constants.html
  8. +31
    -3
      docs/reference/bulma_document.html
  9. +12
    -12
      docs/reference/bulma_helper.html
  10. +1
    -1
      docs/reference/bulma_responsive.html
  11. +1
    -1
      docs/reference/bulma_responsive_alignment.html
  12. +1
    -1
      docs/reference/bulma_responsive_size.html
  13. +2
    -2
      docs/reference/bulma_typography.html
  14. +163
    -0
      docs/reference/fa_icon.html
  15. +6
    -0
      docs/reference/index.html
  16. +4
    -4
      man/bulma_column.Rd
  17. +1
    -1
      man/bulma_column_narrow.Rd
  18. +4
    -4
      man/bulma_column_options.Rd
  19. +6
    -6
      man/bulma_columns.Rd
  20. +28
    -1
      man/bulma_document.Rd
  21. +12
    -12
      man/bulma_helper.Rd
  22. +1
    -1
      man/bulma_responsive.Rd
  23. +1
    -1
      man/bulma_responsive_alignment.Rd
  24. +1
    -1
      man/bulma_responsive_size.Rd
  25. +1
    -1
      man/bulma_typography.Rd
  26. +27
    -0
      man/fa_icon.Rd

+ 1
- 0
DESCRIPTION View File

@@ -16,3 +16,4 @@ Imports:
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)

+ 2
- 2
docs/reference/bulma_color.html View File

@@ -112,14 +112,14 @@
<th>text</th>
<td><p>One of "white", "black", "light", "dark", "primary", "info",
"link", "success", "warning", "danger", "black-bis", "black-ter",
"grey-darker", "grey-dark", "grey", "gre-light", "grey-lighter",
"grey-darker", "grey-dark", "grey", "grey-light", "grey-lighter",
"white-ter", "white-bis"</p></td>
</tr>
<tr>
<th>background</th>
<td><p>One of "white", "black", "light", "dark", "primary",
"info", "link", "success", "warning", "danger", "black-bis", "black-ter",
"grey-darker", "grey-dark", "grey", "gre-light", "grey-lighter",
"grey-darker", "grey-dark", "grey", "grey-light", "grey-lighter",
"white-ter", "white-bis"</p></td>
</tr>
</table>

+ 4
- 4
docs/reference/bulma_column.html View File

@@ -121,19 +121,19 @@
</tr>
<tr>
<th>offset</th>
<td><p>Column offset, one of `size` or `width`</p></td>
<td><p>Column offset, one of <code>size</code> or <code>width</code></p></td>
</tr>
<tr>
<th>narrow</th>
<td><p>Use [bulma_column_narrow()] to construct options</p></td>
<td><p>Use <code><a href='bulma_column_narrow.html'>bulma_column_narrow()</a></code> to construct options</p></td>
</tr>
<tr>
<th>class</th>
<td><p>Extra classes that should be applied to the `columns` container.</p></td>
<td><p>Extra classes that should be applied to the <code>columns</code> container.</p></td>
</tr>
<tr>
<th>style</th>
<td><p>CSS styles applied to the `columns` container.</p></td>
<td><p>CSS styles applied to the <code>columns</code> container.</p></td>
</tr>
</table>

+ 1
- 1
docs/reference/bulma_column_narrow.html View File

@@ -111,7 +111,7 @@
<tr>
<th>viewport</th>
<td><p>One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See &lt;https://bulma.io/documentation/modifiers/responsive-helpers/&gt;
"fullhd". See <a href='https://bulma.io/documentation/modifiers/responsive-helpers/'>https://bulma.io/documentation/modifiers/responsive-helpers/</a>
for more information.</p></td>
</tr>
</table>

+ 4
- 4
docs/reference/bulma_column_options.html View File

@@ -121,19 +121,19 @@
</tr>
<tr>
<th>offset</th>
<td><p>Column offset, one of `size` or `width`</p></td>
<td><p>Column offset, one of <code>size</code> or <code>width</code></p></td>
</tr>
<tr>
<th>narrow</th>
<td><p>Use [bulma_column_narrow()] to construct options</p></td>
<td><p>Use <code><a href='bulma_column_narrow.html'>bulma_column_narrow()</a></code> to construct options</p></td>
</tr>
<tr>
<th>class</th>
<td><p>Extra classes that should be applied to the `columns` container.</p></td>
<td><p>Extra classes that should be applied to the <code>columns</code> container.</p></td>
</tr>
<tr>
<th>style</th>
<td><p>CSS styles applied to the `columns` container.</p></td>
<td><p>CSS styles applied to the <code>columns</code> container.</p></td>
</tr>
</table>

+ 6
- 6
docs/reference/bulma_columns.html View File

@@ -112,10 +112,10 @@
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>breakpoint</th>
<td><p>By default, columns are only activated from **tablet**
<td><p>By default, columns are only activated from <strong>tablet</strong>
onwards, meaning that columns are stacked on top of each other on
**mobile**. Use `breakpoint` to set the point at which columns are spread
out. See `viewport` option in [bulma_responsive()] for valid options.</p></td>
<strong>mobile</strong>. Use <code>breakpoint</code> to set the point at which columns are spread
out. See <code>viewport</code> option in <code><a href='bulma_responsive.html'>bulma_responsive()</a></code> for valid options.</p></td>
</tr>
<tr>
<th>gap</th>
@@ -128,16 +128,16 @@ width or size add up to more than the screen width).</p></td>
</tr>
<tr>
<th>class</th>
<td><p>Extra classes that should be applied to the `columns` container.</p></td>
<td><p>Extra classes that should be applied to the <code>columns</code> container.</p></td>
</tr>
<tr>
<th>style</th>
<td><p>CSS styles applied to the `columns` container.</p></td>
<td><p>CSS styles applied to the <code>columns</code> container.</p></td>
</tr>
<tr>
<th>column_options</th>
<td><p>Column options to be applied to each column. Use
[bulma_column_options()] to format.</p></td>
<code><a href='bulma_column_options.html'>bulma_column_options()</a></code> to format.</p></td>
</tr>
</table>

+ 1
- 1
docs/reference/bulma_constants.html View File

@@ -120,7 +120,7 @@
<pre class="examples"><div class='input'><span class='fu'>bulma_constants</span>(<span class='st'>"colors"</span>)</div><div class='output co'>#&gt; [1] "white" "black" "light" "dark" "primary"
#&gt; [6] "info" "link" "success" "warning" "danger"
#&gt; [11] "black-bis" "black-ter" "grey-darker" "grey-dark" "grey"
#&gt; [16] "gre-light" "grey-lighter" "white-ter" "white-bis" </div><div class='input'><span class='fu'>bulma_constants</span>(<span class='st'>"column sizes"</span>)</div><div class='output co'>#&gt; [1] "full" "four-fifths" "three-quarters" "two-thirds"
#&gt; [16] "grey-light" "grey-lighter" "white-ter" "white-bis" </div><div class='input'><span class='fu'>bulma_constants</span>(<span class='st'>"column sizes"</span>)</div><div class='output co'>#&gt; [1] "full" "four-fifths" "three-quarters" "two-thirds"
#&gt; [5] "three-fifths" "half" "two-fifths" "one-third"
#&gt; [9] "one-quarter" "one-fifth" </div><div class='input'><span class='fu'>bulma_constants</span>(<span class='st'>"viewports"</span>)</div><div class='output co'>#&gt; [1] "mobile" "tablet" "touch" "desktop" "widescreen"
#&gt; [6] "fullhd" </div><div class='input'>

+ 31
- 3
docs/reference/bulma_document.html View File

@@ -32,7 +32,7 @@

<meta property="og:title" content="Bulma Document Renderer — bulma_document" />

<meta property="og:description" content="TODO Document YAML options here." />
<meta property="og:description" content="Bulma Document Renderer" />
<meta name="twitter:card" content="summary" />


@@ -99,7 +99,7 @@

<div class="ref-description">
<p>TODO Document YAML options here.</p>
<p>Bulma Document Renderer</p>
</div>

@@ -147,13 +147,41 @@ more details).</p></dd>
</tr>
</table>
<h2 class="hasAnchor" id="yaml-options"><a class="anchor" href="#yaml-options"></a>YAML options</h2>

<p>You can pass additional options to the underlying template via the <code>bulma</code>
YAML item. The following options can be specified there.</p><ul>
<li><p><code>hero</code>: Classes applied to the hero containing the title</p></li>
<li><p><code>hero_button</code>: Classes applied to the <code>header_links</code> buttons</p></li>
<li><p><code>hero_links</code>: Links that will be displayed under title as buttons.
Formatted as a list, each element having entries for <code>name</code>, <code>url</code>,
and <code>icon</code>. Icons use <a href='https://fontawesome.com/icons'>Font Awesome</a>;
see <code><a href='fa_icon.html'>fa_icon()</a></code> for help constructing the Font Awesome class. The
full Font Awesome class name is required.</p></li>
</ul><pre>---
bulma:
hero: ["info"]
hero_button: ["is-secondary", "is-outlined"]
hero_links:
- name: Github
url: https://github.com/
icon: '`r bulma::fa_icon("github")`'
- name: Twitter
url: https://twitter.com
icon: "fab fa-twitter"
---
</pre>

</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
</ul>
<li><a href="#yaml-options">YAML options</a></li>
</ul>

</div>
</div>

+ 12
- 12
docs/reference/bulma_helper.html View File

@@ -110,24 +110,24 @@
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>float</th>
<td><p>`clearfix` Fixes an element's floating children</p>
<p>`pulled-left` Moves an element to the left</p>
<p>`pulled-right` Moves an element to the right</p></td>
<td><p><code>clearfix</code> Fixes an element's floating children</p>
<p><code>pulled-left</code> Moves an element to the left</p>
<p><code>pulled-right</code> Moves an element to the right</p></td>
</tr>
<tr>
<th>spacing</th>
<td><p>`marginless` Removes any margin</p>
<p>`paddingless` Removes any padding</p></td>
<td><p><code>marginless</code> Removes any margin</p>
<p><code>paddingless</code> Removes any padding</p></td>
</tr>
<tr>
<th>other</th>
<td><p>`overlay` Completely covers the first positioned parent
`clipped` Adds overflow hidden</p>
<p>`radiusless` Removes any radius</p>
<p>`shadowless` Removes any shadow</p>
<p>`unselectable` Prevents the text from being selectable</p>
<p>`invisible` Adds visibility hidden</p>
<p>`sr-only` Hide elements visually but keep the element available to be announced by a screen reader</p></td>
<td><p><code>overlay</code> Completely covers the first positioned parent
<code>clipped</code> Adds overflow hidden</p>
<p><code>radiusless</code> Removes any radius</p>
<p><code>shadowless</code> Removes any shadow</p>
<p><code>unselectable</code> Prevents the text from being selectable</p>
<p><code>invisible</code> Adds visibility hidden</p>
<p><code>sr-only</code> Hide elements visually but keep the element available to be announced by a screen reader</p></td>
</tr>
</table>

+ 1
- 1
docs/reference/bulma_responsive.html View File

@@ -115,7 +115,7 @@
<tr>
<th>viewport</th>
<td><p>One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See &lt;https://bulma.io/documentation/modifiers/responsive-helpers/&gt;
"fullhd". See <a href='https://bulma.io/documentation/modifiers/responsive-helpers/'>https://bulma.io/documentation/modifiers/responsive-helpers/</a>
for more information.</p></td>
</tr>
</table>

+ 1
- 1
docs/reference/bulma_responsive_alignment.html View File

@@ -115,7 +115,7 @@
<tr>
<th>viewport</th>
<td><p>One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See &lt;https://bulma.io/documentation/modifiers/responsive-helpers/&gt;
"fullhd". See <a href='https://bulma.io/documentation/modifiers/responsive-helpers/'>https://bulma.io/documentation/modifiers/responsive-helpers/</a>
for more information.</p></td>
</tr>
</table>

+ 1
- 1
docs/reference/bulma_responsive_size.html View File

@@ -115,7 +115,7 @@
<tr>
<th>viewport</th>
<td><p>One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See &lt;https://bulma.io/documentation/modifiers/responsive-helpers/&gt;
"fullhd". See <a href='https://bulma.io/documentation/modifiers/responsive-helpers/'>https://bulma.io/documentation/modifiers/responsive-helpers/</a>
for more information.</p></td>
</tr>
</table>

+ 2
- 2
docs/reference/bulma_typography.html View File

@@ -116,7 +116,7 @@
</tr>
<tr>
<th>responsive_size</th>
<td><p>See [bulma_responsive_size()].</p></td>
<td><p>See <code><a href='bulma_responsive_size.html'>bulma_responsive_size()</a></code>.</p></td>
</tr>
<tr>
<th>alignment</th>
@@ -139,7 +139,7 @@
<th>text</th>
<td><p>One of "white", "black", "light", "dark", "primary", "info",
"link", "success", "warning", "danger", "black-bis", "black-ter",
"grey-darker", "grey-dark", "grey", "gre-light", "grey-lighter",
"grey-darker", "grey-dark", "grey", "grey-light", "grey-lighter",
"white-ter", "white-bis"</p></td>
</tr>
</table>

+ 163
- 0
docs/reference/fa_icon.html View File

@@ -0,0 +1,163 @@
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Font Awesome Icon — fa_icon • bulma</title>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="Font Awesome Icon — fa_icon" />

<meta property="og:description" content="Create the correct Font Awesome class." />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


</head>

<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">bulma</a>
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.0.0.9000</span>
</span>
</div>

<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->

</header>

<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Font Awesome Icon</h1>
<div class="hidden name"><code>fa_icon.Rd</code></div>
</div>

<div class="ref-description">
<p>Create the correct Font Awesome class.</p>
</div>

<pre class="usage"><span class='fu'>fa_icon</span>(<span class='no'>name</span>, <span class='kw'>solid</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>as_html</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>name</th>
<td><p>Name of the Font Awesome icon</p></td>
</tr>
<tr>
<th>solid</th>
<td><p>Should the solid or the regular icon be used?</p></td>
</tr>
<tr>
<th>as_html</th>
<td><p>If <code>FALSE</code> (default), only the icon class is returned.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>

<p><a href='https://fontawesome.com/icons'>https://fontawesome.com/icons</a></p>

<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='fu'>fa_icon</span>(<span class='st'>"github"</span>)</div><div class='output co'>#&gt; [1] "fab fa-github"</div><div class='input'><span class='fu'>fa_icon</span>(<span class='st'>"star"</span>)</div><div class='output co'>#&gt; [1] "fas fa-star"</div><div class='input'><span class='fu'>fa_icon</span>(<span class='st'>"star"</span>, <span class='fl'>FALSE</span>)</div><div class='output co'>#&gt; [1] "far fa-star"</div><div class='input'>
</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#references">References</a></li>
<li><a href="#examples">Examples</a></li>
</ul>

</div>
</div>

<footer>
<div class="copyright">
<p>Developed by Garrick Aden-Buie.</p>
</div>

<div class="pkgdown">
<p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

</footer>
</div>


</body>
</html>


+ 6
- 0
docs/reference/index.html View File

@@ -193,6 +193,12 @@
<td><p>Bulma Typography Helper Classes</p></td>
</tr><tr>
<td>
<p><code><a href="fa_icon.html">fa_icon()</a></code> </p>
</td>
<td><p>Font Awesome Icon</p></td>
</tr><tr>
<td>
<p><code><a href="level_item_header.html">level_item_header()</a></code> </p>
</td>

+ 4
- 4
man/bulma_column.Rd View File

@@ -14,13 +14,13 @@ bulma_column(..., size = NULL, width = NULL, offset = NULL,

\item{width}{Column width in terms of the 12 grid units, i.e. 1-12.}

\item{offset}{Column offset, one of `size` or `width`}
\item{offset}{Column offset, one of \code{size} or \code{width}}

\item{narrow}{Use [bulma_column_narrow()] to construct options}
\item{narrow}{Use \code{\link[=bulma_column_narrow]{bulma_column_narrow()}} to construct options}

\item{class}{Extra classes that should be applied to the `columns` container.}
\item{class}{Extra classes that should be applied to the \code{columns} container.}

\item{style}{CSS styles applied to the `columns` container.}
\item{style}{CSS styles applied to the \code{columns} container.}
}
\description{
Bulma Column

+ 1
- 1
man/bulma_column_narrow.Rd View File

@@ -8,7 +8,7 @@ bulma_column_narrow(viewport = NULL)
}
\arguments{
\item{viewport}{One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See <https://bulma.io/documentation/modifiers/responsive-helpers/>
"fullhd". See \url{https://bulma.io/documentation/modifiers/responsive-helpers/}
for more information.}
}
\description{

+ 4
- 4
man/bulma_column_options.Rd View File

@@ -14,13 +14,13 @@ bulma_column_options(size = NULL, width = NULL, offset = NULL,

\item{width}{Column width in terms of the 12 grid units, i.e. 1-12.}

\item{offset}{Column offset, one of `size` or `width`}
\item{offset}{Column offset, one of \code{size} or \code{width}}

\item{narrow}{Use [bulma_column_narrow()] to construct options}
\item{narrow}{Use \code{\link[=bulma_column_narrow]{bulma_column_narrow()}} to construct options}

\item{class}{Extra classes that should be applied to the `columns` container.}
\item{class}{Extra classes that should be applied to the \code{columns} container.}

\item{style}{CSS styles applied to the `columns` container.}
\item{style}{CSS styles applied to the \code{columns} container.}
}
\description{
Bulma Column Options

+ 6
- 6
man/bulma_columns.Rd View File

@@ -9,22 +9,22 @@ bulma_columns(..., breakpoint = "tablet", gap = NULL,
column_options = NULL)
}
\arguments{
\item{breakpoint}{By default, columns are only activated from **tablet**
\item{breakpoint}{By default, columns are only activated from \strong{tablet}
onwards, meaning that columns are stacked on top of each other on
**mobile**. Use `breakpoint` to set the point at which columns are spread
out. See `viewport` option in [bulma_responsive()] for valid options.}
\strong{mobile}. Use \code{breakpoint} to set the point at which columns are spread
out. See \code{viewport} option in \code{\link[=bulma_responsive]{bulma_responsive()}} for valid options.}

\item{gap}{Gap between colums, integer from 0 to 8}

\item{multiline}{Should columns wrap to multiple lines (allows columns whose
width or size add up to more than the screen width).}

\item{class}{Extra classes that should be applied to the `columns` container.}
\item{class}{Extra classes that should be applied to the \code{columns} container.}

\item{style}{CSS styles applied to the `columns` container.}
\item{style}{CSS styles applied to the \code{columns} container.}

\item{column_options}{Column options to be applied to each column. Use
[bulma_column_options()] to format.}
\code{\link[=bulma_column_options]{bulma_column_options()}} to format.}
}
\description{
Bulma Columns

+ 28
- 1
man/bulma_document.Rd View File

@@ -44,5 +44,32 @@ more details).}
}}
}
\description{
TODO Document YAML options here.
Bulma Document Renderer
}
\section{YAML options}{

You can pass additional options to the underlying template via the \code{bulma}
YAML item. The following options can be specified there.
\itemize{
\item{\code{hero}: Classes applied to the hero containing the title}
\item{\code{hero_button}: Classes applied to the \code{header_links} buttons}
\item{\code{hero_links}: Links that will be displayed under title as buttons.
Formatted as a list, each element having entries for \code{name}, \code{url},
and \code{icon}. Icons use \href{https://fontawesome.com/icons}{Font Awesome};
see \code{\link[=fa_icon]{fa_icon()}} for help constructing the Font Awesome class. The
full Font Awesome class name is required.}
}\preformatted{---
bulma:
hero: ["info"]
hero_button: ["is-secondary", "is-outlined"]
hero_links:
- name: Github
url: https://github.com/
icon: '`r bulma::fa_icon("github")`'
- name: Twitter
url: https://twitter.com
icon: "fab fa-twitter"
---
}
}


+ 12
- 12
man/bulma_helper.Rd View File

@@ -7,28 +7,28 @@
bulma_helper(float = NULL, spacing = NULL, other = NULL)
}
\arguments{
\item{float}{`clearfix` Fixes an element's floating children
\item{float}{\code{clearfix} Fixes an element's floating children

`pulled-left` Moves an element to the left
\code{pulled-left} Moves an element to the left

`pulled-right` Moves an element to the right}
\code{pulled-right} Moves an element to the right}

\item{spacing}{`marginless` Removes any margin
\item{spacing}{\code{marginless} Removes any margin

`paddingless` Removes any padding}
\code{paddingless} Removes any padding}

\item{other}{`overlay` Completely covers the first positioned parent
`clipped` Adds overflow hidden
\item{other}{\code{overlay} Completely covers the first positioned parent
\code{clipped} Adds overflow hidden

`radiusless` Removes any radius
\code{radiusless} Removes any radius

`shadowless` Removes any shadow
\code{shadowless} Removes any shadow

`unselectable` Prevents the text from being selectable
\code{unselectable} Prevents the text from being selectable

`invisible` Adds visibility hidden
\code{invisible} Adds visibility hidden

`sr-only` Hide elements visually but keep the element available to be announced by a screen reader}
\code{sr-only} Hide elements visually but keep the element available to be announced by a screen reader}
}
\value{
String of modifer classes

+ 1
- 1
man/bulma_responsive.Rd View File

@@ -10,7 +10,7 @@ bulma_responsive(display = NULL, viewport = NULL, only = FALSE)
\item{display}{One of "block", "flex", "inline", "inline-block", "inline-flex"}

\item{viewport}{One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See <https://bulma.io/documentation/modifiers/responsive-helpers/>
"fullhd". See \url{https://bulma.io/documentation/modifiers/responsive-helpers/}
for more information.}
}
\value{

+ 1
- 1
man/bulma_responsive_alignment.Rd View File

@@ -10,7 +10,7 @@ bulma_responsive_alignment(alignment = "left", viewport = "desktop")
\item{alignment}{One of "centered", "justified", "left", "right"}

\item{viewport}{One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See <https://bulma.io/documentation/modifiers/responsive-helpers/>
"fullhd". See \url{https://bulma.io/documentation/modifiers/responsive-helpers/}
for more information.}
}
\value{

+ 1
- 1
man/bulma_responsive_size.Rd View File

@@ -10,7 +10,7 @@ bulma_responsive_size(size = "1", viewport = "desktop")
\item{size}{One of 1 through 7 (large to small)}

\item{viewport}{One of "mobile", "tablet", "touch", "desktop", "widescreen",
"fullhd". See <https://bulma.io/documentation/modifiers/responsive-helpers/>
"fullhd". See \url{https://bulma.io/documentation/modifiers/responsive-helpers/}
for more information.}
}
\value{

+ 1
- 1
man/bulma_typography.Rd View File

@@ -11,7 +11,7 @@ bulma_typography(size = NULL, color = NULL, responsive_size = NULL,
\arguments{
\item{size}{One of 1 through 7 (large to small)}

\item{responsive_size}{See [bulma_responsive_size()].}
\item{responsive_size}{See \code{\link[=bulma_responsive_size]{bulma_responsive_size()}}.}

\item{alignment}{One of "centered", "justified", "left", "right"}


+ 27
- 0
man/fa_icon.Rd View File

@@ -0,0 +1,27 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{fa_icon}
\alias{fa_icon}
\title{Font Awesome Icon}
\usage{
fa_icon(name, solid = TRUE, as_html = FALSE)
}
\arguments{
\item{name}{Name of the Font Awesome icon}

\item{solid}{Should the solid or the regular icon be used?}

\item{as_html}{If \code{FALSE} (default), only the icon class is returned.}
}
\description{
Create the correct Font Awesome class.
}
\examples{
fa_icon("github")
fa_icon("star")
fa_icon("star", FALSE)

}
\references{
\url{https://fontawesome.com/icons}
}

Loading…
Cancel
Save