Releases: cwthom/shinyhelper
shinyhelper 0.3.2
shinyhelper 0.3.1
Welcome to shinyhelper 0.3.1. This patch version introduces three new elements to the package, to fix bugs in 0.3.0.
New features:
helper
icons now work within dynamically rendered UI- inline content now supports HTML strings for formatting
- mathematical formulae can be rendered in help files, using MathJax
Fixed bugs:
- help icons now no longer overlie drop down lists (lower z-index)
Thanks to GitHub user kornl for spotting and fixing the MathJax and z-index bugs.
shinyhelper 0.3.0
shinyhelper 0.3.0
Welcome to shinyhelper 0.3.0 - this version of the package is a complete re-write of the previous version and is NOT BACKWARDS COMPATIBLE. This change has been to make the package less of a hack and more of a proper extension of shiny
. It also brings in a smoother interface for app developers, with fewer function calls necessary for the package to work, and less intrusion into the workings of your apps.
New features:
- No longer dependent on package
shinyjs
- No need for the
use_shinyhelper()
function - this has been removed - Can now pass inline content as well as markdown files to your shiny app. This means that short help dialog boxes can be defined entirely within the UI of your app, where they should be. Just use the
type
argument tohelper()
withtype = "inline"
- The modals created by
helper()
now haveeasyClose = TRUE
, so can be shut by clicking anywhere or pressing ESC observe_helpers()
now has no mandatory arguments; it can be called as-is- Information such as the size and content of help pages is now stored in data-* attributes of the HTML tags created by
helper()
- previously it was bodged together in the ID. create_help_files()
will create a directory called "helpfiles" by default.
Non-backwards compatible changes:
- Various arguments to
helper()
have been renamed or replaced. observe_helpers()
now looks at the session object rather thaninput
andoutput
directly.shinyhelperDemo()
has been renamedshinyhelper_demo()
to match othersnake_case
naming convention throughout the package.
Thanks:
Thanks go to Dean Attali for his feedback on v0.2.0
shinyhelper 0.2.0
shinyhelper 0.2.0
Welcome to shinyhelper v0.2.0 - this is an improved version on the original package, with greater freedom and ease for you to customise your app UI.
New Features:
- dedicated
icon_colour
argument tohelper()
- no need to usestyle = "color = ...;"
any more - set size of each help page individually with the
size
argument tohelper()
- no more named lists! - use a file name of your choice for your markdown help pages - no longer need to have the same as the shiny.tag input and output IDs
- new
shinyhelperDemo()
function, to run a demo app that comes installed with the package
Deprecated Features:
- the
sizes
anddefault_size
arguments toobserve_helpers()
have been deprecated. They're still there, but will give a warning message if you try to use them.
I've also improved the documentation in the man pages.
Note there are currently errors showing on CRAN for windows binaries for R 3.4 and 3.5. These may be safely ignored - they are due to the CRAN build environment rather than the package.
First release to CRAN
First CRAN release
This is the first release of the 'shinyhelper' package. All information about the package at this point is contained in the README.