You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I went through our JS template process and ran into some documentation/template issues. I think these are bigger jobs which shouldn't block #46, so thought I'd break them out here:
Documentation
There are explanations and how-tos that we need to include here. IMO they are:
Explanation
An overview of how Shiny works:
Adding HTML dependenceis
A high level picture of how data flows from the UI to the server and back again
Inputs
What is an input binding and how does it work?
Outputs
Rendering decorators
Output bindings
JS best practices
Web components and why we use them
TypeScript and why we use it
How to
I think this should be broken down into a few cases:
Including JavaScript in your app
Building a package with a JS input
Building a package with a JS output
Building a React based package with both inputs and outputs
(Later, building a Vue extension, or a Svelte extension)
Appendix
What do the files in the template mean and do?
Template changes
I found it difficult to build a React output based on our current template because the output boilerplate wasn't included. I think we should include both inputs and outputs for each template because it's much easier to delete the boilerplate code than to find and add it. This would also reduce the number of templates we need because we wouldn't need an input/output one. The template structure for each JS framework would be something like:
example-apps
- input-app.py
- output-app.py
my-component
- my-component-input.py
- my-component-output.py
scrts
- index.tsx (include both input and output Javascript)
Out templates would then match the framework and include both Input and Output bindings:
JS template
React template
Vue template
Svelte template
The text was updated successfully, but these errors were encountered:
I went through our JS template process and ran into some documentation/template issues. I think these are bigger jobs which shouldn't block #46, so thought I'd break them out here:
Documentation
There are explanations and how-tos that we need to include here. IMO they are:
Explanation
How to
I think this should be broken down into a few cases:
Appendix
Template changes
I found it difficult to build a React output based on our current template because the output boilerplate wasn't included. I think we should include both inputs and outputs for each template because it's much easier to delete the boilerplate code than to find and add it. This would also reduce the number of templates we need because we wouldn't need an input/output one. The template structure for each JS framework would be something like:
Out templates would then match the framework and include both Input and Output bindings:
The text was updated successfully, but these errors were encountered: