Improve examples in navs_tab() and family
#521
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In short: start waiting and then navigate. Those happen asynchronously, so we await the ansyc with `$wait_for({async_result})`
schloerke
reviewed
Mar 29, 2023
schloerke
added a commit
to rstudio/shiny-workflows
that referenced
this pull request
Mar 29, 2023
Originally from rstudio/bslib#521 Co-Authored-By: Garrick Aden-Buie <garrick@adenbuie.com>
schloerke
reviewed
Mar 29, 2023
schloerke
reviewed
Mar 29, 2023
cpsievert
reviewed
Apr 12, 2023
cpsievert
reviewed
Apr 12, 2023
cpsievert
reviewed
Apr 12, 2023
cpsievert
reviewed
Apr 12, 2023
cpsievert
approved these changes
Apr 12, 2023
Member
Author
|
(The last commit was to make sure we're not going to get frequent routine bot commits with updated screenshots. And it looks like we're okay.) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the examples for
navs_tab(),navs_pill(), etc. to include complete and (nearly) selc-contained examples that are more friendly for copy-pasting.I tried unsuccessfully to come up with a solution that uses the
@examplessection combined with a custompkgdown_printmethod. Unfortunately there are a few too many moving pieces for that approach to work right now.The approach in this PR is to use an Rmd fragment (aka child document in a roxygen2 context) that renders the examples, takes a screenshot, and then replaces the output with the screenshot. The previews are static as a result, but they also appear in both the pkgdown site and the R package docs, which is overall an improvement in my opinion.
By default the screenshot previews are re-generated when calling
devtools::document()on CI so they will automatically stay up to date with our routine workflows. I've also modified bslib'sroutine.shto runoptipngon png files inman/figuresto keep the images small. In the end, they're each about 10 KB or less.