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
use ;
use ;
use component_doc;
use inline_style_sheet_values;
/// Generic layout wrapper for spacing, sizing, and surface styling on a single node.
///
/// `Box` is a theme-aware container for one element—like a `<div>` with optional token-based padding, margin, width, and extra CSS. Use it when a single wrapper needs spacing or sizing without distributing gaps between siblings. `foreground` sets theme text color — not the CSS `color` shorthand prop. For even gaps between children, prefer [`Stack`](crate::Stack) or [`Flex`](crate::Flex).
///
/// # When to use
///
/// - One wrapper needs padding, margin, max-width, or surface styling - A card-like region without the full [`Material`](crate::Material) API - Custom layout chrome where [`Stack`](crate::Stack) / [`Flex`](crate::Flex) are too opinionated
///
/// # Usage
///
/// 1. Put content in the default slot. 2. Set typed `padding`, `margin`, `background`, `radius`, and related token props. 3. Pass additional rules through `style` when you need escape-hatch CSS. 4. Add utility classes through `class` when needed.
///
/// # Best Practices
///
/// ## Do's
///
/// * Use [`SpacingInset`] for `padding` / `margin` * Use [`ThemeColor`], [`BorderRadius`], and [`Shadow`] for surface styling * Pair `Box` with typography presets ([`Body1`](crate::Body1)) for readable demo and app copy
///
/// ## Don'ts
///
/// * Do not use `Box` to space multiple siblings — prefer [`Stack`](crate::Stack) or [`Flex`](crate::Flex) * Avoid hard-coded hex colors; use [`ThemeColor`] tokens
///
/// # Examples
///
/// ## Default
/// A bordered box with sample text—the quickest way to see the container bounds.
/// <!-- default -->
/// <!-- preview -->
/// ```rust
/// use crate::Box;
/// use orbital_base_components::{BorderRadius, SpacingInset, StrokeWidth, ThemeColor};
/// view! {
/// <div data-testid="box-preview">
/// <Box
/// padding=SpacingInset::all_m()
/// background=ThemeColor::NeutralBackground1
/// foreground=ThemeColor::NeutralForeground1
/// border_color=ThemeColor::NeutralStroke1
/// radius=BorderRadius::Medium
/// border_style="dashed"
/// border_width=StrokeWidth::Thin
/// >
/// "This Box wraps content with theme-aware spacing and stroke tokens."
/// </Box>
/// </div>
/// }
/// ```
///
/// ## Padding
/// The `padding` prop adds inner space without extra wrapper markup.
/// <!-- preview -->
/// ```rust
/// use crate::Box;
/// use orbital_base_components::{BorderRadius, SpacingInset, StrokeWidth, ThemeColor};
/// view! {
/// <div data-testid="box-padding">
/// <Box
/// padding=SpacingInset::all_l()
/// foreground=ThemeColor::NeutralForeground1
/// border_color=ThemeColor::NeutralStroke1
/// radius=BorderRadius::Medium
/// border_style="dashed"
/// border_width=StrokeWidth::Thin
/// >
/// "Extra padding keeps content away from the dashed border."
/// </Box>
/// </div>
/// }
/// ```
///
/// ## Margin
/// The `margin` prop offsets the box from surrounding layout—visible against a tinted backdrop.
/// <!-- preview -->
/// ```rust
/// use crate::Box;
/// use orbital_base_components::{BorderRadius, SpacingInset, StrokeWidth, ThemeColor};
/// view! {
/// <div data-testid="box-margin" style="padding: var(--orb-space-inline-sm); background: var(--orb-color-surface-subtle); border-radius: var(--orb-radius-md);">
/// <Box
/// margin=SpacingInset::all_l()
/// padding=SpacingInset::all_m()
/// foreground=ThemeColor::NeutralForeground1
/// border_color=ThemeColor::NeutralStroke1
/// radius=BorderRadius::Medium
/// border_style="dashed"
/// border_width=StrokeWidth::Thin
/// >
/// "Margin pushes this box away from the outer frame."
/// </Box>
/// </div>
/// }
/// ```
///
/// ## Width
/// Constrain width on forms, side panels, and compact callouts.
/// <!-- preview -->
/// ```rust
/// use crate::Box;
/// use orbital_base_components::{BorderRadius, SpacingInset, StrokeWidth, ThemeColor};
/// view! {
/// <div data-testid="box-width">
/// <Box
/// width="280px"
/// padding=SpacingInset::all_m()
/// foreground=ThemeColor::NeutralForeground1
/// border_color=ThemeColor::NeutralStroke1
/// radius=BorderRadius::Medium
/// border_style="dashed"
/// border_width=StrokeWidth::Thin
/// >
/// "A fixed width keeps this callout readable in wide layouts."
/// </Box>
/// </div>
/// }
/// ```
///
/// ## Surface styling
/// Combine typed surface props for a subtle raised panel.
/// <!-- preview -->
/// ```rust
/// use crate::Box;
/// use orbital_base_components::{BorderRadius, Shadow, SpacingInset, StrokeWidth, ThemeColor};
/// view! {
/// <div data-testid="box-surface">
/// <Box
/// padding=SpacingInset::all_l()
/// background=ThemeColor::NeutralBackground1
/// foreground=ThemeColor::NeutralForeground1
/// border_color=ThemeColor::NeutralStroke1
/// radius=BorderRadius::Medium
/// border_width=StrokeWidth::Thin
/// shadow=Shadow::Shadow4
/// >
/// "Surface tokens give the box a resting elevation on the page canvas."
/// </Box>
/// </div>
/// }
/// ```