Skip to contents

A styled table. Pass a data frame for automatic rendering, or compose manually with the part constructors.

Usage

shad_table(
  x = NULL,
  ...,
  striped = FALSE,
  hover = FALSE,
  sticky_header = FALSE,
  caption = NULL,
  class = NULL
)

shad_table_header(..., class = NULL)

shad_table_body(..., class = NULL)

shad_table_footer(..., class = NULL)

shad_table_row(..., class = NULL)

shad_table_head(..., scope = "col", class = NULL)

shad_table_cell(..., class = NULL)

shad_table_caption(..., class = NULL)

Arguments

x

Optional data frame. When supplied, header and body are generated automatically.

...

Table sections when composing manually (and optional attributes).

striped, hover, sticky_header

Style options.

caption

Optional caption text.

class

Extra CSS classes.

scope

<th> scope attribute.

Value

A <div class="shad-table-container"> wrapping a <table>.

Examples

shad_table(head(mtcars), striped = TRUE)
#> <div class="shad-table-container">
#>   <table class="shad-table shad-table--striped">
#>     <thead class="shad-table__header">
#>       <tr class="shad-table__row">
#>         <th class="shad-table__head" scope="col">mpg</th>
#>         <th class="shad-table__head" scope="col">cyl</th>
#>         <th class="shad-table__head" scope="col">disp</th>
#>         <th class="shad-table__head" scope="col">hp</th>
#>         <th class="shad-table__head" scope="col">drat</th>
#>         <th class="shad-table__head" scope="col">wt</th>
#>         <th class="shad-table__head" scope="col">qsec</th>
#>         <th class="shad-table__head" scope="col">vs</th>
#>         <th class="shad-table__head" scope="col">am</th>
#>         <th class="shad-table__head" scope="col">gear</th>
#>         <th class="shad-table__head" scope="col">carb</th>
#>       </tr>
#>     </thead>
#>     <tbody class="shad-table__body">
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">21</td>
#>         <td class="shad-table__cell">6</td>
#>         <td class="shad-table__cell">160</td>
#>         <td class="shad-table__cell">110</td>
#>         <td class="shad-table__cell">3.9</td>
#>         <td class="shad-table__cell">2.62</td>
#>         <td class="shad-table__cell">16.46</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">4</td>
#>         <td class="shad-table__cell">4</td>
#>       </tr>
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">21</td>
#>         <td class="shad-table__cell">6</td>
#>         <td class="shad-table__cell">160</td>
#>         <td class="shad-table__cell">110</td>
#>         <td class="shad-table__cell">3.9</td>
#>         <td class="shad-table__cell">2.875</td>
#>         <td class="shad-table__cell">17.02</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">4</td>
#>         <td class="shad-table__cell">4</td>
#>       </tr>
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">22.8</td>
#>         <td class="shad-table__cell">4</td>
#>         <td class="shad-table__cell">108</td>
#>         <td class="shad-table__cell">93</td>
#>         <td class="shad-table__cell">3.85</td>
#>         <td class="shad-table__cell">2.32</td>
#>         <td class="shad-table__cell">18.61</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">4</td>
#>         <td class="shad-table__cell">1</td>
#>       </tr>
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">21.4</td>
#>         <td class="shad-table__cell">6</td>
#>         <td class="shad-table__cell">258</td>
#>         <td class="shad-table__cell">110</td>
#>         <td class="shad-table__cell">3.08</td>
#>         <td class="shad-table__cell">3.215</td>
#>         <td class="shad-table__cell">19.44</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">3</td>
#>         <td class="shad-table__cell">1</td>
#>       </tr>
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">18.7</td>
#>         <td class="shad-table__cell">8</td>
#>         <td class="shad-table__cell">360</td>
#>         <td class="shad-table__cell">175</td>
#>         <td class="shad-table__cell">3.15</td>
#>         <td class="shad-table__cell">3.44</td>
#>         <td class="shad-table__cell">17.02</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">3</td>
#>         <td class="shad-table__cell">2</td>
#>       </tr>
#>       <tr class="shad-table__row">
#>         <td class="shad-table__cell">18.1</td>
#>         <td class="shad-table__cell">6</td>
#>         <td class="shad-table__cell">225</td>
#>         <td class="shad-table__cell">105</td>
#>         <td class="shad-table__cell">2.76</td>
#>         <td class="shad-table__cell">3.46</td>
#>         <td class="shad-table__cell">20.22</td>
#>         <td class="shad-table__cell">1</td>
#>         <td class="shad-table__cell">0</td>
#>         <td class="shad-table__cell">3</td>
#>         <td class="shad-table__cell">1</td>
#>       </tr>
#>     </tbody>
#>   </table>
#> </div>