{"id":21716494,"url":"https://github.com/cynkra/scoutbar","last_synced_at":"2025-04-12T20:12:36.817Z","repository":{"id":262460533,"uuid":"887307974","full_name":"cynkra/scoutbaR","owner":"cynkra","description":"scoutbar React widget for R and Shiny apps","archived":false,"fork":false,"pushed_at":"2025-03-24T08:47:41.000Z","size":2733,"stargazers_count":23,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T20:12:29.048Z","etag":null,"topics":["r","react","scoutbar","shiny"],"latest_commit_sha":null,"homepage":"https://cynkra.github.io/scoutbaR/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cynkra.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-12T14:19:05.000Z","updated_at":"2025-03-24T08:40:02.000Z","dependencies_parsed_at":"2025-03-06T09:34:07.158Z","dependency_job_id":"4a6757f1-6339-4a16-84e0-b28cd2b6d824","html_url":"https://github.com/cynkra/scoutbaR","commit_stats":null,"previous_names":["cynkra/scoutbar"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cynkra%2FscoutbaR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cynkra%2FscoutbaR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cynkra%2FscoutbaR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cynkra%2FscoutbaR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cynkra","download_url":"https://codeload.github.com/cynkra/scoutbaR/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625505,"owners_count":21135513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r","react","scoutbar","shiny"],"created_at":"2024-11-26T01:11:39.190Z","updated_at":"2025-04-12T20:12:36.788Z","avatar_url":"https://github.com/cynkra.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# {scoutbaR}\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![R-CMD-check](https://github.com/cynkra/scoutbaR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/cynkra/scoutbaR/actions/workflows/R-CMD-check.yaml)\n[![Codecov test coverage](https://codecov.io/gh/cynkra/scoutbaR/branch/main/graph/badge.svg)](https://app.codecov.io/gh/cynkra/scoutbaR?branch=main)\n[![CRAN status](https://www.r-pkg.org/badges/version/scoutbaR)](https://CRAN.R-project.org/package=scoutbaR)\n\u003c!-- badges: end --\u003e\n\nThe goal of `{scoutbaR}` is to provide an R API to the `scoutbar` React [widget](https://www.scoutbar.co/).\n\n![](./man/figures/scoutbar-dark.png)\n![](./man/figures/scoutbar-light.png)\n\n## Installation\n\nYou can install the development version of `{scoutbaR}` from [GitHub](https://github.com/) with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"cynkra/scoutbaR\")\n```\n\n## Example\n\n`{scoutbaR}` is easy to use. The app below shows how to leverage `scout_action()`, `scout_section()` and `scout_page()`:\n\n```r\nlibrary(scoutbaR)\nlibrary(shiny)\nlibrary(bslib)\n\nui \u003c- page_fillable(\n  title = \"Penguins dashboard\",\n  layout_sidebar(\n    sidebar = sidebar(\n      input_dark_mode(id = \"theme\"),\n      actionButton(\"update\", \"Update\", icon = icon(\"house\")),\n      scoutbar(\n        \"scoutbar\",\n        actions = list(\n          scout_section(\n            label = \"Section 1\",\n            scout_action(\n              id = 1,\n              icon = \"house\",\n              label = \"1\",\n              description = \"1\"\n            ),\n            scout_action(\n              id = 2,\n              icon = \"gear\",\n              label = \"2\",\n              description = \"2\"\n            )\n          ),\n          scout_section(\n            label = \"Section 2\",\n            scout_page(\n              label = \"Page 1\",\n              scout_action(\n                id = 3,\n                icon = \"house\",\n                label = \"3\",\n                description = \"3\"\n              ),\n              scout_action(\n                id = 4,\n                icon = \"gear\",\n                label = \"4\",\n                description = \"4\"\n              )\n            ),\n            scout_action(\n              id = 5,\n                icon = \"gear\",\n                label = \"5\",\n                description = \"5\"\n            )\n          )\n        )\n      ),\n      textOutput(\"textOutput\"),\n      textOutput(\"current_tab\")\n    ),\n    \"Body\"\n  )\n)\n\nserver \u003c- function(input, output, session) {\n\n  observeEvent(input$update, {\n    update_scoutbar(session, \"scoutbar\", revealScoutbar = TRUE)\n  })\n\n  observeEvent(input$theme, {\n    update_scoutbar(session, \"scoutbar\", theme = input$theme)\n  })\n  output$textOutput \u003c- renderText({\n    sprintf(\"You entered: %s\", input$scoutbar)\n  })\n}\n\nshinyApp(ui, server)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcynkra%2Fscoutbar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcynkra%2Fscoutbar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcynkra%2Fscoutbar/lists"}