Skip to content

Commit 5ddd6cc

Browse files
committed
add a summary section to the events vignette
1 parent 9105dd7 commit 5ddd6cc

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

vignettes/events.Rmd

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,24 @@ $(document).on('shiny:value', function(event) {
8686

8787
The `shiny:updateinput` event is triggered when an input is updated, e.g., when you call `updateTextInput()` in R to update the label or value of a text input. The event object has properties `message` (the update message sent from the server) and `binding` (the input binding).
8888

89+
# Summary
90+
91+
Here is a summary of the events. The ones that are cancelable can also be modified by users, e.g., you can change `event.value` in the `shiny:inputchanged` event, and the new `event.value` will be used as the input value (to be passed to R).
92+
93+
```{r echo=FALSE}
94+
knitr::kable(matrix(c(
95+
'shiny:connected', 'socket', 'No', 'document',
96+
'shiny:disconnected', 'socket', 'No', 'document',
97+
'shiny:busy', '', 'No', 'document',
98+
'shiny:idle', '', 'No', 'document',
99+
'shiny:inputchanged', 'name, value, inputType', 'Yes', 'document',
100+
'shiny:message', 'message', 'Yes', 'document',
101+
'shiny:bound', 'binding, bindingType', 'No', 'input/output element',
102+
'shiny:unbound', 'binding, bindingType', 'No', 'input/output element',
103+
'shiny:value', 'name, value, binding', 'Yes', 'output element',
104+
'shiny:error', 'name, error, binding', 'Yes', 'output element',
105+
'shiny:updateinput', 'message, binding', 'Yes', 'input element'
106+
), ncol = 4, byrow = TRUE,
107+
dimnames = list(NULL, c('Name', 'Event Properties', 'Cancelable', 'Target'))))
108+
```
109+

0 commit comments

Comments
 (0)