{"Package":"keys","Title":"Keyboard Shortcuts for 'shiny'","Version":"0.1.1","Authors@R":"c(\nperson(given = \"Tyler\", family = \"Littlefield\", role = c(\"aut\", \"cre\"), email = \"tylerlittlefield@hey.com\", comment = \"Author of Javascript wrapper\"),\nperson(given = \"Colin\", family = \"Fay\", role = \"aut\", email = \"contact@colinfay.me\", comment = c(ORCID = \"0000-0001-7343-1846\")),\nperson(given = \"Craig\", family = \"Campbell\", role = c(\"cph\"), comment = \"Author of JavaScript code\"))","Description":"Assign and listen to keyboard shortcuts in 'shiny' using the\n'Mousetrap' Javascript library.","License":"Apache License (>= 2)","Encoding":"UTF-8","RoxygenNote":"7.1.1","Imports":"htmltools, shiny, jsonlite","URL":"https://github.com/r4fun/keys","BugReports":"https://github.com/r4fun/keys/issues","Suggests":"knitr, rmarkdown","VignetteBuilder":"knitr","NeedsCompilation":"no","Packaged":"2021-07-11 17:49:30 UTC; tlittlef","Author":"Tyler Littlefield [aut, cre] (Author of Javascript wrapper),\nColin Fay [aut] (),\nCraig Campbell [cph] (Author of JavaScript code)","Maintainer":"Tyler Littlefield ","Repository":"CRAN","Date/Publication":"2021-07-11 18:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/keys_0.1.1.tar.gz","jsonAuthors":[{"name":"Tyler Littlefield","email":"tylerlittlefield@hey.com","maintainer":true},{"name":"Colin Fay","email":"contact@colinfay.me","maintainer":false},{"name":"Craig Campbell","email":null,"maintainer":false}],"readme":"\n\n\n# keys

\n\n\n\n[![R build\nstatus](https://github.com/r4fun/keys/workflows/R-CMD-check/badge.svg)](https://github.com/r4fun/keys/actions)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/keys)](https://CRAN.R-project.org/package=keys)\n[![CRAN\\_Download\\_Badge](https://cranlogs.r-pkg.org/badges/keys)](https://cran.r-project.org/package=keys)\n\n\nThe goal of `{keys}` is to add hotkeys to shiny applications using\n[`Mousetrap`](https://github.com/ccampbell/mousetrap). With `{keys}`,\nyou can:\n\n- Assign hotkeys on app load\n- Add and remove hotkeys from server\n- Pause and unpause hotkeys from server\n- Record keys from server\n\n## Installation\n\nInstall the released version of `{keys}` from CRAN:\n\n``` r\ninstall.packages(\"keys\")\n```\n\nOr install the development version from GitHub with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"r4fun/keys\")\n```\n\n## Usage\n\nTo use `{keys}`, start by adding a dependency to it using `useKeys()`.\n\nThen, you can add a `keysInput` to the UI:\n\n``` r\nlibrary(shiny)\nlibrary(keys)\n\nhotkeys <- c(\n \"1\", \n \"command+shift+k\", \n \"up up down down left right left right b a enter\"\n)\n\nui <- fluidPage(\n useKeys(),\n keysInput(\"keys\", hotkeys)\n)\n\nserver <- function(input, output, session) {\n observeEvent(input$keys, {\n print(input$keys)\n })\n}\n\nshinyApp(ui, server)\n```\n\nYou can add binding after application launch using `addKeys`.\n\n``` r\nlibrary(shiny)\nlibrary(keys)\n\nui <- fluidPage(\n useKeys(),\n actionButton(\"add\", \"Add keybinding\")\n)\n\nserver <- function(input, output, session) {\n observeEvent(input$add, {\n addKeys(\"keys\", c(\"a\", \"b\", \"c\"))\n })\n observeEvent(input$keys, {\n print(input$keys)\n })\n}\n\nshinyApp(ui, server)\n```\n\nBindings can be removed after application launch using `removeKey`.\n\n``` r\nlibrary(shiny)\nlibrary(keys)\n\nui <- fluidPage(\n useKeys(),\n keysInput(\"keys\", c(\"a\", \"b\", \"c\")),\n actionButton(\"rm\", \"Remove `a` keybinding\")\n)\n\nserver <- function(input, output, session) {\n observeEvent(input$rm, {\n removeKeys(\"a\")\n })\n observeEvent(input$keys, {\n print(input$keys)\n })\n}\n\nshinyApp(ui, server)\n```\n\nFor more information about what types of hotkeys you can use, please\ntake a look at the mousetrap github\n[repository](https://github.com/ccampbell/mousetrap).\n\n## Acknowledgements\n\nAll credit goes to [Craig Campbell](https://github.com/ccampbell) who is\nthe author of [`Mousetrap`](https://github.com/ccampbell/mousetrap).","jobInfo":{"package":"keys","version":"0.1.1","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-07-11T20:29:52+0000"}}

Description

Usage

Arguments

Value