-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
1271 lines (1000 loc) · 33 KB
/
index.html
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>{shinyMobile} Hands-on</title>
<meta charset="utf-8" />
<meta name="author" content="SCC" />
<meta name="date" content="2021-07-09" />
<link href="assets/libs/tile-view/tile-view.css" rel="stylesheet" />
<script src="assets/libs/tile-view/tile-view.js"></script>
<script src="assets/libs/clipboard/clipboard.min.js"></script>
<link href="assets/libs/shareon/shareon.min.css" rel="stylesheet" />
<script src="assets/libs/shareon/shareon.min.js"></script>
<link href="assets/libs/xaringanExtra-shareagain/shareagain.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra-shareagain/shareagain.js"></script>
<link href="assets/libs/xaringanExtra-clipboard/xaringanExtra-clipboard.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra-clipboard/xaringanExtra-clipboard.js"></script>
<script>window.xaringanExtraClipboard(null, {"button":"Copy Code","success":"Copied!","error":"Press Ctrl+C to Copy"})</script>
<link href="assets/libs/tachyons/tachyons.min.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra_fit-screen/fit-screen.js"></script>
<link href="assets/libs/panelset/panelset.css" rel="stylesheet" />
<script src="assets/libs/panelset/panelset.js"></script>
<link href="assets/libs/xaringanExtra-extra-styles/xaringanExtra-extra-styles.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/_variables-fonts.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/_variables.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/code.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/jsonview/jsonview.css" rel="stylesheet" />
<script src="assets/libs/js4shiny/jsonview/jsonview.min.js"></script>
<link href="assets/libs/js4shiny-redirectConsoleLog/jslog.css" rel="stylesheet" />
<script src="assets/libs/js4shiny-redirectConsoleLog/redirectConsoleLog.js"></script>
<link rel="stylesheet" href="assets/css/js4shiny-xaringan-base.css" type="text/css" />
<link rel="stylesheet" href="assets/css/tachyons.min.css" type="text/css" />
<link rel="stylesheet" href="assets/css/js4shiny-xaringan-extra.css" type="text/css" />
<link rel="stylesheet" href="assets/css/custom.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: inverse, center, title-slide, middle
# {shinyMobile} Hands-on
## David Granjon
### 2021-07-09
### Hosted by <img class="svg-img" src="./assets/images/THINKR.png">
---
# Hi there 🍕
We're in for 2 hours of **fun**!
- Grab a ☕
- Make yourself comfortable 🛋 or 🧘
- Ask questions ❓
.flex.tc[
.w-30.mr3.center[
<img class="br-100" width="100px" height="100px" src="assets/images/granjda1.jpg" class="svg-img"/>
<br>
.f5[David]
.small[Senior Expert Data Scientist, Novartis]
]
]
---
# Program
.panelset[
.panel[.panel-name[Partie 1]
Mobile app development with `{shiny}`, `{golem}` et `{shinyMobile}`
Learning objectives:
- 👩🏫 State of the art.
- 👨🏫 `{shinyMobile}` introduction: components, templates, themes ...
- Setup a production app.
]
.panel[.panel-name[Partie 2]
Discover progressive web apps (PWA) and create a simple example, built on top the previous part.
Learning objectives:
- Discover what is a progressive web app.
- Step by step development.
- Overview of what are the next steps and limitations.
]
]
---
# Workshop Material
- [Slides](https://github.com/RinteRface/rencontresR2021).
- Sandbox [app](https://dgranjon.shinyapps.io/shinyMobileGolemTest/).
- Book "Outstanding user Interfaces with Shiny": [intro](https://unleash-shiny.rinterface.com/mobile-shiny-intro.html) and [pwa](https://unleash-shiny.rinterface.com/mobile-pwa.html).
## Prerequisites
- Preliminary experience with `{shiny}`.
- Basic knowledge about R packages may help.
- Be curious.
---
class: inverse center title-slide middle
# Part 1.1 Introduction to {shinyMobile}
---
class: header_background
# Mobile development
<br/>
## Classic web apps are not optimized for mobile platforms.
- Rarely consider the __small display__.
- Harder to access (no launch icon).
- Harder to focus if __not fullscreen__.
- Don't work __offline__.
<br/>
--
.center[
Appearance is critical for end user. 💇
]
---
class: header_background
# Mobile development
<br/>
##😈 Let's go __native__!
Well ... it's quite complex:
- Know multiple languages: Java, Swift, ...
- Maintain multiple code bases.
<br/>
--
.center[
❓ Isn't there something simpler?
]
---
class: header_background
# Progressive web apps (PWA)
<br/>
## Take some advantages of both worlds:
- Can be __installed__ on the device ...
- ... But run via a web browser.
- Provide __offline__ features (don't expect too much).
- One code base (web languages).
<br/>
--
.center[
😭 Less performance than native.
]
---
class: header_background
# Mobile app development and {shiny}?
<br/>
Let's be honest, there is __almost nothing__ 😭.
.pull-left[
- Many shiny apps are not optimized for mobile.
- Vertical design.
- Overflow.
- Poor user experience.
]
.pull-right[
<iframe src="https://thiago-valentim.shinyapps.io/project/?_ga=2.187989743.677910734.1623617328-748932920.1610966288" width="50%" height="300px"></iframe>
]
---
class: header_background
# Mobile app development and {shiny}?
<br/>
`{miniUI}` exists but not really for mobile development.
<img src="assets/images/gadgets-tabstrip.png" width="40%" style="display: block; margin: auto;" />
---
class: header_background
# Welcome {shinyMobile}?
<br/>
Built on top of the [Framework7](https://framework7.io/) web framework.
.pull-left[
- Native look and feel for iOS and Android
- PWA support.
- ... also works for desktop apps 😏
]
.pull-right[
<img src="assets/images/shinyMobile.svg" width="20%" style="display: block; margin: auto;" class="svg-img"/>
]
---
# Key features: Layout
<script>
$('#singleLayout').prop('checked', true);
$('#singleLayout, #tabsLayout').on('click', function() {
$('#singleLayoutDemo').toggle();
$('#tabLayoutDemo').toggle();
});
</script>
.pull-left[
- `f7SingleLayout()`: one page app.
- `f7TabLayout()`: multi-tabs app.
<br/>
<br/>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="layoutRadio" id="singleLayout">
<label class="form-check-label" for="singleLayout">single</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="layoutRadio" id="tabsLayout">
<label class="form-check-label" for="tabsLayout">Tabs</label>
</div>
]
.pull-right[
<div class="md-iphone-5 md-black-device" id="singleLayoutDemo" style="font-size: 0.5em; margin-top: -50px !important;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile1/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
<div class="md-iphone-5 md-white-device" id="tabLayoutDemo" style="font-size: 0.5em; margin-top: -50px !important; display: none;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile2/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
]
---
# Key features: Skins
<script>
$('#skiniOS').prop('checked', true);
$('#skiniOS, #skinMd').on('click', function() {
$('#skiniOSDemo').toggle();
$('#skinMdDemo').toggle();
});
</script>
.pull-left[
- iOS.
- Android.
<br/>
<br/>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="skinRadio" id="skiniOS">
<label class="form-check-label" for="skiniOS">iOS</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="skinRadio" id="skinMd">
<label class="form-check-label" for="skinMd">md</label>
</div>
]
.pull-right[
<div class="md-iphone-5 md-white-device" id="skiniOSDemo" style="font-size: 0.5em; margin-top: -50px !important;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile3/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
<div class="md-iphone-5 md-white-device" id="skinMdDemo" style="font-size: 0.5em; margin-top: -50px !important; display: none;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile4/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
]
---
# Key features: Themes
<script>
$('#skiniOS').prop('checked', true);
$('#themeSwitcher').on('click', function() {
$('#darkThemeDemo').toggle();
$('#whiteThemeDemo').toggle();
});
</script>
.pull-left[
2 themes:
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" id="themeSwitcher">
<label class="form-check-label" for="themeSwitcher">Default switch checkbox input</label>
</div>
]
.pull-right[
<div class="md-iphone-5 md-white-device" id="darkThemeDemo" style="font-size: 0.5em; margin-top: -50px !important;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile5/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
<div class="md-iphone-5 md-black-device" id="whiteThemeDemo" style="font-size: 0.5em; margin-top: -50px !important; display: none;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://connect.thinkr.fr/shinyMobile6/" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
]
---
# Demo app: {deminR}
.pull-left[
- {deminR}, 2020 Shiny Contest.
- https://dgranjon.shinyapps.io/deminR
- https://github.com/DivadNojnarg/deminR
<div class="row">
<div class="col">
<img src="assets/images/deminR.png" width="50%" style="display: block; margin: auto;" class="svg-img"/>
</div>
<div class="col">
<img src="assets/images/golem.svg" width="50%" style="display: block; margin: auto;" class="svg-img"/>
</div>
</div>
]
.pull-right[
<div class="md-iphone-5 md-black-device" id="deminR" style="font-size: 0.5em; margin-top: -50px !important;">
<div class="md-body">
<div class="md-buttons"></div>
<div class="md-front-camera"></div>
<div class="md-top-speaker"></div>
<div class="md-screen">
<iframe width="100%" src="https://dgranjon.shinyapps.io/deminR" allowfullscreen="" frameborder="0" scrolling="no" height="470px"></iframe>
</div>
<button class="md-home-button"></button>
</div>
</div>
]
---
class: center middle
# Your turn 🧪!
<img src="assets/images/excited-minions.gif" width="40%" style="display: block; margin: auto;" />
---
class: inverse center title-slide middle
# Part 1.2 Project setup
---
class: header_background
# Initialize the project: {truelle}
<br/>
## We'll be using {golem} ...
.pull-left[
<img src="assets/images/golem.svg" width="20%" style="display: block; margin: auto;" class="svg-img"/>
]
.pull-right[
<img src="assets/images/truelle.png" width="20%" style="display: block; margin: auto;" class="svg-img"/>
]
--
## ... {truelle} is a {golem} GUI generator 🧙♂️!
1. Open the RStudio Server.
2. Run `truelle::run_app()`.
3. Follow the steps.
---
class: header_background
# {truelle}: project type
<br/>
Select __Package__ and choose the `{golem}` engine.
<img src="assets/images/truelle-project-type.png" width="50%" /><img src="assets/images/truelle-project-engine.png" width="50%" />
---
class: header_background
# {truelle}: Package options
<br/>
Provide a valid package path and review project options.
<img src="assets/images/truelle-package-options.png" width="50%" style="display: block; margin: auto;" />
---
class: header_background
# {truelle}: UI template
<br/>
Select `{shinyMobile}` tabs layout.
<img src="assets/images/truelle-ui-template.png" width="50%" style="display: block; margin: auto;" />
---
class: header_background
# {truelle}: Run the output and enjoy 😎!
<br/>
Click on the ⏯ button or copy/paste 📸 the code to your terminal...
<img src="assets/images/truelle-output.png" width="50%" /><img src="assets/images/golem-package-structure.png" width="50%" />
Congrats 🎈! We now have a production ready `{shinyMobile}` project.
---
class: inverse center title-slide middle
# Part 1.3 {shinyMobile}'s main features
---
class: header_background
# {shinyMobile}: App preview
<br/>
## Your turn 🧪
.pull-left[
- `{shinyMobile}` allows app preview (local or remote).
- __Remote__ preview:
```r
shinyMobile::preview_mobile(
url = "https://connect.thinkr.fr/shinyMobile1/",
device = "iphone8"
)
```
]
--
.xsmall.pull-right[
- Open the new project.
- Run `devtools::load_all()`.
- Run the app in a separate R process (only works with __local__ RStudio):
```r
processx::process$new(
"Rscript",
c("-e",
sprintf(
"thematic::thematic_shiny();
shiny::runApp('%s', port = %s)",
"./inst/app", 3434
)
)
)
shinyMobile::preview_mobile(
url = "http://localhost:3434",
device = "iphone8"
)
```
.center[
<img src="assets/images/shinyMobile-basic-app.png" width="30%" style="display: block; margin: auto;" class="svg-img"/>
]
]
---
class: header_background
# {shiny} VS {shinyMobile}: Main UI wrapper
<br>
.pull-left[
<img src="assets/images/shiny.svg" width="20%" style="display: block; margin: auto;" class="svg-img"/>
.small[
```r
library(shiny)
ui <- fluidPage(
# ui logic
)
server <- function(input, output, session) {
# server logic
}
shinyApp(ui, server)
```
]
]
--
.pull-right[
<img src="assets/images/shinyMobile.svg" width="20%" style="display: block; margin: auto;" class="svg-img"/>
.small[
```r
library(shiny)
*library(shinyMobile)
*ui <- f7Page(
# shinyMobile layout functions
)
server <- function(input, output, session) {
# server logic
}
shinyApp(ui, server)
```
]
]
---
class: header_background
# {shinyMobile}: app options
<br/>
.small.pull-left[
- `f7Page()` exposes an __options__ parameter.
- Fine tune the app __appearance__ and __behavior__:
- Theme, colors, ...
- Dark mode (default to TRUE).
- __tapHold__ (WHAAAAT???).
- navbar and toolbar options.
- ...
- Options inherited from [Framework7](https://v5.framework7.io/docs/app.html).
]
--
.small.pull-right[
## Your turn 🥼
- Inspect the __./R/app_ui.R__ code and experiment with some of the options.
- Run `devtools::load_all()` and `run_app()`.
]
---
class: header_background
# {shinyMobile}: the tab layout
<br/>
.small.pull-left[
We leverage the `f7TabLayout()` function:
```r
f7TabLayout(..., navbar, messagebar = NULL, panels = NULL, appbar = NULL)
```
- __...__ are the tabs contained in `f7Tabs()`.
- `f7Tabs()` may host multiple `f7Tab()`.
- __navbar__ expects an `f7Navbar()`.
- We don't care about other parameters for now.
]
--
.small.pull-right[
## Your turn 🧪
- Inspect the __./R/app_ui.R__ code and find the corresponding pieces.
- Add a new `f7Tab()` element. Hint: `f7Tab(..., tabName, icon = NULL, active = FALSE, hidden = FALSE)`.
- Run `devtools::load_all()` and `run_app()`.
]
---
class: header_background
# {shinyMobile}: the navbar
<br/>
.small.pull-left[
`f7Navbar()`:
- Contains __title__, __subtitle__.
- Optional __subNavbar__ with `f7SubNavbar()`.
- Other parameters offer cosmetic options:
- shadow.
- horizontal line.
- transparent.
- ...
]
--
.xsmall.pull-right[
## Your turn 🥼
- In __./R/app_ui.R__, modify the navbar title.
- Add a subtitle.
- Add a `f7SubNavbar()` such as:
```r
f7SubNavbar(
f7Button(label = "My button"),
f7Button(label = "My button"),
f7Button(label = "My button")
)
```
- Turn the __leftPanel__ and __rightPanel__ to `FALSE`.
- Set __hairline__ to `FALSE`.
- Run `devtools::load_all()` and `run_app()`.
]
---
class: header_background
# {shinyMobile}: components
<br/>
.small.pull-left[
`{shinyMobile}` exposes many components:
- Containers: `f7Card()`, `f7List()`, `f7Block()`, ...
- Inputs: `f7Text()`, `f7Checkbox()`, `f7Toggle()`, ...
- Notifications: `f7Notif()`, `f7Dialog()`, `f7ActionSheet()`, ...
- Buttons: `f7Button()`, `f7TabLink()`, ...
- Metric: `f7Gauge()`, `f7Progress()`, ...
Most of them can be updated server side!
]
--
.xsmall.pull-right[
## Your turn 🧪
- In __./R/app_ui.R__, add a new `f7ExpandableCard()` in the previously added `f7Tab()`.
- Give it an __id__.
- Below the card add a `f7Button("openCard", "Click me!")`.
- In __./R/app_server.R__ add this code, replacing `<CARD_ID>`:
```r
observeEvent(input$openCard, {
updateF7Card(id = <CARD_ID>)
})
```
- Run `devtools::load_all()` and `run_app()`.
]
---
class: end_part_1
---
class: inverse center title-slide middle
# Part 2.1 Introduction to PWA
---
class: header_background
# Progressive web apps
<br/>
Progressive web apps or (PWA) improve classic web apps capabilities by obeying these three rules:
1. Being __capable__: media control, file system access, …
2. Being __reliable__: fast and usable __offline__. Transparent failures.
3. Being __installable__: Standalone use, launch from user’s home screen.
In the following we'll treat 2 and 3.
---
class: header_background
# How can my app be installable?
<br/>
- The app must be served over __HTTPS__ (shinyapp.io, ...).
- Include a __manifest__, that is a JSON file specifying app metadata (name, icons, ...).
- Have a registered __service worker__, which can cache the app content and provide __offline__ support.
<img src="assets/images/alors_heureux.gif" width="40%" style="display: block; margin: auto;" />
---
class: header_background
# What is a web manifest?
<br/>
A [JSON](https://web.dev/add-manifest/) file which can be interpreted by the web browser (Chrome, Safari, Firefox, Brave, ...).
.pull-left[
.xsmall[
```js
{
"name": "My Progressive Web App",
"short_name": "My App",
"description": "What it does!",
"lang": "en-US",
"start_url": "https://dgranjon.shinyapps.io/shinyMobileGolemTest/",
"display": "standalone",
"background_color": "#ffffff",
"theme_color": "#ffffff",
"icons": [
{
"src": "icons/icon-144.png",
"sizes": "144x144"
}
],
...
}
```
]
]
.pull-right[
.small[
Most important fields:
- __start_url__: where your app is hosted.
- __display__: use __standalone__ for native look and feel.
- __icon__: an array pointing to icons (useful for favicon, launch screen ...) in the `www` folder.
Check compatibility support [here](https://developer.mozilla.org/en-US/docs/Web/Manifest).
]
]
In a Shiny app context, the manifest goes in `www`.
---
class: header_background
# The service worker
<br/>
Script run in the background by the web browser.
.pull-left[
.xsmall[
```js
self.addEventListener("install", (event) => {
event.waitUntil(
(async () => {
const cache = await caches.open(CACHE_NAME);
// Setting {cache: 'reload'} in the new request will ensure that the
// response isn't fulfilled from the HTTP cache; i.e., it will be from
// the network.
await cache.add( new Request(OFFLINE_URL, { cache: "reload" }) );
await cache.add( new Request("framework7-5.7.14/css/framework7.bundle.min.css", { cache: "reload" }) );
// add other resources to cache below
})()
);
// Force the waiting service worker to become the active service worker.
self.skipWaiting();
});
```
]
]
.pull-right[
.xsmall[
Features:
- Requires __HTTPS__.
- Able to store app resources (CSS, JS, images, HTML, ...) in the application cache ...
- ... Thereby making them available offline.
- Many plug and play template here and there.
Script composed of 3 steps:
- Installation + cache configuration (see left code).
- Activation.
- Fetch requests (fill the cache, ...)
]
]
---
class: inverse center title-slide middle
# Part 2.2 Develop a PWA with {shinyMobile}
---
class: header_background
# Road to PWA : enable PWA
<br/>
Good new 😃!
--
`{shinyMobile}` is PWA ready 😎.
--
Just turn on the `allowPWA` to `TRUE` in `f7Page()`. Under the hood, it adds all the required machinery 🧙.
---
class: header_background
# Road to PWA : Modify {golem} package
<br/>
.small.pull-left[
## Your turn 🥼
- Open `./R/app_ui.R`.
- Scroll down to the `golem_add_external_resources` function.
- Comment out the code as shown on the left (to avoid conflicts with `{shinyMobile}` PWA assets).
- Call `golem::add_ui_server_files()`.
]
.small.pull-right[
```r
golem_add_external_resources <- function(){
#add_resource_path(
# 'www', app_sys('app/www')
#)
tags$head(
#favicon(),
#bundle_resources(
# path = app_sys('app/www'),
# app_title = 'shinyexample'
#)
# Add here other external resources
# for example, you can add shinyalert::useShinyalert()
)
}
```
]
---
class: header_background
# Road to PWA : add PWA files (1/2)
<br/>
Time consuming, need __automated__ approach... The below script:
--
.small[
.pull-left[
```r
# Important to target the app folder.
# Only work if app is in a package.
# register_service_worker is FALSE, shinyMobile already does it.
# We also don't need to create web dependencies.
charpente::set_pwa(
"inst/app",
register_service_worker = FALSE,
create_dependencies = FALSE
)
```
]
]
--
.pull-right[
- Creates a __web manifest__.
- Adds a __service worker__.
- Adds placeholder icons (you may need to create your own later).
- Adds an __offline__ HTML template page.
]
---
class: header_background
# Road to PWA: add PWA files (2/2)
<br/>
.xsmall.pull-left[
## Your turn 🧪
- Run `charpente::set_pwa("inst/app", register_service_worker = FALSE, create_dependencies = FALSE)` inside your project.
- Run `devtools::load_all()` and `run_app()`.
- Once the RStudio viewer opens, click on `Open in Browser`.
- Note the app <sup>URL</sup>: `https://baka.thinkr.fr/<CONTAINER_ID>/rstudio/p/<RSTUDIO_TOKEN>/`.
- Copy it in the `./inst/app/www/manifest.webmanifest` __start_url__ field.
]
.pull-right[
<br/>
<img src="assets/images/bakACode.png" width="100%" style="display: block; margin: auto;" />
]
.xsmall.footnote[
This workshop is hosted by [ThinkR](https://thinkr.fr/) on a dedicated server. If you are working locally, first deploy your app to a secure server (with __HTTPS__ like [shinyapps.io](https://www.shinyapps.io/)). PWA features __don't work__ locally!!!
]
---
class: header_background
# Road to PWA: Check your app (1/3)
<br/>
.pull-left[
.small[
## Your turn 🧪
- App is already running in Chrome.
- If __App does not work__: use `https://dgranjon.shinyapps.io/shinyMobileGolemTest`.
- Open the Chrome developer tools: ⌥ + ⌘ + I (Mac), ctrl + shift + I (windows).
- Follow the steps showed in the figure (in red).
- Click on `Generate report` and wait.
]
]
.pull-right[
<br/>
<img src="assets/images/html_inspector_audit.png" width="100%" style="display: block; margin: auto;" />
]
---
class: header_background
# Road to PWA: Check your app (2/3)
<br/>
We aim to see the __installable__ property in green.
<img src="assets/images/lighthouse_audit_result.png" width="50%" style="display: block; margin: auto;" />
---