Skip to content

Commit 0ffdef1

Browse files
committed
Fix spelling issues and update wordlist
1 parent 76afabe commit 0ffdef1

3 files changed

Lines changed: 23 additions & 18 deletions

File tree

inst/WORDLIST

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
behaviour
21
Codecov
2+
Gans
3+
JS
4+
Lifecycle
5+
RStudio
6+
SortableJS
7+
Tabset
8+
UI
9+
Vries
10+
behaviour
311
colours
412
conceptor
513
css
614
de
715
draggable
816
funder
9-
Gans
1017
ggplot
1118
github
1219
htmlwidget
1320
https
1421
io
15-
javascript
1622
jQuery
23+
javascript
1724
js
18-
JS
1925
learnr
2026
learnt
21-
Lifecycle
2227
multiDrag
28+
namespaced
2329
png
2430
sortablejs
25-
SortableJS
26-
Tabset
27-
UI
28-
Vries
2931
widget's

vignettes/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
*.html
22
*.R
3+
4+
/.quarto/
5+
**/*.quarto_ipynb

vignettes/shiny_modules.Rmd

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ pre[class] {
2828
```
2929

3030

31-
## tl;dr
31+
## Summary
3232

3333
If you use `sortable` with `shiny` modules, opt into a fix by adding this line of code to your app:
3434

@@ -39,18 +39,18 @@ enable_modules(TRUE) # or simply enable_modules()
3939

4040
## Introduction
4141

42-
Shiny modules provide a way to create reusable components in Shiny applications. When working with modules, namespacing of input and output IDs is crucial.
42+
Modules provide a way to create reusable components `shiny` applications. When working with modules, using the correct namespace of input and output IDs is crucial.
4343

44-
Due to an early design decision, the `sortable` package (`versions <= 0.5.0`) did not fully support Shiny modules.
44+
Due to an early design decision, the `sortable` package (`versions <= 0.5.0`) did not fully support `shiny` modules.
4545

46-
This vignette explains how to use sortable with Shiny modules and the changes that were made to support this functionality.
46+
This vignette explains how to use sortable with `shiny` modules and the changes that were made to support this functionality.
4747

4848

49-
## Understanding the Module Namespacing Issue
49+
## Understanding the module namespace issue
5050

51-
In Shiny modules, element IDs are automatically namespaced using a prefix followed by a dash. For example, if you create a module with ID "mymodule" and an input with ID "myinput", Shiny will create an ID like "mymodule-myinput".
51+
In `shiny` modules, element IDs are automatically namespaced using a prefix followed by a dash. For example, if you create a module with ID `mymodule` and an input with ID `myinput`, `shiny` will create an ID like `mymodule-myinput`.
5252

53-
Initially, the `sortable` package used ID formats that were incompatible with this namespacing approach. The IDs were created as `rank-list-{id}` or `bucket-list-{id}`, which placed the key part at the beginning of the ID.
53+
Initially, the `sortable` package used ID formats that were incompatible with this namespace approach. The IDs were created as `rank-list-{id}` or `bucket-list-{id}`, which placed the key part at the beginning of the ID.
5454

5555

5656

@@ -76,10 +76,10 @@ When module support is enabled, the ID format changes:
7676
- `as_rank_list_id("myid")` will return `"myid-rank-list"` (instead of `"rank-list-myid"`)
7777
- `as_bucket_list_id("myid")` will return `"myid-bucket-list"` (instead of `"bucket-list-myid"`)
7878

79-
This change puts the key part at the end, making it compatible with Shiny's module namespacing system.
79+
This change puts the key part at the end, making it compatible with the `shiny` module namespace system.
8080

8181

82-
To disable module support (reverting to pre-0.5.0 behavior):
82+
To disable module support (reverting to `<= 0.5.0` behavior):
8383

8484
```r
8585
enable_modules(FALSE)

0 commit comments

Comments
 (0)