add wrapper function for reactable #87
Open
Conversation
This file contains 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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
rmbielby
requested changes
Jan 14, 2025
There was a problem hiding this comment.
Handful of things just to make it clear to end users how it's expected to be used and how it looks:
- Add a shinyapp style example in @examples
- Add a page with a dfe_reactable in the test dashboard (tests/test_dashboard/ui.R)
Also, dfe_reactable needs adding to the reference contents in _pkgdown.yml. Probably needs a new section, maybe "Charts and tables".
Finally, I think the following means that if you're going to document the params, then they should also be included in line 74. So I think for each one, we either remove the @params entry or add the param name on line 74.
- checking Rd \usage sections ... WARNING
Warning: Documented arguments not in \usage in Rd file 'dfe_reactable.Rd':
‘columns’ ‘columnGroups’ ‘rownames’ ‘groupBy’ ‘sortable’ ‘filterable’
‘searchable’ ‘searchMethod’ ‘defaultColDef’ ‘defaultColGroup’
‘defaultSortOrder’ ‘defaultSorted’ ‘pagination’ ‘defaultPageSize’
‘showPageSizeOptions’ ‘pageSizeOptions’ ‘paginationType’
‘showPagination’ ‘showPageInfo’ ‘minRows’ ‘paginateSubRows’ ‘details’
‘defaultExpanded’ ‘selection’ ‘defaultSelected’ ‘onClick’ ‘striped’
‘compact’ ‘wrap’ ‘class’ ‘style’ ‘rowClass’ ‘rowStyle’ ‘width’
‘height’ ‘meta’ ‘elementId’ ‘static’ ‘selectionId’
rmbielby
requested changes
Jan 15, 2025
This was referenced Jan 15, 2025
rmbielby
requested changes
Jan 17, 2025
Co-authored-by: Rich Bielby <[email protected]>
Co-authored-by: Rich Bielby <[email protected]>
Co-authored-by: Rich Bielby <[email protected]>
| @@ -15,4 +15,8 @@ | |||
| input_cookies = shiny::reactive(input$cookies), | |||
| google_analytics_key = ga_key # nolint: [object_usage_linter] | |||
| ) | |||
|
|
|||
| output$reactable_example <- reactable::renderReactable( | |||
| dfe_reactable(mtcars |> dplyr::select("mpg", "cyl", "hp", "gear")) | |||
Check notice
Code scanning / lintr
Indentation should be 4 spaces but is 5 spaces. Note test
rmbielby
requested changes
Jan 17, 2025
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.
Brief overview of changes
Added a new
dfe_reactablefunction to the dfeshiny package, which serves as a pre-configured wrapper around thereactable::reactablefunction. This function simplifies the creation of interactive and accessible tables with default styling and configurations tailored to Department for Education requirements.Why are these changes being made?
This change is being made to standardize the use of interactive tables across applications developed with dfeshiny, ensuring consistent design, accessibility, and functionality. It reduces repetitive coding for developers and provides users with a clean, user-friendly experience when viewing data in table formats.
Detailed description of changes
Introduced a
dfe_reactablefunction, which:reactabletables, including row highlighting, borderless design, and full-width tables.NAvalues.Added a unit test to validate the structure and configuration of the
reactableobject produced by thedfe_reactablefunction. This includes:highlight,borderless, andcolumns.Additional information for reviewers
highlight,borderless) but allows passing additional arguments through the...parameter for advanced use cases.Issue ticket number/s and link
Closes #73