-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
169 lines (129 loc) · 4.76 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
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
library(phosphoricons)
cat(as.character(ph("lightning", weight = "thin", height = "256px", width = "256px")), file = "man/figures/lightning-thin.svg")
cat(as.character(ph("lightning", weight = "light", height = "256px", width = "256px")), file = "man/figures/lightning-light.svg")
cat(as.character(ph("lightning", weight = "regular", height = "256px", width = "256px")), file = "man/figures/lightning-regular.svg")
cat(as.character(ph("lightning", weight = "bold", height = "256px", width = "256px")), file = "man/figures/lightning-bold.svg")
cat(as.character(ph("lightning", weight = "fill", height = "256px", width = "256px")), file = "man/figures/lightning-fill.svg")
cat(as.character(ph("lightning", weight = "bold", fill = "gold", height = "256px", width = "256px")), file = "man/figures/lightning-bold-gold.svg")
```
# phosphoricons
<!-- badges: start -->
[](https://CRAN.R-project.org/package=phosphoricons)
[](https://cran.r-project.org/package=phosphoricons)
[](https://app.codecov.io/gh/dreamRs/phosphoricons?branch=master)
[](https://github.com/dreamRs/phosphoricons/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
R wrapper for using [Phosphor Icons](https://github.com/phosphor-icons/web) in shiny applications or rmarkdown documents. Visit [phosphoricons.com](https://phosphoricons.com/) for a list of all available icons.
## Installation
Install from CRAN with:
```r
install.packages("phosphoricons")
```
You can install development version from GitHub with:
```r
remotes::install_github("dreamRs/phosphoricons")
```
## Icons usage
Create an icon with `ph()` function:
```{r basic, eval=FALSE}
library(phosphoricons)
ph("lightning")
```
{height=32}
There's 5 weights available:
```{r type-thin, eval=FALSE}
ph("lightning", weight = "thin")
```
{height=32}
```{r type-light, eval=FALSE}
ph("lightning", weight = "light")
```
{height=32}
```{r type-regular, eval=FALSE}
ph("lightning", weight = "regular")
```
{height=32}
```{r type-bold, eval=FALSE}
ph("lightning", weight = "bold")
```
{height=32}
```{r type-fill, eval=FALSE}
ph("lightning", weight = "fill")
```
{height=32}
Colorize icon using `fill` argument:
```{r color-icon, eval=FALSE}
ph("lightning", weight = "bold", fill = "gold")
```
{height=32}
There's two type of icons:
* SVG icons, created with `ph()`
* Font icons, created with `ph_i()`
There's a big debate between Web Fonts vs SVG for icons, but mainly:
* Web fonts require an `htmlDependency` that include all icons even if you use one, it will increase the size of your document in self contained mode.
* SVG icons won't currently work with some shiny functions with an `icon` argument.
## Bonus
Fill icon according to percentage:
```{r icon-fill-perc-1, eval=FALSE}
ph_fill(
ph("heart", weight = "fill", height = 128),
colors = c("#DF0101", "#F6CECE"),
breaks = 0.7
)
```
```{r icon-fill-perc-1b, echo=FALSE}
icon <- ph_fill(
ph("heart", weight = "fill", height = "256px", width = "256px"),
colors = c("#DF0101", "#F6CECE"),
breaks = 0.7
)
cat(as.character(icon), file = "man/figures/icon-fill-perc-1.svg")
```
{height=128}
```{r icon-fill-perc-2, eval=FALSE}
ph_fill(
ph("star", weight = "fill", height = 128, stroke = "gold", `stroke-width` = 10),
colors = c("gold", "#FFF"),
breaks = 0.5,
orientation = "h"
)
```
```{r icon-fill-perc-2b, echo=FALSE}
icon <- ph_fill(
ph("star", weight = "fill", height = "256px", width = "256px", stroke = "gold", `stroke-width` = 10),
colors = c("gold", "#FFF"),
breaks = 0.5,
orientation = "h"
)
cat(as.character(icon), file = "man/figures/icon-fill-perc-2.svg")
```
{height=128}
Icon waffle:
```{r waffle, eval=FALSE}
waffle_icon(
values = sample(c("Cats", "Dogs"), 200, TRUE),
colors = list(
Cats = "#456990",
Dogs = "#F45B69"
),
icons = list(
Cats = ph("cat", height = NULL),
Dogs = ph("dog", height = NULL)
),
ncol = 15,
nrow = 8,
width = "500px"
)
```
