Skip to contents

Render escaped source text with optional metadata, copy controls, and line numbers.

Usage

shad_code_block(
  code,
  language = NULL,
  filename = NULL,
  copy = TRUE,
  line_numbers = FALSE,
  class = NULL
)

Arguments

code

One scalar character value containing source text.

language

Optional scalar character language label.

filename

Optional scalar character filename label.

copy

One scalar logical indicating whether to show the copy button.

line_numbers

One scalar logical indicating whether to show line numbers.

class

Extra CSS classes.

Value

An htmltools figure tag.

Examples

shad_code_block("fit <- lm(mpg ~ wt, data = mtcars)",
                language = "r", filename = "model.R")
#> <figure class="shad-code-block" data-shad-code-block>
#>   <figcaption class="shad-code-block__header">
#>     <span class="shad-code-block__title">model.R</span>
#>     <span class="shad-code-block__language">r</span>
#>     <span class="shad-code-block__controls">
#>       <button type="button" class="shad-code-block__copy" aria-label="Copy code" data-shad-copy-code>Copy</button>
#>       <span class="shad-code-block__status" role="status" aria-live="polite" aria-atomic="true" data-shad-copy-status></span>
#>     </span>
#>   </figcaption>
#>   <pre class="shad-code-block__pre">
#>     <code class="shad-code-block__code" data-language="r">fit &lt;- lm(mpg ~ wt, data = mtcars)</code>
#>   </pre>
#> </figure>