shiny

Smoke tests require phantomjs to be available in your system path. This tool is used to visit the applications and capture output.

• Ubuntu: sudo apt-get install phantomjs
• macOS (Homebrew): brew install phantomjs
• Other: Download from http://phantomjs.org/download.html

# Ubuntu
apt-get install phantomjs

# macOS
brew install phantomjs

To install the stable version of the shiny package, use the standard R install.packages command from CRAN.

install.packages("shiny")

To update selectize and its accessibility plugin, run the updateSelectize.R script. This script downloads specific versions and applies patches from tools/selectize-patches.

To create a new patch:

1. Modify files in inst/www/shared/selectize.
2. Do not commit changes.
3. Create a patch file using git diff and save it to tools/selectize-patches/. Use an alphanumeric prefix (e.g., 000-description.patch) to ensure it is applied in the correct order.
4. Run updateSelectize.R to download the library and apply patches.
5. Test the changes.
6. git add the new .patch file and any resulting changes.

git diff > tools/selectize-patches/000-assign-unique-id-per-option.patch
updateSelectize.R

Use Reactive expressions to create values that automatically re-evaluate only when their specific dependencies change.

For example, if a reactive expression depends on a specific input field (e.g., a Variable field), it will re-calculate when that field changes, but it will not re-calculate if other unrelated inputs (e.g., a Show Outliers checkbox) are toggled. This optimizes performance by avoiding unnecessary computations.

To update ion.rangeSlider, run the updateIonRangeSlider.R script. This script downloads a specific version and applies existing patches located in tools/ion.rangeSlider-patches.

To create a new patch:

1. Modify files in inst/www/shared/ion.rangeSlider.
2. Do not commit changes.
3. Create a patch file using git diff and save it to tools/ion.rangeSlider-patches/. Use an alphanumeric prefix (e.g., 0004-description.patch) to ensure it is applied last.
4. Run updateIonRangeSlider.R to download the library and apply patches.
5. Test the changes.
6. Run devtools::document().
7. git add the new .patch file and any resulting changes.

git diff > tools/ion.rangeSlider-patches/0004-a-description.patch
updateIonRangeSlider.R
devtools::document()

To update the bootstrap-datepicker library, run the updateBootstrapDatepicker.R script.

To create a new patch:

1. Modify files in inst/www/shared/datepicker.
2. Do not commit changes.
3. Create a patch file using git diff and save it to tools/datepicker-patches/. Use an alphanumeric prefix (e.g., 012-description.patch) to ensure it is applied in the correct order (patches are applied alphabetically).
4. Source updateBootstrapDatepicker.R to download the library and apply all patches.
5. Test the changes.
6. git add the new .patch file and any resulting changes.

To enable file downloads in a Shiny application, you must combine two components:

1. UI Component: Add a downloadButton() to your user interface to provide the trigger for the user.
2. Server Logic: Implement a downloadHandler() within your server function. This handler manages the file content and the filename provided to the browser.

When developing TypeScript projects that interact with window.Shiny, install the Shiny TypeScript definitions to your package. Match the GitHub tag to your current Shiny CRAN release (e.g., v1.11.0).

If prompted to select a version of @types/jquery, choose the version that most closely matches your project's version.

To update the Shiny SCSS files:

1. Make changes to source files in inst/www/shared/shiny_scss.
2. Run npm run build to generate the built shiny.min.css file.
3. Commit the changes.