Each vue_app() is an application of its own, so Vue's provide and
inject cannot reach from one to another. Vue's answer is a store, and
its store is Pinia's: this is one, defined from R with Pinia's own parts
– state, getters, actions, or a setup function – and reached in
every template as $vueStore.<id>: $vueStore.cart.count, a getter
$vueStore.cart.total, an action $vueStore.cart.add(1), at once and in the
browser. In a component's setup(), shinyVue.useStore("<id>") gives the
Pinia store itself (Pinia.storeToRefs() works on it).
Usage
vue_store(
id,
state = list(),
getters = NULL,
actions = NULL,
setup = NULL,
input = NULL,
outputs = NULL,
data = NULL
)Arguments
- id
The store's id:
$vueStore.<id>in templates, Pinia's store id.- state
Named list: the initial state.
- getters
Named list of
JS()functions ofstate, as Pinia's getters: values computed from the state, cached.- actions
Named list of
JS()functions, as Pinia's actions:thisis the store.- setup
A
JS()function returning the store's refs, computed and functions: Pinia's setup store, instead ofstate,gettersandactions.- input
Fields reported as
input$<id>, as forvue_app(): state or getters.- outputs
Outputs the store's state follows, as for
vue_app().- data
Deprecated:
state, under Vue's name for a component's state.
Details
It is also a component of the bridge, so the server reaches it the way
it reaches any other: input makes fields or getters input$<id>,
update_vue() sets its state – and every template showing it follows
–, call_vue() runs an action, its value coming back as
input$<id>_<action>, outputs fill its state from the server, and a
bookmark restores it.
A store can be anywhere on the page; stores are set up before the components that read them.
Examples
vue_store(
"cart",
state = list(count = 0, price = 3),
getters = list(
total = JS("function(state) { return state.count * state.price; }")
),
actions = list(add = JS("function(n) { this.count += n; }")),
input = "total"
)
#> <div id="cart" data-shiny-vue style="display: contents">
#> <script type="text/x-template" data-shiny-vue-template><span hidden></span></script>
#> <script type="application/json" data-shiny-vue-options>{"options":{"data":{"count":0,"price":3}},"input":"total","store":true,"storeDef":{"getters":{"total":"function(state) { return state.count * state.price; }"},"actions":{"add":"function(n) { this.count += n; }"}},"evals":["storeDef.getters.total","storeDef.actions.add"]}</script>
#> </div>
vue_app(
"add",
htmltools::tags$button(`@click` = "$vueStore.cart.add(1)", "Add")
)
#> <div id="add" data-shiny-vue style="display: contents">
#> <script type="text/x-template" data-shiny-vue-template><button @click="$vueStore.cart.add(1)">Add</button></script>
#> <script type="application/json" data-shiny-vue-options>{"options":{"data":[]},"evals":[]}</script>
#> </div>
vue_app(
"show",
htmltools::tags$span(
"{{ $vueStore.cart.count }} for {{ $vueStore.cart.total }}"
)
)
#> <div id="show" data-shiny-vue style="display: contents">
#> <script type="text/x-template" data-shiny-vue-template><span>{{ $vueStore.cart.count }} for {{ $vueStore.cart.total }}</span></script>
#> <script type="application/json" data-shiny-vue-options>{"options":{"data":[]},"evals":[]}</script>
#> </div>