-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
97 lines (68 loc) · 2.86 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
eval = TRUE,
echo = TRUE, # echo code?
message = TRUE, # Show messages
warning = TRUE, # Show warnings
fig.width = 8, # Default plot width
fig.height = 6, # .... height
dpi = 200, # Plot resolution
fig.align = "center"
)
knitr::opts_chunk$set() # Figure alignment
library(shinyGizmo)
set.seed(123)
options(tibble.width = Inf)
pkg_version <- read.dcf("DESCRIPTION", fields = "Version")[1, 1]
```
# shinyGizmo
[![version](https://img.shields.io/static/v1.svg?label=github.com&message=v.`r I(pkg_version)`&color=ff69b4)](https://img.shields.io/static/v1.svg?label=github.com&message=v.0.1&color=ff69b4)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-success.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
## Overview
shinyGizmo is an R package providing useful components for Shiny applications.
<center>
## <span style="color:blue"> shinyGizmo `r I(pkg_version)` is now available!</span>
</center>
## Installation
From CRAN:
```
install.packages("shinyGizmo")
```
Latest development version from Github:
```
remotes::install_github(
"r-world-devs/shinyGizmo"
)
```
## Available components
### `conditionalJS` - extended version of `shiny::conditionalPanel`.
Allows to attach conditional JavaScript action to be run on UI element.
Use predefined actions such as `disable`, `attachClass`, `css`, `show`, `runAnimation` or define a custom one.
![](./man/figures/condjs.gif) ![](./man/figures/condjsanim.gif)
### `commonInput(s)` - merge multiple input controllers into one
![](./man/figures/commoninputs.gif)
### `accordion` - light and simple version of accordion
![](./man/figures/accordion.gif) ![](./man/figures/accordion_enroll.gif)
### `modalDialogUI` - create modals directly in UI
![](./man/figures/modalui.gif)
### `valueButton` - get any attribute from Shiny application DOM objects
![](./man/figures/valuebutton.gif)
### `textArea` - non-binding version of `shiny::textAreaInput`.
![](./man/figures/textarea.gif)
Improves application performance when large amount text is passed to text area.
Works great with `valueButton`.
### `pickCheckboxInput` and `vsCheckboxInput` - make selection in many groups at once
![](./man/figures/pickcheckbox.gif)
![](./man/figures/vscheckboxinput.gif)
## Lifecycle
shinyGizmo is stable but we're still developing the package.
If you find bugs or have any suggestions for future releases post an issue on GitHub page at <https://github.com/r-world-devs/shinyGizmo/issues>.
## Getting help
There are two main ways to get help with `shinyGizmo`
1. Reach the package author via email: [email protected].
2. Post an issue on our GitHub page at [https://github.com/r-world-devs/shinyGizmo](https://github.com/r-world-devs/shinyGizmo/issues).