1use crate::{
2 black, phi, point, rems, AbsoluteLength, BorrowAppContext, BorrowWindow, Bounds, ContentMask,
3 Corners, CornersRefinement, CursorStyle, DefiniteLength, Edges, EdgesRefinement, Font,
4 FontFeatures, FontStyle, FontWeight, Hsla, Length, Pixels, Point, PointRefinement, Result,
5 Rgba, SharedString, Size, SizeRefinement, Styled, TextRun, ViewContext, WindowContext,
6};
7use refineable::{Cascade, Refineable};
8use smallvec::SmallVec;
9pub use taffy::style::{
10 AlignContent, AlignItems, AlignSelf, Display, FlexDirection, FlexWrap, JustifyContent,
11 Overflow, Position,
12};
13
14pub type StyleCascade = Cascade<Style>;
15
16#[derive(Clone, Refineable, Debug)]
17#[refineable(debug)]
18pub struct Style {
19 /// What layout strategy should be used?
20 pub display: Display,
21
22 /// Should the element be painted on screen?
23 pub visibility: Visibility,
24
25 // Overflow properties
26 /// How children overflowing their container should affect layout
27 #[refineable]
28 pub overflow: Point<Overflow>,
29 /// How much space (in points) should be reserved for the scrollbars of `Overflow::Scroll` and `Overflow::Auto` nodes.
30 pub scrollbar_width: f32,
31
32 // Position properties
33 /// What should the `position` value of this struct use as a base offset?
34 pub position: Position,
35 /// How should the position of this element be tweaked relative to the layout defined?
36 #[refineable]
37 pub inset: Edges<Length>,
38
39 // Size properies
40 /// Sets the initial size of the item
41 #[refineable]
42 pub size: Size<Length>,
43 /// Controls the minimum size of the item
44 #[refineable]
45 pub min_size: Size<Length>,
46 /// Controls the maximum size of the item
47 #[refineable]
48 pub max_size: Size<Length>,
49 /// Sets the preferred aspect ratio for the item. The ratio is calculated as width divided by height.
50 pub aspect_ratio: Option<f32>,
51
52 // Spacing Properties
53 /// How large should the margin be on each side?
54 #[refineable]
55 pub margin: Edges<Length>,
56 /// How large should the padding be on each side?
57 #[refineable]
58 pub padding: Edges<DefiniteLength>,
59 /// How large should the border be on each side?
60 #[refineable]
61 pub border_widths: Edges<AbsoluteLength>,
62
63 // Alignment properties
64 /// How this node's children aligned in the cross/block axis?
65 pub align_items: Option<AlignItems>,
66 /// How this node should be aligned in the cross/block axis. Falls back to the parents [`AlignItems`] if not set
67 pub align_self: Option<AlignSelf>,
68 /// How should content contained within this item be aligned in the cross/block axis
69 pub align_content: Option<AlignContent>,
70 /// How should contained within this item be aligned in the main/inline axis
71 pub justify_content: Option<JustifyContent>,
72 /// How large should the gaps between items in a flex container be?
73 #[refineable]
74 pub gap: Size<DefiniteLength>,
75
76 // Flexbox properies
77 /// Which direction does the main axis flow in?
78 pub flex_direction: FlexDirection,
79 /// Should elements wrap, or stay in a single line?
80 pub flex_wrap: FlexWrap,
81 /// Sets the initial main axis size of the item
82 pub flex_basis: Length,
83 /// The relative rate at which this item grows when it is expanding to fill space, 0.0 is the default value, and this value must be positive.
84 pub flex_grow: f32,
85 /// The relative rate at which this item shrinks when it is contracting to fit into space, 1.0 is the default value, and this value must be positive.
86 pub flex_shrink: f32,
87
88 /// The fill color of this element
89 pub background: Option<Fill>,
90
91 /// The border color of this element
92 pub border_color: Option<Hsla>,
93
94 /// The radius of the corners of this element
95 #[refineable]
96 pub corner_radii: Corners<AbsoluteLength>,
97
98 /// Box Shadow of the element
99 pub box_shadow: SmallVec<[BoxShadow; 2]>,
100
101 /// TEXT
102 pub text: TextStyleRefinement,
103
104 /// The mouse cursor style shown when the mouse pointer is over an element.
105 pub mouse_cursor: Option<CursorStyle>,
106
107 pub z_index: Option<u32>,
108}
109
110impl Styled for StyleRefinement {
111 fn style(&mut self) -> &mut StyleRefinement {
112 self
113 }
114}
115
116#[derive(Default, Clone, Copy, Debug, Eq, PartialEq)]
117pub enum Visibility {
118 #[default]
119 Visible,
120 Hidden,
121}
122
123#[derive(Clone, Debug)]
124pub struct BoxShadow {
125 pub color: Hsla,
126 pub offset: Point<Pixels>,
127 pub blur_radius: Pixels,
128 pub spread_radius: Pixels,
129}
130
131#[derive(Refineable, Clone, Debug)]
132#[refineable(debug)]
133pub struct TextStyle {
134 pub color: Hsla,
135 pub font_family: SharedString,
136 pub font_features: FontFeatures,
137 pub font_size: AbsoluteLength,
138 pub line_height: DefiniteLength,
139 pub font_weight: FontWeight,
140 pub font_style: FontStyle,
141 pub underline: Option<UnderlineStyle>,
142}
143
144impl Default for TextStyle {
145 fn default() -> Self {
146 TextStyle {
147 color: black(),
148 font_family: "Helvetica".into(), // todo!("Get a font we know exists on the system")
149 font_features: FontFeatures::default(),
150 font_size: rems(1.).into(),
151 line_height: phi(),
152 font_weight: FontWeight::default(),
153 font_style: FontStyle::default(),
154 underline: None,
155 }
156 }
157}
158
159impl TextStyle {
160 pub fn highlight(mut self, style: HighlightStyle) -> Result<Self> {
161 if let Some(weight) = style.font_weight {
162 self.font_weight = weight;
163 }
164 if let Some(style) = style.font_style {
165 self.font_style = style;
166 }
167
168 if let Some(color) = style.color {
169 self.color = self.color.blend(color);
170 }
171
172 if let Some(factor) = style.fade_out {
173 self.color.fade_out(factor);
174 }
175
176 if let Some(underline) = style.underline {
177 self.underline = Some(underline);
178 }
179
180 Ok(self)
181 }
182
183 pub fn font(&self) -> Font {
184 Font {
185 family: self.font_family.clone(),
186 features: self.font_features.clone(),
187 weight: self.font_weight,
188 style: self.font_style,
189 }
190 }
191
192 pub fn to_run(&self, len: usize) -> TextRun {
193 TextRun {
194 len,
195 font: Font {
196 family: self.font_family.clone(),
197 features: Default::default(),
198 weight: self.font_weight,
199 style: self.font_style,
200 },
201 color: self.color,
202 underline: self.underline.clone(),
203 }
204 }
205}
206
207#[derive(Copy, Clone, Debug, Default, PartialEq)]
208pub struct HighlightStyle {
209 pub color: Option<Hsla>,
210 pub font_weight: Option<FontWeight>,
211 pub font_style: Option<FontStyle>,
212 pub underline: Option<UnderlineStyle>,
213 pub fade_out: Option<f32>,
214}
215
216impl Eq for HighlightStyle {}
217
218impl Style {
219 pub fn text_style(&self, _cx: &WindowContext) -> Option<&TextStyleRefinement> {
220 if self.text.is_some() {
221 Some(&self.text)
222 } else {
223 None
224 }
225 }
226
227 pub fn apply_text_style<C, F, R>(&self, cx: &mut C, f: F) -> R
228 where
229 C: BorrowAppContext,
230 F: FnOnce(&mut C) -> R,
231 {
232 if self.text.is_some() {
233 cx.with_text_style(self.text.clone(), f)
234 } else {
235 f(cx)
236 }
237 }
238
239 /// Apply overflow to content mask
240 pub fn apply_overflow<C, F, R>(&self, bounds: Bounds<Pixels>, cx: &mut C, f: F) -> R
241 where
242 C: BorrowWindow,
243 F: FnOnce(&mut C) -> R,
244 {
245 let current_mask = cx.content_mask();
246
247 let min = current_mask.bounds.origin;
248 let max = current_mask.bounds.lower_right();
249
250 let mask_bounds = match (
251 self.overflow.x == Overflow::Visible,
252 self.overflow.y == Overflow::Visible,
253 ) {
254 // x and y both visible
255 (true, true) => return f(cx),
256 // x visible, y hidden
257 (true, false) => Bounds::from_corners(
258 point(min.x, bounds.origin.y),
259 point(max.x, bounds.lower_right().y),
260 ),
261 // x hidden, y visible
262 (false, true) => Bounds::from_corners(
263 point(bounds.origin.x, min.y),
264 point(bounds.lower_right().x, max.y),
265 ),
266 // both hidden
267 (false, false) => bounds,
268 };
269 let mask = ContentMask {
270 bounds: mask_bounds,
271 };
272
273 cx.with_content_mask(mask, f)
274 }
275
276 /// Paints the background of an element styled with this style.
277 pub fn paint<V: 'static>(&self, bounds: Bounds<Pixels>, cx: &mut ViewContext<V>) {
278 let rem_size = cx.rem_size();
279
280 cx.with_z_index(0, |cx| {
281 cx.paint_shadows(
282 bounds,
283 self.corner_radii.to_pixels(bounds.size, rem_size),
284 &self.box_shadow,
285 );
286 });
287
288 let background_color = self.background.as_ref().and_then(Fill::color);
289 if background_color.is_some() || self.is_border_visible() {
290 cx.with_z_index(1, |cx| {
291 cx.paint_quad(
292 bounds,
293 self.corner_radii.to_pixels(bounds.size, rem_size),
294 background_color.unwrap_or_default(),
295 self.border_widths.to_pixels(rem_size),
296 self.border_color.unwrap_or_default(),
297 );
298 });
299 }
300 }
301
302 fn is_border_visible(&self) -> bool {
303 self.border_color
304 .map_or(false, |color| !color.is_transparent())
305 && self.border_widths.any(|length| !length.is_zero())
306 }
307}
308
309impl Default for Style {
310 fn default() -> Self {
311 Style {
312 display: Display::Block,
313 visibility: Visibility::Visible,
314 overflow: Point {
315 x: Overflow::Visible,
316 y: Overflow::Visible,
317 },
318 scrollbar_width: 0.0,
319 position: Position::Relative,
320 inset: Edges::auto(),
321 margin: Edges::<Length>::zero(),
322 padding: Edges::<DefiniteLength>::zero(),
323 border_widths: Edges::<AbsoluteLength>::zero(),
324 size: Size::auto(),
325 min_size: Size::auto(),
326 max_size: Size::auto(),
327 aspect_ratio: None,
328 gap: Size::zero(),
329 // Aligment
330 align_items: None,
331 align_self: None,
332 align_content: None,
333 justify_content: None,
334 // Flexbox
335 flex_direction: FlexDirection::Row,
336 flex_wrap: FlexWrap::NoWrap,
337 flex_grow: 0.0,
338 flex_shrink: 1.0,
339 flex_basis: Length::Auto,
340 background: None,
341 border_color: None,
342 corner_radii: Corners::default(),
343 box_shadow: Default::default(),
344 text: TextStyleRefinement::default(),
345 mouse_cursor: None,
346 z_index: None,
347 }
348 }
349}
350
351#[derive(Refineable, Copy, Clone, Default, Debug, PartialEq, Eq)]
352#[refineable(debug)]
353pub struct UnderlineStyle {
354 pub thickness: Pixels,
355 pub color: Option<Hsla>,
356 pub wavy: bool,
357}
358
359#[derive(Clone, Debug)]
360pub enum Fill {
361 Color(Hsla),
362}
363
364impl Fill {
365 pub fn color(&self) -> Option<Hsla> {
366 match self {
367 Fill::Color(color) => Some(*color),
368 }
369 }
370}
371
372impl Default for Fill {
373 fn default() -> Self {
374 Self::Color(Hsla::default())
375 }
376}
377
378impl From<Hsla> for Fill {
379 fn from(color: Hsla) -> Self {
380 Self::Color(color)
381 }
382}
383
384impl From<TextStyle> for HighlightStyle {
385 fn from(other: TextStyle) -> Self {
386 Self::from(&other)
387 }
388}
389
390impl From<&TextStyle> for HighlightStyle {
391 fn from(other: &TextStyle) -> Self {
392 Self {
393 color: Some(other.color),
394 font_weight: Some(other.font_weight),
395 font_style: Some(other.font_style),
396 underline: other.underline.clone(),
397 fade_out: None,
398 }
399 }
400}
401
402impl HighlightStyle {
403 pub fn highlight(&mut self, other: HighlightStyle) {
404 match (self.color, other.color) {
405 (Some(self_color), Some(other_color)) => {
406 self.color = Some(Hsla::blend(other_color, self_color));
407 }
408 (None, Some(other_color)) => {
409 self.color = Some(other_color);
410 }
411 _ => {}
412 }
413
414 if other.font_weight.is_some() {
415 self.font_weight = other.font_weight;
416 }
417
418 if other.font_style.is_some() {
419 self.font_style = other.font_style;
420 }
421
422 if other.underline.is_some() {
423 self.underline = other.underline;
424 }
425
426 match (other.fade_out, self.fade_out) {
427 (Some(source_fade), None) => self.fade_out = Some(source_fade),
428 (Some(source_fade), Some(dest_fade)) => {
429 self.fade_out = Some((dest_fade * (1. + source_fade)).clamp(0., 1.));
430 }
431 _ => {}
432 }
433 }
434}
435
436impl From<Hsla> for HighlightStyle {
437 fn from(color: Hsla) -> Self {
438 Self {
439 color: Some(color),
440 ..Default::default()
441 }
442 }
443}
444
445impl From<Rgba> for HighlightStyle {
446 fn from(color: Rgba) -> Self {
447 Self {
448 color: Some(color.into()),
449 ..Default::default()
450 }
451 }
452}