README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# shinytangle

<!-- badges: start -->
[![R-CMD-check](https://github.com/coatless-rpkg/shinytangle/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/shinytangle/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

shinytangle provides inline interactive widgets for Shiny applications, allowing
you to embed interactive numeric inputs and outputs directly within text. This 
makes it easy to create dynamic, interactive narratives and explanations where 
users can adjust values and see results update in real-time.

## Installation

You can install the development version of shinytangle from GitHub:

```r
# install.packages("remotes")
remotes::install_github("coatless-rpkg/shinytangle")
```

## Usage

Here's an example of how to use shinytangle:

```{r}
#| eval: false
library(shiny)
library(shinytangle)

ui <- fluidPage(
  titlePanel("shinytangle: Demo Inline"),
  p(
    "When you have", 
    inlineNumericInput("amount", 5, min = 0, max = 10), 
    "items, the total cost is",
    inlineOutput("cost")
  )
)

server <- function(input, output) {
  output$cost <- renderInline({
    input$amount * 9.99
  })
}

shinyApp(ui, server)
```

![](https://github.com/user-attachments/assets/c96aa063-e38c-4f80-ab88-c0a1fe090525)

After installing the package, you can explore more examples of `shinytangle` by running:

```r
# Display a triangle and adjust its size with a,b,c sliders
shiny::runExample("triangle-demo", package = "shinytangle")

# Multi-text statement example
shiny::runExample("text-statement-demo", package = "shinytangle")

# Try out the README example
shiny::runExample("readme-inline-demo", package = "shinytangle")

# See a list of all examples:
system.file("examples-shiny", package="shinytangle")
```