Inject CSS styling into RMD parametrization app #866

frankandrobot · 2016-11-11T17:36:37Z

Modified knit_params_ask so that it is possible to pass custom css/scripts, both as strings and as links to URIs.

Connected to #3945

This reverts commit 2858c1f.

aronatkins · 2016-11-11T17:43:46Z

R/params.R

@@ -203,7 +259,11 @@ knit_params_ask <- function(file = NULL,
 params = NULL,
 shiny_args = NULL,
 save_caption = "Save",
- encoding = getOption("encoding")) {
+ encoding = getOption("encoding"),
+ html_head_style = c(),


One option that won't pollute the argument list so much is to have a single argument that accepts a named list.

html_head = list()

Then, if you want to specify some parts:

html_head = list(style = "body { font-size: 15px; }")

Not sure which would be preferred.

Sorry, when I replied in the email, it put the comments in the wrong place.
I initially had the same idea, but as per @trestletech , the long form is preferred.

You could indeed go either way. I agree with @trestletech that R tends to stylistically prefer long argument lists. Even though this isn't normally good form in more well decomposed systems in R where many operations tend to be top level "one button" ones it makes some sense (also forces documentation of the parameters in .Rd as a side benefit).

aronatkins · 2016-11-11T17:45:21Z

R/params.R

@@ -186,6 +186,56 @@ params_namedList <- function() {
 empty
 }

+
+setup_html_head <- function(html_head_style = c(),


nit: all of our other param helper functions have "params" in their name. It's not the best namespacing, but it's something.

aronatkins · 2016-11-11T17:46:45Z

R/params.R

@@ -194,6 +244,12 @@ params_namedList <- function() {
 #' @param shiny_args Additional arguments to \code{\link[shiny:runApp]{runApp}}.
 #' @param save_caption Caption to use use for button that saves/confirms parameters.
 #' @param encoding The encoding of the input file; see \code{\link{file}}.
+#' @param html_head_style a string or a list/vector of strings representing CSS style that will be injected in the HTML HEAD.
+#' @param html_head_script a string or a list/vector of strings represeting JS scripts that will be injected in the HTML HEAD.


nit: spelling of representing

aronatkins · 2016-11-11T17:50:03Z

R/params.R

+ html_head_style <- as.vector(html_head_style)
+ custom_styles <- lapply(html_head_style, shiny::tags$style)
+
+ html_head_script <- as.vector(html_head_script)


Why the as.vector conversion? Am I missing some subtlety?

a <- c(1,2) lapply(a, function(b) b*2) lapply(as.vector(a), function(b) b*2)

Again, sorry, when I replied in the email, it put the comments in the wrong place.

the params can be strings or vector of strings.

aronatkins · 2016-11-11T17:50:28Z

R/params.R

+ "body { padding-bottom: 70px; }"
+ )
+ ## Escape is "cancel" and Enter is "save".
+ default_script <- shiny::tags$script(shiny::HTML("$(document).keyup(function(e) {\n",


Any situation where we will want to not inject the defaults?

frankandrobot · 2016-11-11T18:57:36Z

As per Jeff, the long form is preferred
On Nov 11, 2016 11:43 AM, "Aron Atkins" [email protected] wrote:

@aronatkins commented on this pull request.

In R/params.R
#866 (review):
@@ -203,7 +259,11 @@ knit_params_ask <- function(file = NULL,
params = NULL,
shiny_args = NULL,
save_caption = "Save",
                       encoding = getOption("encoding")) {
                       encoding = getOption("encoding"),
                       html_head_style = c(),
One option that won't pollute the argument list so much is to have a
single argument that accepts a named list.

html_head = list()

Then, if you want to specify some parts:

html_head = list(style = "body { font-size: 15px; }")

Not sure which would be preferred.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#866 (review),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAwDMQQswdEcuq1_MZv0LmuyKws7_hEmks5q9KlUgaJpZM4Kv-J1
.

frankandrobot · 2016-11-11T18:58:22Z

It can be a string or a list of strings
On Nov 11, 2016 11:50 AM, "Aron Atkins" [email protected] wrote:

@aronatkins commented on this pull request.

In R/params.R
#866 (review):
".navbar button { margin-left: 10px; }",

Style for the navbar footer.

http://getbootstrap.com/components/#navbar-fixed-bottom

"body { padding-bottom: 70px; }"

)

Escape is "cancel" and Enter is "save".

default_script <- shiny::tags$script(shiny::HTML("$(document).keyup(function(e) {\n",
                                      "if (e.which == 13) { $('#save').click(); } // enter\n",
                                      "if (e.which == 27) { $('#cancel').click(); } // esc\n",
                                      "});"
))
html_head_style <- as.vector(html_head_style)

custom_styles <- lapply(html_head_style, shiny::tags$style)

html_head_script <- as.vector(html_head_script)
Why the as.vector conversion? Am I missing some subtlety?

a <- c(1,2)
lapply(a, function(b) b_2)
lapply(as.vector(a), function(b) b_2)

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#866 (review),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAwDMWXOWEF7TfeketUJeKSsu0MyYJgUks5q9KrMgaJpZM4Kv-J1
.

frankandrobot · 2016-11-11T21:24:45Z

Ok tweaked as requested and added tests. This is re-ready for review @trestletech @aronatkins

aronatkins

Could we work through the Connect integration before calling this final? In particular, I'm interested in how we are going to hide the ok/cancel buttons, suppress the enter/escape handling, and inject ok/cancel actions from the parent iframe.

jjallaire · 2016-11-14T19:29:23Z

That's fine. We are going to ship a new version of rmarkdown CRAN around
the end of this week (to support the forthcoming IDE patch release). We are
happy to do another rmarkdown release in a month's time if this work misses
the current release.

On Mon, Nov 14, 2016 at 2:24 PM, Aron Atkins [email protected]
wrote:

@aronatkins commented on this pull request.

Could we work through the Connect integration before calling this final?
In particular, I'm interested in how we are going to hide the ok/cancel
buttons, suppress the enter/escape handling, and inject ok/cancel actions
from the parent iframe.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#866 (review),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAGXx_bSea28lbgY8PhA7v1ctaNuuAZbks5q-LVWgaJpZM4Kv-J1
.

frankandrobot · 2016-11-14T21:12:06Z

Could we work through the Connect integrati I'm interested in how we aregoing to hide the ok/cancel buttons, suppress the enter/escape handling,and inject ok/cancel actions from the parent iframe.

This code is designed to override the defaults with the custom. So for
example, to supress the handling, if I recall correctly, it's just an event
that can be easily over ridden. The hiding is similar via css.

What is the use case to insert actions? In any case, all you do is insert
JavaScript to handle the actions.

Update: after taking a better look at the code, I noticed that there might be enough logic in the shiny R code for inputs, to keep this strategy from working for certain use cases, for example, default (blank) param support. @aronatkins we should touch base in the am so i can get a better idea of what the use cases are

trestletech · 2016-11-16T22:39:09Z

R/params.R

@@ -250,6 +250,7 @@ params_html_head <- function(html_head_style = c(),
 #' You must take care to unsure that the URL is absolute.
 #' @param html_head_script_link same as above except that these are interpreted as SRC attributes in SCRIPT tags.
 #' You must take care to unsure that the URL is absolute.
+#' @param disable_bootstrap if true, does not inject boostrap scripts and styles in the HTML HEAD.


I don't know what the common formatting is for this package, but you could consider styling with if \code{TRUE}, does not... Probably more important to align with the conventions of the package but just making sure you're aware of the option.

CLAassistant · 2020-09-24T18:34:07Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

Uriel Avalos seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Uriel Avalos added 4 commits November 10, 2016 17:01

added script/style string support

2858c1f

Revert "added script/style string support"

90b0ada

This reverts commit 2858c1f.

[params] added support for custom CSS/scripts

b0961f4

Merge branch 'uriel/knit_with_params'

78958a6

aronatkins reviewed Nov 11, 2016

View reviewed changes

Uriel Avalos added 2 commits November 11, 2016 15:20

[params] added tests to params_html_head

99e714d

[params] typo in docs

202f3e9

aronatkins reviewed Nov 14, 2016

View reviewed changes

Uriel Avalos added 3 commits November 16, 2016 12:22

[params] removed bootstrap

c1ab123

[params] added support for disabling bootstrap

cfec064

[doc] updated docs

7f4acd0

trestletech reviewed Nov 16, 2016

View reviewed changes

Merge branch 'master' of https://github.com/rstudio/rmarkdown

b8bb6f0

yihui force-pushed the master branch 2 times, most recently from 9ce8b28 to 2e8b846 Compare May 30, 2020 03:35

yihui force-pushed the master branch from c14b967 to 51224f0 Compare October 12, 2020 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inject CSS styling into RMD parametrization app #866

Inject CSS styling into RMD parametrization app #866

frankandrobot commented Nov 11, 2016

aronatkins Nov 11, 2016

frankandrobot Nov 11, 2016

jjallaire Nov 13, 2016

aronatkins Nov 11, 2016

aronatkins Nov 11, 2016

aronatkins Nov 11, 2016

frankandrobot Nov 11, 2016

aronatkins Nov 11, 2016

frankandrobot commented Nov 11, 2016

@aronatkins commented on this pull request.

frankandrobot commented Nov 11, 2016

@aronatkins commented on this pull request.

Style for the navbar footer.

http://getbootstrap.com/components/#navbar-fixed-bottom

Escape is "cancel" and Enter is "save".

frankandrobot commented Nov 11, 2016

aronatkins left a comment

jjallaire commented Nov 14, 2016

frankandrobot commented Nov 14, 2016 •

edited

trestletech Nov 16, 2016

CLAassistant commented Sep 24, 2020

Inject CSS styling into RMD parametrization app #866

Are you sure you want to change the base?

Inject CSS styling into RMD parametrization app #866

Conversation

frankandrobot commented Nov 11, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankandrobot commented Nov 11, 2016

@aronatkins commented on this pull request.

frankandrobot commented Nov 11, 2016

@aronatkins commented on this pull request.

Style for the navbar footer.

Escape is "cancel" and Enter is "save".

frankandrobot commented Nov 11, 2016

aronatkins left a comment

Choose a reason for hiding this comment

jjallaire commented Nov 14, 2016

frankandrobot commented Nov 14, 2016 • edited

Choose a reason for hiding this comment

CLAassistant commented Sep 24, 2020

frankandrobot commented Nov 14, 2016 •

edited