https://github.com/ElianHugh/rsx

Encapsulated Shiny modules
https://github.com/ElianHugh/rsx

package r r-package rstats shiny shiny-r

Last synced: 22 days ago
JSON representation

Encapsulated Shiny modules

• Host: GitHub
• URL: https://github.com/ElianHugh/rsx
• Owner: ElianHugh
• License: gpl-3.0
• Created: 2022-11-14T11:42:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-02T05:11:37.000Z (over 1 year ago)
• Last Synced: 2024-11-16T22:42:10.549Z (25 days ago)
• Topics: package, r, r-package, rstats, shiny, shiny-r
• Language: R
• Homepage: https://elianhugh.github.io/rsx/
• Size: 5.09 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - ElianHugh/rsx - Encapsulated Shiny modules (R)

README

        
# rsx 

[![Lifecycle:

experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![R-CMD-check](https://github.com/ElianHugh/rsx/workflows/R-CMD-check/badge.svg)](https://github.com/ElianHugh/rsx/actions)

[![Codecov test coverage](https://codecov.io/gh/ElianHugh/rsx/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ElianHugh/rsx?branch=main)

rsx is an R package for creating complex yet manageable Shiny applications with nestable components that encapsulate both UI and state. It is heavily inspired by many JavaScript frameworks, particularly Vue.

Features:

* Nestable and modular templating system

* Scoped CSS to isolate styles between components

* Automatic namespacing (think shiny modules)

## Why rsx?

When writing Shiny apps, managing the relationship between module server and module UI can be challenging, leading to cognitive overhead and confusion. With rsx, module servers and UI are always coupled under one object, simplifying the process of creating and managing Shiny modules.

## Installation

### Release build

``` r

install.packages('rsx', repos = 'https://elianhugh.r-universe.dev')

```

### Development build

``` r

# install.packages("devtools")

devtools::install_github("ElianHugh/rsx")

```

## Usage

To use rsx, you define your components as functions with the component function. Components can be composed of data, a template, styles, and methods, making them fully encapsulated and reusable. Once defined, you can use these components in your Shiny app with the rsx_app function.

```r

library(rsx)

counter <- component(

    name = "counter",

    data = function() {

        list(

            label = "Counter #1",

            count = reactiveVal(0L)

        )

    },

    template = function(ns) {

        tagList(

            actionButton(ns("button"), label = self$label),

            verbatimTextOutput(ns("out"))

        )

    },

    methods = list(

        setup = function(input, output, session) {

            observeEvent(input$button, {

                self$count(

                    self$count() + 1L

                )

            })

            output$out <- renderText(

                self$count()

            )

        }

    )

)

rsx_app(counter)

```

For more information on how to define and use components with rsx, please see the package documentation or the pkgdown site.