<\/div>\" html_2_R(tag) }"},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Golem's default custom templates — js_handler_template","title":"Golem's default custom templates — js_handler_template","text":"functions aim called users, passed argument create_custom_handler function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Golem's default custom templates — js_handler_template","text":"","code":"js_handler_template(path, name, code = \" \")"},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Golem's default custom templates — js_handler_template","text":"path path JS script template written. name Shiny's custom handler name. code JavaScript code written function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://rinterface.github.io/charpente/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert provided parameters into template — process_template","title":"Insert provided parameters into template — process_template","text":"Insert provided parameters template","code":""},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert provided parameters into template — process_template","text":"","code":"process_template( template, ..., where = system.file(\"utils\", package = \"charpente\") )"},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert provided parameters into template — process_template","text":"template Template obtained get_template. ... List parameters insert template. find template.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":null,"dir":"Reference","previous_headings":"","what":"Add script.js to main.js entry point. — reference_script","title":"Add script.js to main.js entry point. — reference_script","text":"Needed keep entry point date","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add script.js to main.js entry point. — reference_script","text":"","code":"reference_script(name)"},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add script.js to main.js entry point. — reference_script","text":"name Script name.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert import into main SCSS file — reference_style","title":"Insert import into main SCSS file — reference_style","text":"Useful reference scss files main one.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert import into main SCSS file — reference_style","text":"","code":"reference_style(path)"},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert import into main SCSS file — reference_style","text":"path file.name folder/file.name","code":""},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":null,"dir":"Reference","previous_headings":"","what":"Run esbuild — run_esbuild","title":"Run esbuild — run_esbuild","text":"Apply esbuild srcjs folder.","code":""},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run esbuild — run_esbuild","text":"","code":"run_esbuild(mode, outputDir)"},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run esbuild — run_esbuild","text":"mode Production development mode. Choose either \"prod\" \"dev\". \"prod\" bundles, aggregates minifyies files. \"dev\" bundles code. Modules follow ES6 format (import/export). outputDir Output directory","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup esbuild — set_esbuild","title":"Setup esbuild — set_esbuild","text":"Installs esbuild local project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup esbuild — set_esbuild","text":"","code":"set_esbuild(light = FALSE)"},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup esbuild — set_esbuild","text":"light Used install Sass plugins. workaround breaking change charpente styles exist old versions.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup esbuild — set_esbuild","text":"Installs esbuild node_modules (dev scope), existing, creates srcjs + srcjs/main.js andstyles + styles/main.scss, sets relevant files folders .gitignore. .Rbuildignore.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup mocha — set_mocha","title":"Setup mocha — set_mocha","text":"Installs mocha local project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup mocha — set_mocha","text":"","code":"set_mocha()"},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup mocha — set_mocha","text":"Installs mocha node_modules (dev scope), creates srcjs/test folder, write basic test im test_basic.js","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":null,"dir":"Reference","previous_headings":"","what":"Utils to set up a PWA compatible structure — set_pwa","title":"Utils to set up a PWA compatible structure — set_pwa","text":"Creates web manifest, service-worker.js, icons set necessary dependencies. app must part package. Must used package root app root.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Utils to set up a PWA compatible structure — set_pwa","text":"","code":"set_pwa( path, name = \"My Progressive Web App\", shortName = \"My App\", description = \"What it does!\", lang = \"en-US\", startUrl = \"/\", display = c(\"standalone\", \"minimal-ui\", \"fullscreen\", \"browser\"), background_color = \"#ffffff\", theme_color = \"#ffffff\", register_service_worker = TRUE, create_dependencies = TRUE )"},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Utils to set up a PWA compatible structure — set_pwa","text":"path App path. name App name. shortName App short name. description App description lang App language (en-US default). startUrl Page open start. display Display mode. Choose among c(\"minimal-ui\", \"standalone\", \"fullscreen\", \"browser\"). practice, want standalone mode app looks like native app. background_color background_color property used splash screen application first launched. theme_color theme_color sets color tool bar, may reflected app's preview task switchers. register_service_worker Whether register service worker. Default TRUE. change file name service-worker.js!!! create_dependencies Default TRUE. Relevant used shinyMobile context. used outside, must set FALSE handle dependencies .","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup version control — set_version_control","title":"Setup version control — set_version_control","text":"Sets git optionally link github current project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup version control — set_version_control","text":"","code":"set_version_control(remote, private)"},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup version control — set_version_control","text":"remote Name remote Github organization connect . private Whether repository private. Default FALSE.","code":""},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":null,"dir":"Reference","previous_headings":"","what":"Test JS code — test_js","title":"Test JS code — test_js","text":"Test entire srcjs/test folder","code":""},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test JS code — test_js","text":"","code":"test_js()"},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test JS code — test_js","text":"message showing test results","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the given dependency to a specific version or latest — update_dependency","title":"Update the given dependency to a specific version or latest — update_dependency","text":"Update given dependency specific version latest","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the given dependency to a specific version or latest — update_dependency","text":"","code":"update_dependency(name, version_target = \"latest\")"},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the given dependency to a specific version or latest — update_dependency","text":"name Library name. version_target Targeted version. Default latest.","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the given dependency to a specific version or latest — update_dependency","text":"","code":"if (FALSE) { update_dependency(\"framework7\") }"},{"path":[]},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"new-0-6-0","dir":"Changelog","previous_headings":"","what":"New:","title":"charpente 0.6.0","text":"Allow initialise esbuild mocha standalone way, without need full charpente workflow. useful want use esbuild plugins already existing projects. See ?set_esbuild ?set_mocha details.","code":""},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"improvements-0-6-0","dir":"Changelog","previous_headings":"","what":"Improvements:","title":"charpente 0.6.0","text":"Move use_build_ignore() use_git_ignore() calls set_esbuild() enable standalone usage.","code":""},{"path":[]},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"breaking-change-0-5-0","dir":"Changelog","previous_headings":"","what":"Breaking change:","title":"charpente 0.5.0","text":"Include Sass handling. SCSS files sorted /stylesfolder esbuild new Sass modules treat generate CSS. package.json now calls node esbuild.dev.js node esbuild.prod.js, depending selected mode, production development. esbuild.**.js new script processed run time project, called node package.json. come older charpente version, build_js() first try create /styles folder (normally don’t ) install missing Sass dependencies next esbuild (esbuild-sass-plugin, postcss, autoprefixer). get_dependency_assets() leverages new jsdlivr algorithm infer best entry point scripts JS CSS files, downloading dependencies within create_dependency(). likely change vendors dependencies scripts names change features. charpente_options() likely deprecated previous point. still contains local option either point external CDN copy external vendore files local project. create_css() replaced create_scss() (can still use golem::create_css). one main SCSS file created project setup. SCSS files referenced main styles/main.scss using @import path, allow modular Sass code. Remove entry_point param build_js() used anyway…","code":""},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"charpente-010","dir":"Changelog","previous_headings":"","what":"charpente 0.1.0","title":"charpente 0.1.0","text":"Added NEWS.md file track changes package.","code":""}]
+[{"path":[]},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://rinterface.github.io/charpente/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/ code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https:// www.contributor-covenant.org/translations.","code":""},{"path":"https://rinterface.github.io/charpente/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2020 David Granjon Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://rinterface.github.io/charpente/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"David Granjon. Author, maintainer. John Coene. Author. Alan Dipert. Contributor. Functions html2r Veerle van Leemput. Contributor. RinteRface. Copyright holder. ThinkR. Copyright holder. utils golem","code":""},{"path":"https://rinterface.github.io/charpente/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Granjon D, Coene J (2024). charpente: Seamlessly design robust 'shiny' extensions. R package version 0.7.0, https://rinterface.github.io/charpente/, https://github.com/RinteRface/charpente.","code":"@Manual{, title = {charpente: Seamlessly design robust 'shiny' extensions}, author = {David Granjon and John Coene}, year = {2024}, note = {R package version 0.7.0, https://rinterface.github.io/charpente/}, url = {https://github.com/RinteRface/charpente}, }"},{"path":"https://rinterface.github.io/charpente/index.html","id":"charpente-","dir":"","previous_headings":"","what":"Seamlessly design robust shiny extensions","title":"Seamlessly design robust shiny extensions","text":"goal charpente significantly reduce complexity creating new HTML templates Shiny: charpente creates plug play package structure. charpente automatically import dependencies jsdelivr, don’t hand! charpente eases conversion HTML R. charpente offers multiple R JS boilerplate shiny input bindings, shiny message handlers, … charpente enables seamless JavaScript code management (powered esbuild): concat, compress, mangle, bundle, minify, … JS Sass code.","code":""},{"path":"https://rinterface.github.io/charpente/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Seamlessly design robust shiny extensions","text":"can install development version charpente Github :","code":"# latest version remotes::install_github(\"RinteRface/charpente\")"},{"path":"https://rinterface.github.io/charpente/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Seamlessly design robust shiny extensions","text":"basic example shows solve common problem:","code":"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()"},{"path":"https://rinterface.github.io/charpente/index.html","id":"using-esbuild-and-mocha","dir":"","previous_headings":"","what":"Using esbuild and mocha","title":"Seamlessly design robust shiny extensions","text":"want use esbuild mocha existing project, can use functions set_esbuild() set_mocha(). simple workflow looks follows:","code":"# Setup esbuild for JS code management set_esbuild() # Add mocha for tests set_mocha()"},{"path":"https://rinterface.github.io/charpente/index.html","id":"monolithic-and-component-based-bundling","dir":"","previous_headings":"","what":"Monolithic and component based bundling","title":"Seamlessly design robust shiny extensions","text":"charpente offers two ways bundling JS code: monolithic component based. monolithic bundling default one simplest use. bundle JS CSS code single files. default, entry point /scrjs/main.js, also created setting esbuild first time set_esbuid(). case bundling easy can achieved : Component based bundling might convenient situations want create bundle (standalone) component. Bundling per component make sure necessary assets loaded. particularly useful want create package multiple components, complete template. use component based bundling, can specify multiple entry_points build_js(). structure /srcjs folder: can build follows: CSS styles component can loaded js files import statements, e.g. import \"../styles/component1.scss\";. JS code bundled /inst/{package-name}-{version}/. Dependencies HTML automatically created R/{package-name}-dependencies.R. one HTML dependency case monolithic building, multiple case component based building.","code":"build_js() srcjs ├── component1.js └── component2.js build_js(entry_points = c(\"component1.js\", \"component2.js\"))"},{"path":"https://rinterface.github.io/charpente/index.html","id":"acknowledgment","dir":"","previous_headings":"","what":"Acknowledgment","title":"Seamlessly design robust shiny extensions","text":"author like warmly thank Victor Perrier, John Coene, Colin Fay, Alan Dipert, Kenton Russel providing many building block inspiration package.","code":""},{"path":"https://rinterface.github.io/charpente/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Seamlessly design robust shiny extensions","text":"Please note charpente project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://rinterface.github.io/charpente/reference/build_js.html","id":null,"dir":"Reference","previous_headings":"","what":"Compress and optimize all files in the current folder — build_js","title":"Compress and optimize all files in the current folder — build_js","text":"Generates minified file inst/pkg_name-pkg_version, mode prod. mode dev, aggregates js files without mangling compression.","code":""},{"path":"https://rinterface.github.io/charpente/reference/build_js.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compress and optimize all files in the current folder — build_js","text":"","code":"build_js(dir = \"srcjs\", mode = c(\"prod\", \"dev\"), entry_points = \"main.js\")"},{"path":"https://rinterface.github.io/charpente/reference/build_js.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compress and optimize all files in the current folder — build_js","text":"dir Default srcjs. mode Production development mode. Choose either \"prod\" \"dev\". \"prod\" bundles, aggregates minifyies files. \"dev\" bundles code. Modules follow ES6 format (import/export). entry_points Entry point(s) use esbuild configuration. case monolithic bundle, one entrypoint needed. default. case component based bundles, vector entrypoints needed. output files match entrypoints names.","code":""},{"path":"https://rinterface.github.io/charpente/reference/charpente_options.html","id":null,"dir":"Reference","previous_headings":"","what":"Configure charpente — charpente_options","title":"Configure charpente — charpente_options","text":"Configure charpente","code":""},{"path":"https://rinterface.github.io/charpente/reference/charpente_options.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Configure charpente — charpente_options","text":"","code":"charpente_options(local = TRUE)"},{"path":"https://rinterface.github.io/charpente/reference/charpente_options.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Configure charpente — charpente_options","text":"local Whether download files locally point CDN. Default TRUE.","code":""},{"path":"https://rinterface.github.io/charpente/reference/charpente_options.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Configure charpente — charpente_options","text":"list options.","code":""},{"path":"https://rinterface.github.io/charpente/reference/copy_charpente_utils.html","id":null,"dir":"Reference","previous_headings":"","what":"Copy charpente utils function — copy_charpente_utils","title":"Copy charpente utils function — copy_charpente_utils","text":"Copy charpente utils function","code":""},{"path":"https://rinterface.github.io/charpente/reference/copy_charpente_utils.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Copy charpente utils function — copy_charpente_utils","text":"","code":"copy_charpente_utils(pkg_name)"},{"path":"https://rinterface.github.io/charpente/reference/copy_charpente_utils.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Copy charpente utils function — copy_charpente_utils","text":"Copy charpente utils function ./R/PKG_NAM-utils.R script","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_charpente.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a package using charpente and usethis conventions — create_charpente","title":"Create a package using charpente and usethis conventions — create_charpente","text":"charpente powered package differ package structure. create_charpente calls series function help quickly setting package structure.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_charpente.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a package using charpente and usethis conventions — create_charpente","text":"","code":"create_charpente(path, remote = NULL, private = FALSE, license)"},{"path":"https://rinterface.github.io/charpente/reference/create_charpente.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a package using charpente and usethis conventions — create_charpente","text":"path path. exists, used. exist, created, provided parent path exists. remote Name remote Github organization connect . private Whether repository private. Default FALSE. license license project ?","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_charpente.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a package using charpente and usethis conventions — create_charpente","text":"","code":"if (FALSE) { create_charpente(\"bs4Dash\") }"},{"path":"https://rinterface.github.io/charpente/reference/create_custom_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Imports Internal Dependencies — create_custom_dependency","title":"Imports Internal Dependencies — create_custom_dependency","text":"Wrap internal scripts stylesheets one htmlDependency.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_custom_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Imports Internal Dependencies — create_custom_dependency","text":"","code":"create_custom_dependency( name, version, entry_points, open = interactive(), mode )"},{"path":"https://rinterface.github.io/charpente/reference/create_custom_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Imports Internal Dependencies — create_custom_dependency","text":"name Package name. version Package version. entry_points Entry points create dependency . open Whether allow rstudioapi open newly created script. Default TRUE. mode Internal. use.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Imports External Dependencies — create_dependency","title":"Imports External Dependencies — create_dependency","text":"Download create dependency function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Imports External Dependencies — create_dependency","text":"","code":"create_dependency( name, tag = NULL, open = interactive(), options = charpente_options() )"},{"path":"https://rinterface.github.io/charpente/reference/create_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Imports External Dependencies — create_dependency","text":"name Name library. tag Library version. Default NULL. NULL, takes latest version. open Whether allow rstudioapi open newly created script. Default TRUE. options See charpente_options.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_dependency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Imports External Dependencies — create_dependency","text":"","code":"if (FALSE) { create_dependency(\"tabler\") # Use CDNs create_dependency( \"framework7\", options = charpente_options(local = FALSE) ) }"},{"path":"https://rinterface.github.io/charpente/reference/create_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a shiny custom input binding boilerplate — create_input_binding","title":"Create a shiny custom input binding boilerplate — create_input_binding","text":"Creates script inst R part ./R","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a shiny custom input binding boilerplate — create_input_binding","text":"","code":"create_input_binding( name, pkg = \".\", dir = \"srcjs\", open = TRUE, initialize = FALSE, dev = FALSE, events = list(name = \"click\", rate_policy = FALSE), add_reference = TRUE ) create_output_binding( name, pkg = \".\", dir = \"srcjs\", open = TRUE, add_reference = TRUE ) create_custom_handler( name, pkg = \".\", dir = \"srcjs\", open = TRUE, add_reference = TRUE ) create_js( name, dir = \"srcjs\", open = TRUE, with_doc_ready = FALSE, template = golem::js_template, ..., add_reference = TRUE ) create_scss( name, dir = \"styles\", open = TRUE, template = golem::sass_template, ..., add_reference = TRUE )"},{"path":"https://rinterface.github.io/charpente/reference/create_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a shiny custom input binding boilerplate — create_input_binding","text":"name name module. pkg Path root package. Default get_golem_wd(). dir Path dir file created. open created file opened? initialize JS file - Whether add initialize method. Default FALSE. JavaScript API require initialize components using . dev Whether insert console.log calls important methods binding. help building input binding. Default FALSE. events List events generate event listeners subscribe method. instance, list(name = c(\"click\", \"keyup\"), rate_policy = c(FALSE, TRUE)). list contain names rate policies apply event. rate policy found, debounce method default delay 250 ms applied. may edit manually according https://shiny.rstudio.com/articles/building-inputs.html add_reference Whether add import statement main.js. Defaults TRUE. with_doc_ready JS file - default file include $( document ).ready()? template Function writing created file. may overwrite template function. ... Arguments passed template function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a manifest for your shiny app — create_manifest","title":"Create a manifest for your shiny app — create_manifest","text":"central piece want app standalone instance","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a manifest for your shiny app — create_manifest","text":"","code":"create_manifest( path, name = \"My Progressive Web App\", shortName = \"My App\", description = \"What it does!\", lang = \"en-US\", startUrl = \"/\", display = c(\"standalone\", \"minimal-ui\", \"fullscreen\", \"browser\"), background_color = \"#ffffff\", theme_color = \"#ffffff\" )"},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a manifest for your shiny app — create_manifest","text":"path App path. name App name. shortName App short name. description App description lang App language (en-US default). startUrl Page open start. display Display mode. Choose among c(\"minimal-ui\", \"standalone\", \"fullscreen\", \"browser\"). practice, want standalone mode app looks like native app. background_color background_color property used splash screen application first launched. theme_color theme_color sets color tool bar, may reflected app's preview task switchers.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a manifest for your shiny app — create_manifest","text":"function creates www folder shiny app. Must specify path. creates 1 folders contain icons manifest.json file.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a manifest for your shiny app — create_manifest","text":"See https://developer.mozilla.org/en-US/docs/Web/Manifest informations.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_manifest.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a manifest for your shiny app — create_manifest","text":"","code":"create_manifest( path = tempdir(), name = \"My App\", shortName = \"My App\", description = \"What it does!\", lang = \"en-US\", startUrl = \"https://www.google.com/\", display = \"standalone\", background_color = \"#3367D6\", theme_color = \"#3367D6\" ) #> ✔ Web manifest successfully created!"},{"path":"https://rinterface.github.io/charpente/reference/create_pwa_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a PWA dependency — create_pwa_dependency","title":"Create a PWA dependency — create_pwa_dependency","text":"List relevant pwa resources custom dependency. Includes web manifest + icons using head parameter htmltools::htmlDependency.","code":""},{"path":"https://rinterface.github.io/charpente/reference/create_pwa_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a PWA dependency — create_pwa_dependency","text":"","code":"create_pwa_dependency(open = interactive())"},{"path":"https://rinterface.github.io/charpente/reference/create_pwa_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a PWA dependency — create_pwa_dependency","text":"open Whether allow rstudioapi open newly created script. Default TRUE.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_assets.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all links to dependencies — get_dependency_assets","title":"Get all links to dependencies — get_dependency_assets","text":"Query https://data.jsdelivr.com/v1/package/npm/ hood.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_assets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all links to dependencies — get_dependency_assets","text":"","code":"get_dependency_assets(dep, tag = \"latest\")"},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_assets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get all links to dependencies — get_dependency_assets","text":"dep Library name. tag Library version. Default latest.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_assets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all links to dependencies — get_dependency_assets","text":"list url containing links CSS JS dependencies given library.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_assets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all links to dependencies — get_dependency_assets","text":"","code":"if (FALSE) { get_dependency_assets(\"bootstrap\") get_dependency_assets(\"framework7\", tag = \"5.5.5\") }"},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_versions.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all version for the current dependency — get_dependency_versions","title":"Get all version for the current dependency — get_dependency_versions","text":"Query https://data.jsdelivr.com/v1/package/npm/ hood.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all version for the current dependency — get_dependency_versions","text":"","code":"get_dependency_versions(dep, latest = FALSE)"},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get all version for the current dependency — get_dependency_versions","text":"dep Library name. latest Whether get last version. Default FALSE.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all version for the current dependency — get_dependency_versions","text":"vector containing versions","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_dependency_versions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all version for the current dependency — get_dependency_versions","text":"","code":"if (FALSE) { get_dependency_versions(\"framework7\") get_dependency_versions(\"bootstrap\") get_dependency_versions(\"react\", latest = TRUE) }"},{"path":"https://rinterface.github.io/charpente/reference/get_installed_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the version of the current installed dependency — get_installed_dependency","title":"Get the version of the current installed dependency — get_installed_dependency","text":"Used update_dependency.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_installed_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the version of the current installed dependency — get_installed_dependency","text":"","code":"get_installed_dependency(name)"},{"path":"https://rinterface.github.io/charpente/reference/get_installed_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the version of the current installed dependency — get_installed_dependency","text":"name Library name","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_installed_dependency.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the version of the current installed dependency — get_installed_dependency","text":"character containing version number","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_pkg_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieves Package Name — get_pkg_name","title":"Retrieves Package Name — get_pkg_name","text":"Retrieves Package Name","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_pkg_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieves Package Name — get_pkg_name","text":"","code":"get_pkg_name()"},{"path":"https://rinterface.github.io/charpente/reference/get_pkg_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieves Package Name — get_pkg_name","text":"Name package.","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Return the full path for a default file template — get_template","title":"Return the full path for a default file template — get_template","text":"Return full path default file template","code":""},{"path":"https://rinterface.github.io/charpente/reference/get_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return the full path for a default file template — get_template","text":"","code":"get_template(file, where)"},{"path":"https://rinterface.github.io/charpente/reference/get_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return the full path for a default file template — get_template","text":"file Name file including file extension. find template.","code":""},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert HTML content to R Shiny tags — html_2_R","title":"Convert HTML content to R Shiny tags — html_2_R","text":"Convert HTML content R Shiny tags","code":""},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert HTML content to R Shiny tags — html_2_R","text":"","code":"html_2_R(html, path = \"/html/body/*\", prefix = TRUE)"},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert HTML content to R Shiny tags — html_2_R","text":"html HTML string path Path extract elements. Default body content. prefix Whether prefix elements tag$...","code":""},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert HTML content to R Shiny tags — html_2_R","text":"list R Shiny tags","code":""},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Convert HTML content to R Shiny tags — html_2_R","text":"Alan Dipert, RStudio","code":""},{"path":"https://rinterface.github.io/charpente/reference/html_2_R.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert HTML content to R Shiny tags — html_2_R","text":"","code":"if (interactive()) { library(charpente) bs4_card <- '
![\"Card](\"...\")
Card title<\/h5>
Some quick example text.<\/p> Go somewhere<\/a> <\/div> <\/div>' html_2_R(bs4_card) ## With non standard attributes tag <- \"<\/div>\" html_2_R(tag) }"},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Golem's default custom templates — js_handler_template","title":"Golem's default custom templates — js_handler_template","text":"functions aim called users, passed argument create_custom_handler function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Golem's default custom templates — js_handler_template","text":"","code":"js_handler_template(path, name, code = \" \")"},{"path":"https://rinterface.github.io/charpente/reference/js_handler_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Golem's default custom templates — js_handler_template","text":"path path JS script template written. name Shiny's custom handler name. code JavaScript code written function.","code":""},{"path":"https://rinterface.github.io/charpente/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://rinterface.github.io/charpente/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert provided parameters into template — process_template","title":"Insert provided parameters into template — process_template","text":"Insert provided parameters template","code":""},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert provided parameters into template — process_template","text":"","code":"process_template( template, ..., where = system.file(\"utils\", package = \"charpente\") )"},{"path":"https://rinterface.github.io/charpente/reference/process_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert provided parameters into template — process_template","text":"template Template obtained get_template. ... List parameters insert template. find template.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":null,"dir":"Reference","previous_headings":"","what":"Add script.js to main.js entry point. — reference_script","title":"Add script.js to main.js entry point. — reference_script","text":"Needed keep entry point date","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add script.js to main.js entry point. — reference_script","text":"","code":"reference_script(name)"},{"path":"https://rinterface.github.io/charpente/reference/reference_script.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add script.js to main.js entry point. — reference_script","text":"name Script name.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert import into main SCSS file — reference_style","title":"Insert import into main SCSS file — reference_style","text":"Useful reference scss files main one.","code":""},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert import into main SCSS file — reference_style","text":"","code":"reference_style(path)"},{"path":"https://rinterface.github.io/charpente/reference/reference_style.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert import into main SCSS file — reference_style","text":"path file.name folder/file.name","code":""},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":null,"dir":"Reference","previous_headings":"","what":"Run esbuild — run_esbuild","title":"Run esbuild — run_esbuild","text":"Apply esbuild srcjs folder.","code":""},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run esbuild — run_esbuild","text":"","code":"run_esbuild(mode, outputDir, entry_points)"},{"path":"https://rinterface.github.io/charpente/reference/run_esbuild.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run esbuild — run_esbuild","text":"mode Production development mode. Choose either \"prod\" \"dev\". \"prod\" bundles, aggregates minifyies files. \"dev\" bundles code. Modules follow ES6 format (import/export). outputDir Output directory entry_points Entry points used","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup esbuild — set_esbuild","title":"Setup esbuild — set_esbuild","text":"Installs esbuild local project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup esbuild — set_esbuild","text":"","code":"set_esbuild(light = FALSE)"},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup esbuild — set_esbuild","text":"light Used install Sass plugins. workaround breaking change charpente styles exist old versions.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_esbuild.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup esbuild — set_esbuild","text":"Installs esbuild node_modules (dev scope), existing, creates srcjs + srcjs/main.js andstyles + styles/main.scss, sets relevant files folders .gitignore. .Rbuildignore.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup mocha — set_mocha","title":"Setup mocha — set_mocha","text":"Installs mocha local project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup mocha — set_mocha","text":"","code":"set_mocha()"},{"path":"https://rinterface.github.io/charpente/reference/set_mocha.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup mocha — set_mocha","text":"Installs mocha node_modules (dev scope), creates srcjs/test folder, write basic test im test_basic.js","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":null,"dir":"Reference","previous_headings":"","what":"Utils to set up a PWA compatible structure — set_pwa","title":"Utils to set up a PWA compatible structure — set_pwa","text":"Creates web manifest, service-worker.js, icons set necessary dependencies. app must part package. Must used package root app root.","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Utils to set up a PWA compatible structure — set_pwa","text":"","code":"set_pwa( path, name = \"My Progressive Web App\", shortName = \"My App\", description = \"What it does!\", lang = \"en-US\", startUrl = \"/\", display = c(\"standalone\", \"minimal-ui\", \"fullscreen\", \"browser\"), background_color = \"#ffffff\", theme_color = \"#ffffff\", register_service_worker = TRUE, create_dependencies = TRUE )"},{"path":"https://rinterface.github.io/charpente/reference/set_pwa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Utils to set up a PWA compatible structure — set_pwa","text":"path App path. name App name. shortName App short name. description App description lang App language (en-US default). startUrl Page open start. display Display mode. Choose among c(\"minimal-ui\", \"standalone\", \"fullscreen\", \"browser\"). practice, want standalone mode app looks like native app. background_color background_color property used splash screen application first launched. theme_color theme_color sets color tool bar, may reflected app's preview task switchers. register_service_worker Whether register service worker. Default TRUE. change file name service-worker.js!!! create_dependencies Default TRUE. Relevant used shinyMobile context. used outside, must set FALSE handle dependencies .","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup version control — set_version_control","title":"Setup version control — set_version_control","text":"Sets git optionally link github current project","code":""},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup version control — set_version_control","text":"","code":"set_version_control(remote, private)"},{"path":"https://rinterface.github.io/charpente/reference/set_version_control.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup version control — set_version_control","text":"remote Name remote Github organization connect . private Whether repository private. Default FALSE.","code":""},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":null,"dir":"Reference","previous_headings":"","what":"Test JS code — test_js","title":"Test JS code — test_js","text":"Test entire srcjs/test folder","code":""},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test JS code — test_js","text":"","code":"test_js()"},{"path":"https://rinterface.github.io/charpente/reference/test_js.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test JS code — test_js","text":"message showing test results","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the given dependency to a specific version or latest — update_dependency","title":"Update the given dependency to a specific version or latest — update_dependency","text":"Update given dependency specific version latest","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the given dependency to a specific version or latest — update_dependency","text":"","code":"update_dependency(name, version_target = \"latest\")"},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the given dependency to a specific version or latest — update_dependency","text":"name Library name. version_target Targeted version. Default latest.","code":""},{"path":"https://rinterface.github.io/charpente/reference/update_dependency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the given dependency to a specific version or latest — update_dependency","text":"","code":"if (FALSE) { update_dependency(\"framework7\") }"},{"path":[]},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"new-0-7-0","dir":"Changelog","previous_headings":"","what":"New:","title":"charpente 0.7.0","text":"Enhanced esbuild configuration allow component based bundling. build_js now accepts entry_points argument specify entry files processed esbuild. (minified) output files correspond given entry files. default monolithic building ./srcjs/main.js file. See ?build_js details.","code":""},{"path":[]},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"new-0-6-0","dir":"Changelog","previous_headings":"","what":"New:","title":"charpente 0.6.0","text":"Allow initialise esbuild mocha standalone way, without need full charpente workflow. useful want use esbuild plugins already existing projects. See ?set_esbuild ?set_mocha details.","code":""},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"improvements-0-6-0","dir":"Changelog","previous_headings":"","what":"Improvements:","title":"charpente 0.6.0","text":"Move use_build_ignore() use_git_ignore() calls set_esbuild() enable standalone usage.","code":""},{"path":[]},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"breaking-change-0-5-0","dir":"Changelog","previous_headings":"","what":"Breaking change:","title":"charpente 0.5.0","text":"Include Sass handling. SCSS files sorted /stylesfolder esbuild new Sass modules treat generate CSS. package.json now calls node esbuild.dev.js node esbuild.prod.js, depending selected mode, production development. esbuild.**.js new script processed run time project, called node package.json. come older charpente version, build_js() first try create /styles folder (normally don’t ) install missing Sass dependencies next esbuild (esbuild-sass-plugin, postcss, autoprefixer). get_dependency_assets() leverages new jsdlivr algorithm infer best entry point scripts JS CSS files, downloading dependencies within create_dependency(). likely change vendors dependencies scripts names change features. charpente_options() likely deprecated previous point. still contains local option either point external CDN copy external vendore files local project. create_css() replaced create_scss() (can still use golem::create_css). one main SCSS file created project setup. SCSS files referenced main styles/main.scss using @import path, allow modular Sass code. Remove entry_point param build_js() used anyway…","code":""},{"path":"https://rinterface.github.io/charpente/news/index.html","id":"charpente-010","dir":"Changelog","previous_headings":"","what":"charpente 0.1.0","title":"charpente 0.1.0","text":"Added NEWS.md file track changes package.","code":""}]