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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/box-styles.R, R/boxes.R
\name{list_border_styles}
\alias{list_border_styles}
\alias{boxx}
\title{Draw a banner-like box in the console}
\usage{
list_border_styles()
boxx(
label,
header = "",
footer = "",
border_style = "single",
padding = 1,
margin = 0,
float = c("left", "center", "right"),
col = NULL,
background_col = NULL,
border_col = col,
align = c("left", "center", "right"),
width = console_width()
)
}
\arguments{
\item{label}{Label to show, a character vector. Each element will be
in a new line. You can color it using the \verb{col_*}, \verb{bg_*} and
\verb{style_*} functions, see \link[=ansi-styles]{ANSI styles} and the examples
below.}
\item{header}{Text to show on top border of the box. If too long,
it will be cut.}
\item{footer}{Text to show on the bottom border of the box. If too long,
it will be cut.}
\item{border_style}{String that specifies the border style.
\code{list_border_styles} lists all current styles.}
\item{padding}{Padding within the box. Either an integer vector of
four numbers (bottom, left, top, right), or a single number \code{x}, which
is interpreted as \code{c(x, 3*x, x, 3*x)}.}
\item{margin}{Margin around the box. Either an integer vector of four
numbers (bottom, left, top, right), or a single number \code{x}, which is
interpreted as \code{c(x, 3*x, x, 3*x)}.}
\item{float}{Whether to display the box on the \code{"left"}, \code{"center"}, or
the \code{"right"} of the screen.}
\item{col}{Color of text, and default border color. Either a style
function (see \link[=ansi-styles]{ANSI styles}) or a color name that is
passed to \code{\link[=make_ansi_style]{make_ansi_style()}}.}
\item{background_col}{Background color of the inside of the box.
Either a style function (see \link[=ansi-styles]{ANSI styles}), or a color
name which will be used in \code{\link[=make_ansi_style]{make_ansi_style()}} to create a
\emph{background} style (i.e. \code{bg = TRUE} is used).}
\item{border_col}{Color of the border. Either a style function
(see \link[=ansi-styles]{ANSI styles}) or a color name that is passed to
\code{\link[=make_ansi_style]{make_ansi_style()}}.}
\item{align}{Alignment of the label within the box: \code{"left"},
\code{"center"}, or \code{"right"}.}
\item{width}{Width of the screen, defaults to \code{\link[=console_width]{console_width()}}.}
}
\description{
Draw a banner-like box in the console
}
\details{
\subsection{Defaults}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!")
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌──────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────┘
</pre></div>
}}
}
\subsection{Change border style}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!", border_style = "double")
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ╔══════════════════╗
#> ║ ║
#> ║ Hello there! ║
#> ║ ║
#> ╚══════════════════╝
</pre></div>
}}
}
\subsection{Multiple lines}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx(c("Hello", "there!"), padding = 1)
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌────────────┐
#> │ │
#> │ Hello │
#> │ there! │
#> │ │
#> └────────────┘
</pre></div>
}}
}
\subsection{Padding}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!", padding = 1)
boxx("Hello there!", padding = c(1, 5, 1, 5))
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌──────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────┘
#> ┌──────────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────────┘
</pre></div>
}}
}
\subsection{Floating}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!", padding = 1, float = "center")
boxx("Hello there!", padding = 1, float = "right")
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌──────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────┘
#> ┌──────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────┘
</pre></div>
}}
}
\subsection{Text color}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx(col_cyan("Hello there!"), padding = 1, float = "center")
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌──────────────────┐
#> │ │
#> │ <span style="color: #2AA198;">Hello there!</span> │
#> │ │
#> └──────────────────┘
</pre></div>
}}
}
\subsection{Background color}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!", padding = 1, background_col = "brown")
boxx("Hello there!", padding = 1, background_col = bg_red)
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌──────────────────┐
#> │<span style="background-color: #990000;"> </span>│
#> │<span style="background-color: #990000;"> Hello there! </span>│
#> │<span style="background-color: #990000;"> </span>│
#> └──────────────────┘
#> ┌──────────────────┐
#> │<span style="background-color: #DC322F;"> </span>│
#> │<span style="background-color: #DC322F;"> Hello there! </span>│
#> │<span style="background-color: #DC322F;"> </span>│
#> └──────────────────┘
</pre></div>
}}
}
\subsection{Border color}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx("Hello there!", padding = 1, border_col = "green")
boxx("Hello there!", padding = 1, border_col = col_red)
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> <span style="color: #859900;">┌──────────────────┐</span>
#> <span style="color: #859900;">│</span> <span style="color: #859900;">│</span>
#> <span style="color: #859900;">│</span> Hello there! <span style="color: #859900;">│</span>
#> <span style="color: #859900;">│</span> <span style="color: #859900;">│</span>
#> <span style="color: #859900;">└──────────────────┘</span>
#> <span style="color: #DC322F;">┌──────────────────┐</span>
#> <span style="color: #DC322F;">│</span> <span style="color: #DC322F;">│</span>
#> <span style="color: #DC322F;">│</span> Hello there! <span style="color: #DC322F;">│</span>
#> <span style="color: #DC322F;">│</span> <span style="color: #DC322F;">│</span>
#> <span style="color: #DC322F;">└──────────────────┘</span>
</pre></div>
}}
}
\subsection{Label alignment}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{boxx(c("Hi", "there", "you!"), padding = 1, align = "left")
boxx(c("Hi", "there", "you!"), padding = 1, align = "center")
boxx(c("Hi", "there", "you!"), padding = 1, align = "right")
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> ┌───────────┐
#> │ │
#> │ Hi │
#> │ there │
#> │ you! │
#> │ │
#> └───────────┘
#> ┌───────────┐
#> │ │
#> │ Hi │
#> │ there │
#> │ you! │
#> │ │
#> └───────────┘
#> ┌───────────┐
#> │ │
#> │ Hi │
#> │ there │
#> │ you! │
#> │ │
#> └───────────┘
</pre></div>
}}
}
\subsection{A very customized box}{
\if{html}{\out{<div class="sourceCode r">}}\preformatted{star <- symbol$star
label <- c(paste(star, "Hello", star), " there!")
boxx(
col_white(label),
border_style="round",
padding = 1,
float = "center",
border_col = "tomato3",
background_col="darkolivegreen"
)
}\if{html}{\out{</div>}}\if{html}{\out{
<div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre>
#> <span style="color: #cc3333;"> ╭───────────────╮</span>
#> <span style="color: #cc3333;">│</span><span style="background-color: #336633;"> </span><span style="color: #cc3333;">│</span>
#> <span style="color: #cc3333;">│</span><span style="background-color: #336633;"> </span><span style="color: #EEE8D5;background-color: #336633;">★ Hello ★</span><span style="background-color: #336633;"> </span><span style="color: #cc3333;">│</span>
#> <span style="color: #cc3333;">│</span><span style="background-color: #336633;"> </span><span style="color: #EEE8D5;background-color: #336633;"> there!</span><span style="background-color: #336633;"> </span><span style="color: #cc3333;">│</span>
#> <span style="color: #cc3333;">│</span><span style="background-color: #336633;"> </span><span style="color: #cc3333;">│</span>
#> <span style="color: #cc3333;"> ╰───────────────╯</span>
</pre></div>
}}
}
}
\section{About fonts and terminal settings}{
The boxes might or might not look great in your terminal, depending
on the box style you use and the font the terminal uses. We found that
the Menlo font looks nice in most terminals an also in Emacs.
RStudio currently has a line height greater than one for console output,
which makes the boxes ugly.
}
|
