README.md

In RinteRface/charpente: Seamlessly design robust 'shiny' extensions

charpente

The goal of {charpente} is to significantly reduce the complexity of creating new HTML templates for Shiny:

• {charpente} creates a plug and play package structure.
• {charpente} automatically import dependencies from jsdelivr, so that you don't have to do it by hand!
• {charpente} eases the conversion from HTML to R.
• {charpente} offers multiple R and JS boilerplate for {shiny} input bindings, {shiny} message handlers, ...
• {charpente} enables seamless JavaScript code management (powered by esbuild): concat, compress, mangle, bundle, minify, ... for JS and Sass code.

Installation

You can install the development version of {charpente} from Github with:

# latest version
remotes::install_github("RinteRface/charpente")

Example

This is a basic example which shows you how to solve a common problem:

library(charpente)

path <- file.path(tempdir(), "mypkg")
create_charpente(path, license = "mit")

# Once the package is created and opened

# Look for all bulma flavors
get_dependency_versions("bulma")
# Get latest stable
get_dependency_versions("bulma", latest = TRUE)
# Inspect bulma
get_dependency_assets("bulma")

# Download bulma locally
create_dependency("bulma")
devtools::load_all()
# Test the newly added dependencies tools
findDependencies(add_bulma_deps(div()))

# Create JS handler
create_custom_handler("modal")

# Create input binding
create_input_binding("myinput")

# Create output binding
create_output_binding("myoutput")

# Compress JS and CSS (Sass) for production
build_js()
devtools::load_all()

Acknowledgment

The author would like to warmly thank Victor Perrier, John Coene, Colin Fay, Alan Dipert, Kenton Russel for providing many building block and inspiration to this package.

Code of Conduct

Please note that the {charpente} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

RinteRface/charpente documentation built on Nov. 19, 2022, 2:35 p.m.