freya_core/elements/
extensions.rs

1use std::{
2    borrow::Cow,
3    hash::{
4        Hash,
5        Hasher,
6    },
7};
8
9use paste::paste;
10use ragnarok::CursorPoint;
11use rustc_hash::{
12    FxHashMap,
13    FxHasher,
14};
15use torin::{
16    content::Content,
17    gaps::Gaps,
18    prelude::{
19        Alignment,
20        Direction,
21        Length,
22        Position,
23        VisibleSize,
24    },
25    size::Size,
26};
27
28use crate::{
29    data::{
30        AccessibilityData,
31        EffectData,
32        LayoutData,
33        Overflow,
34        TextStyleData,
35    },
36    diff_key::DiffKey,
37    element::{
38        Element,
39        EventHandlerType,
40    },
41    elements::image::{
42        AspectRatio,
43        ImageCover,
44        ImageData,
45        SamplingMode,
46    },
47    event_handler::EventHandler,
48    events::{
49        data::{
50            Event,
51            KeyboardEventData,
52            MouseEventData,
53            SizedEventData,
54            StyledEventData,
55            WheelEventData,
56        },
57        name::EventName,
58    },
59    layers::Layer,
60    prelude::*,
61    style::{
62        font_size::FontSize,
63        font_slant::FontSlant,
64        font_weight::FontWeight,
65        font_width::FontWidth,
66        scale::Scale,
67        text_height::TextHeightBehavior,
68        text_overflow::TextOverflow,
69        text_shadow::TextShadow,
70        transform_origin::TransformOrigin,
71    },
72};
73
74/// Trait for composing child elements.
75pub trait ChildrenExt: Sized {
76    /// Returns a mutable reference to the internal children vector.
77    ///
78    /// # Example
79    /// ```ignore
80    /// impl ChildrenExt for MyElement {
81    ///     fn get_children(&mut self) -> &mut Vec<Element> {
82    ///         &mut self.elements
83    ///     }
84    /// }
85    /// ```
86    fn get_children(&mut self) -> &mut Vec<Element>;
87
88    /// Extends the children with an iterable of [`Element`]s.
89    ///
90    /// # Example
91    /// ```ignore
92    /// rect().children(["Hello", "World"].map(|t| label().text(t).into_element()))
93    /// ```
94    fn children(mut self, children: impl IntoIterator<Item = Element>) -> Self {
95        self.get_children().extend(children);
96        self
97    }
98
99    /// Appends a child only when the [`Option`] is [`Some`].
100    ///
101    /// # Example
102    /// ```ignore
103    /// rect().maybe_child(show_badge.then(|| label().text("New")))
104    /// ```
105    fn maybe_child<C: IntoElement>(mut self, child: Option<C>) -> Self {
106        if let Some(child) = child {
107            self.get_children().push(child.into_element());
108        }
109        self
110    }
111
112    /// Appends a single child element.
113    ///
114    /// # Example
115    /// ```ignore
116    /// rect().child(label().text("Hello"))
117    /// ```
118    fn child<C: IntoElement>(mut self, child: C) -> Self {
119        self.get_children().push(child.into_element());
120        self
121    }
122}
123
124/// Trait for giving an element a stable identity across renders.
125pub trait KeyExt: Sized {
126    /// Returns a mutable reference to the element's diff key.
127    fn write_key(&mut self) -> &mut DiffKey;
128
129    /// Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.
130    fn key(mut self, key: impl Hash) -> Self {
131        let mut hasher = FxHasher::default();
132        key.hash(&mut hasher);
133        *self.write_key() = DiffKey::U64(hasher.finish());
134        self
135    }
136}
137
138/// Trait for concatenating two lists into one.
139pub trait ListExt {
140    /// Append the contents of `other`, returning the combined list.
141    fn with(self, other: Self) -> Self;
142}
143
144impl<T> ListExt for Vec<T> {
145    fn with(mut self, other: Self) -> Self {
146        self.extend(other);
147        self
148    }
149}
150
151macro_rules! event_handlers {
152    (
153        $handler_variant:ident, $event_data:ty;
154        $(
155            $(#[$attr:meta])*
156            $name:ident => $event_variant:expr ;
157        )*
158    ) => {
159        paste! {
160            $(
161                $(#[$attr])*
162                fn [<on_$name>](mut self, [<on_$name>]: impl Into<EventHandler<Event<$event_data>>>) -> Self {
163                    self.get_event_handlers()
164                        .insert($event_variant, EventHandlerType::$handler_variant([<on_$name>].into()));
165                    self
166                }
167            )*
168        }
169    };
170}
171
172/// Methods for attaching event handlers to an element.
173///
174/// Many events come in three flavors: the plain one fires only while the pointer is over the
175/// element; the `global_` variants fire no matter where the event happens; and the `capture_`
176/// variants fire during the top-down capture phase, before the event reaches the inner element.
177///
178/// For high-level press handling, prefer [`on_press`](EventHandlersExt::on_press) over the raw mouse/pointer events.
179pub trait EventHandlersExt: Sized {
180    /// Returns a mutable reference to the element's event handler map.
181    fn get_event_handlers(&mut self) -> &mut FxHashMap<EventName, EventHandlerType>;
182
183    /// Replace all of this element's event handlers with the given map.
184    fn with_event_handlers(
185        mut self,
186        event_handlers: FxHashMap<EventName, EventHandlerType>,
187    ) -> Self {
188        *self.get_event_handlers() = event_handlers;
189        self
190    }
191
192    event_handlers! {
193        Mouse,
194        MouseEventData;
195
196        /// Fires when a mouse button is pressed down over the element.
197        mouse_down => EventName::MouseDown;
198        /// Fires when a mouse button is released over the element.
199        mouse_up => EventName::MouseUp;
200        /// Fires when the cursor moves over the element.
201        mouse_move => EventName::MouseMove;
202
203    }
204
205    event_handlers! {
206        Pointer,
207        PointerEventData;
208
209        /// Fires when a pointer (mouse or touch) is pressed anywhere, even outside the element.
210        global_pointer_press => EventName::GlobalPointerPress;
211        /// Fires when a pointer (mouse or touch) goes down anywhere, even outside the element.
212        global_pointer_down => EventName::GlobalPointerDown;
213        /// Fires when a pointer (mouse or touch) moves anywhere, even outside the element.
214        global_pointer_move => EventName::GlobalPointerMove;
215
216        /// Like [`on_global_pointer_move`](Self::on_global_pointer_move), but fires during the top-down capture phase.
217        capture_global_pointer_move => EventName::CaptureGlobalPointerMove;
218        /// Like [`on_global_pointer_press`](Self::on_global_pointer_press), but fires during the top-down capture phase.
219        capture_global_pointer_press => EventName::CaptureGlobalPointerPress;
220    }
221
222    event_handlers! {
223        Keyboard,
224        KeyboardEventData;
225
226        /// Fires when a key is pressed down while the element is focused.
227        key_down => EventName::KeyDown;
228        /// Fires when a key is released while the element is focused.
229        key_up => EventName::KeyUp;
230
231        /// Fires when a key is pressed down, regardless of which element is focused.
232        global_key_down => EventName::GlobalKeyDown;
233        /// Fires when a key is released, regardless of which element is focused.
234        global_key_up => EventName::GlobalKeyUp;
235    }
236
237    event_handlers! {
238        Wheel,
239        WheelEventData;
240
241        /// Fires when the scroll wheel is used over the element.
242        wheel => EventName::Wheel;
243    }
244
245    event_handlers! {
246        Touch,
247        TouchEventData;
248
249        /// Fires when an ongoing touch is cancelled by the system.
250        touch_cancel => EventName::TouchCancel;
251        /// Fires when a touch point is placed on the element.
252        touch_start => EventName::TouchStart;
253        /// Fires when a touch point moves across the element.
254        touch_move => EventName::TouchMove;
255        /// Fires when a touch point is lifted from the element.
256        touch_end => EventName::TouchEnd;
257    }
258
259    event_handlers! {
260        Pointer,
261        PointerEventData;
262
263        /// Fires when the element is pressed and released by a pointer (mouse or touch).
264        pointer_press => EventName::PointerPress;
265        /// Fires when a pointer (mouse or touch) goes down over the element.
266        pointer_down => EventName::PointerDown;
267        /// Fires when a pointer (mouse or touch) moves over the element.
268        pointer_move => EventName::PointerMove;
269        /// Fires when a pointer enters the element.
270        pointer_enter => EventName::PointerEnter;
271        /// Fires when a pointer leaves the element.
272        pointer_leave => EventName::PointerLeave;
273        /// Fires when a pointer is over the element, including over its children.
274        pointer_over => EventName::PointerOver;
275        /// Fires when a pointer leaves the element or one of its children.
276        pointer_out => EventName::PointerOut;
277    }
278
279    event_handlers! {
280        File,
281        FileEventData;
282
283        /// Fires when a file is dropped onto the element.
284        file_drop => EventName::FileDrop;
285        /// Fires when a dragged file hovers anywhere over the window.
286        global_file_hover => EventName::GlobalFileHover;
287        /// Fires when a dragged file stops hovering over the window.
288        global_file_hover_cancelled => EventName::GlobalFileHoverCancelled;
289    }
290
291    event_handlers! {
292        ImePreedit,
293        ImePreeditEventData;
294
295        /// Fires while text is being composed through an input method editor (IME).
296        ime_preedit => EventName::ImePreedit;
297    }
298
299    /// Fires when the element's measured size or position changes.
300    fn on_sized(mut self, on_sized: impl Into<EventHandler<Event<SizedEventData>>>) -> Self
301    where
302        Self: LayoutExt,
303    {
304        self.get_event_handlers()
305            .insert(EventName::Sized, EventHandlerType::Sized(on_sized.into()));
306        self.get_layout().layout.has_layout_references = true;
307        self
308    }
309
310    /// Fires when the element's inherited text style is resolved or changes.
311    fn on_styled(mut self, on_styled: impl Into<EventHandler<Event<StyledEventData>>>) -> Self {
312        self.get_event_handlers().insert(
313            EventName::Styled,
314            EventHandlerType::Styled(on_styled.into()),
315        );
316        self
317    }
318
319    /// This is generally the best event in which to run "press" logic, this might be called `onClick`, `onActivate`, or `onConnect` in other platforms.
320    ///
321    /// Gets triggered when:
322    /// - **Click**: There is a `MouseUp` event (Left button) with the in the same element that there had been a `MouseDown` just before
323    /// - **Touched**: There is a `TouchEnd` event in the same element that there had been a `TouchStart` just before
324    /// - **Activated**: The element is focused and there is a keydown event pressing the OS activation key (e.g Space, Enter)
325    fn on_press(self, on_press: impl Into<EventHandler<Event<PressEventData>>>) -> Self {
326        let on_press = on_press.into();
327        self.on_pointer_press({
328            let on_press = on_press.clone();
329            move |e: Event<PointerEventData>| {
330                let event = e.try_map(|d| match d {
331                    PointerEventData::Mouse(m) if m.button == Some(MouseButton::Left) => {
332                        Some(PressEventData::Mouse(m))
333                    }
334                    PointerEventData::Touch(t) => Some(PressEventData::Touch(t)),
335                    _ => None,
336                });
337                if let Some(event) = event {
338                    on_press.call(event);
339                }
340            }
341        })
342        .on_key_down(move |e: Event<KeyboardEventData>| {
343            if e.is_press_event() {
344                on_press.call(e.map(PressEventData::Keyboard))
345            }
346        })
347    }
348
349    /// Also called the context menu click in other platforms.
350    /// Gets triggered when:
351    /// - **Click**: There is a `MouseDown` (Right button) event
352    fn on_secondary_down(
353        self,
354        on_secondary_down: impl Into<EventHandler<Event<PressEventData>>>,
355    ) -> Self {
356        let on_secondary_down = on_secondary_down.into();
357        self.on_pointer_down(move |e: Event<PointerEventData>| {
358            let event = e.try_map(|d| match d {
359                PointerEventData::Mouse(m) if m.button == Some(MouseButton::Right) => {
360                    Some(PressEventData::Mouse(m))
361                }
362                _ => None,
363            });
364            if let Some(event) = event {
365                on_secondary_down.call(event);
366            }
367        })
368    }
369
370    /// Gets triggered when:
371    /// - **Click**: There is a `MouseUp` event (Any button) with the in the same element that there had been a `MouseDown` just before
372    /// - **Touched**: There is a `TouchEnd` event in the same element that there had been a `TouchStart` just before
373    /// - **Activated**: The element is focused and there is a keydown event pressing the OS activation key (e.g Space, Enter)
374    fn on_all_press(self, on_press: impl Into<EventHandler<Event<PressEventData>>>) -> Self {
375        let on_press = on_press.into();
376        self.on_pointer_press({
377            let on_press = on_press.clone();
378            move |e: Event<PointerEventData>| {
379                let event = e.map(|d| match d {
380                    PointerEventData::Mouse(m) => PressEventData::Mouse(m),
381                    PointerEventData::Touch(t) => PressEventData::Touch(t),
382                });
383                on_press.call(event);
384            }
385        })
386        .on_key_down(move |e: Event<KeyboardEventData>| {
387            if e.is_press_event() {
388                on_press.call(e.map(PressEventData::Keyboard))
389            }
390        })
391    }
392    /// Gets triggered when:
393    /// - **Started clicking**: There is a `MouseDown` event (Left button)
394    /// - **Touched**: There is a `TouchEnd` event in the same element that there had been a `TouchStart` just before
395    ///
396    /// This event is intended to focus elements such as text inputs following each platform style.
397    fn on_focus_press(
398        self,
399        on_focus_press: impl Into<EventHandler<Event<FocusPressEventData>>>,
400    ) -> Self {
401        let on_focus_press = on_focus_press.into();
402        if cfg!(target_os = "android") {
403            self.on_pointer_press(move |e: Event<PointerEventData>| {
404                let event = e.try_map(|d| match d {
405                    PointerEventData::Mouse(m) if m.button == Some(MouseButton::Left) => {
406                        Some(FocusPressEventData::Mouse(m))
407                    }
408                    PointerEventData::Touch(t) => Some(FocusPressEventData::Touch(t)),
409                    _ => None,
410                });
411                if let Some(event) = event {
412                    on_focus_press.call(event);
413                }
414            })
415        } else {
416            self.on_pointer_down(move |e: Event<PointerEventData>| {
417                let event = e.try_map(|d| match d {
418                    PointerEventData::Mouse(m) if m.button == Some(MouseButton::Left) => {
419                        Some(FocusPressEventData::Mouse(m))
420                    }
421                    PointerEventData::Touch(t) => Some(FocusPressEventData::Touch(t)),
422                    _ => None,
423                });
424                if let Some(event) = event {
425                    on_focus_press.call(event);
426                }
427            })
428        }
429    }
430}
431
432/// Data delivered to [`on_focus_press`](EventHandlersExt::on_focus_press), which can originate from a mouse or a touch.
433#[derive(Debug, Clone, PartialEq)]
434pub enum FocusPressEventData {
435    Mouse(MouseEventData),
436    Touch(TouchEventData),
437}
438
439impl FocusPressEventData {
440    pub fn global_location(&self) -> CursorPoint {
441        match self {
442            Self::Mouse(m) => m.global_location,
443            Self::Touch(t) => t.global_location,
444        }
445    }
446
447    pub fn element_location(&self) -> CursorPoint {
448        match self {
449            Self::Mouse(m) => m.element_location,
450            Self::Touch(t) => t.element_location,
451        }
452    }
453
454    pub fn button(&self) -> Option<MouseButton> {
455        match self {
456            Self::Mouse(m) => m.button,
457            Self::Touch(_) => None,
458        }
459    }
460}
461
462/// Data delivered to [`on_press`](EventHandlersExt::on_press), which can originate from a mouse, the keyboard or a touch.
463#[derive(Debug, Clone, PartialEq)]
464pub enum PressEventData {
465    Mouse(MouseEventData),
466    Keyboard(KeyboardEventData),
467    Touch(TouchEventData),
468}
469
470/// Layout methods for containers that arrange children along a direction axis.
471pub trait ContainerWithContentExt
472where
473    Self: LayoutExt,
474{
475    /// Set the axis children are stacked along. See [`Direction`].
476    fn direction(mut self, direction: Direction) -> Self {
477        self.get_layout().layout.direction = direction;
478        self
479    }
480    /// Set how children are aligned along the direction axis. See [`Alignment`].
481    fn main_align(mut self, main_align: Alignment) -> Self {
482        self.get_layout().layout.main_alignment = main_align;
483        self
484    }
485
486    /// Set how children are aligned across the direction axis. See [`Alignment`].
487    fn cross_align(mut self, cross_align: Alignment) -> Self {
488        self.get_layout().layout.cross_alignment = cross_align;
489        self
490    }
491
492    /// Set the gap inserted between adjacent children, in pixels.
493    fn spacing(mut self, spacing: f32) -> Self {
494        self.get_layout().layout.spacing = Length::new(spacing);
495        self
496    }
497
498    /// Set how children share the available space along the direction axis. See [`Content`].
499    fn content(mut self, content: Content) -> Self {
500        self.get_layout().layout.content = content;
501        self
502    }
503    /// Center children on both axes. Shorthand for [`main_align`](Self::main_align) and [`cross_align`](Self::cross_align) set to [`Alignment::Center`].
504    fn center(mut self) -> Self {
505        self.get_layout().layout.main_alignment = Alignment::Center;
506        self.get_layout().layout.cross_alignment = Alignment::Center;
507
508        self
509    }
510
511    /// Shift the element's children horizontally by the given pixels.
512    fn offset_x(mut self, offset_x: f32) -> Self {
513        self.get_layout().layout.offset_x = Length::new(offset_x);
514        self
515    }
516
517    /// Shift the element's children vertically by the given pixels.
518    fn offset_y(mut self, offset_y: f32) -> Self {
519        self.get_layout().layout.offset_y = Length::new(offset_y);
520        self
521    }
522
523    /// Stack children vertically. Shorthand for [`direction`](Self::direction) set to [`Direction::Vertical`].
524    fn vertical(mut self) -> Self {
525        self.get_layout().layout.direction = Direction::vertical();
526        self
527    }
528
529    /// Stack children horizontally. Shorthand for [`direction`](Self::direction) set to [`Direction::Horizontal`].
530    fn horizontal(mut self) -> Self {
531        self.get_layout().layout.direction = Direction::horizontal();
532        self
533    }
534}
535
536/// Methods for setting an element's width and height.
537pub trait ContainerSizeExt
538where
539    Self: LayoutExt,
540{
541    /// Set the element's width. See [`Size`].
542    fn width(mut self, width: impl Into<Size>) -> Self {
543        self.get_layout().layout.width = width.into();
544        self
545    }
546
547    /// Set the element's height. See [`Size`].
548    fn height(mut self, height: impl Into<Size>) -> Self {
549        self.get_layout().layout.height = height.into();
550        self
551    }
552
553    /// Expand both `width` and `height` using [Size::fill()].
554    fn expanded(mut self) -> Self {
555        self.get_layout().layout.width = Size::fill();
556        self.get_layout().layout.height = Size::fill();
557        self
558    }
559}
560
561impl<T: ContainerExt> ContainerSizeExt for T {}
562
563/// Methods for setting how an element is placed relative to its parent or the window.
564pub trait ContainerPositionExt
565where
566    Self: LayoutExt,
567{
568    /// Set how the element is placed relative to its parent or the window. See [`Position`].
569    fn position(mut self, position: impl Into<Position>) -> Self {
570        self.get_layout().layout.position = position.into();
571        self
572    }
573
574    /// Set the outer spacing between the element's edges and its surroundings. See [`Gaps`].
575    fn margin(mut self, margin: impl Into<Gaps>) -> Self {
576        self.get_layout().layout.margin = margin.into();
577        self
578    }
579}
580
581impl<T: ContainerExt> ContainerPositionExt for T {}
582
583/// Methods controlling an element's spacing and size constraints.
584pub trait ContainerExt
585where
586    Self: LayoutExt,
587{
588    /// Set the inner spacing between the element's edges and its content. See [`Gaps`].
589    fn padding(mut self, padding: impl Into<Gaps>) -> Self {
590        self.get_layout().layout.padding = padding.into();
591        self
592    }
593
594    /// Set the minimum width the element can shrink to. See [`Size`].
595    fn min_width(mut self, minimum_width: impl Into<Size>) -> Self {
596        self.get_layout().layout.minimum_width = minimum_width.into();
597        self
598    }
599
600    /// Set the minimum height the element can shrink to. See [`Size`].
601    fn min_height(mut self, minimum_height: impl Into<Size>) -> Self {
602        self.get_layout().layout.minimum_height = minimum_height.into();
603        self
604    }
605
606    /// Set the maximum width the element can grow to. See [`Size`].
607    fn max_width(mut self, maximum_width: impl Into<Size>) -> Self {
608        self.get_layout().layout.maximum_width = maximum_width.into();
609        self
610    }
611
612    /// Set the maximum height the element can grow to. See [`Size`].
613    fn max_height(mut self, maximum_height: impl Into<Size>) -> Self {
614        self.get_layout().layout.maximum_height = maximum_height.into();
615        self
616    }
617
618    /// Set how much of the measured width is actually used in layout. See [`VisibleSize`].
619    fn visible_width(mut self, visible_width: impl Into<VisibleSize>) -> Self {
620        self.get_layout().layout.visible_width = visible_width.into();
621        self
622    }
623
624    /// Set how much of the measured height is actually used in layout. See [`VisibleSize`].
625    fn visible_height(mut self, visible_height: impl Into<VisibleSize>) -> Self {
626        self.get_layout().layout.visible_height = visible_height.into();
627        self
628    }
629}
630
631/// Low-level access to an element's [`LayoutData`].
632pub trait LayoutExt
633where
634    Self: Sized,
635{
636    /// Returns a mutable reference to the element's layout data.
637    fn get_layout(&mut self) -> &mut LayoutData;
638
639    /// Replace all of the element's layout data at once. See [`LayoutData`].
640    fn layout(mut self, layout: LayoutData) -> Self {
641        *self.get_layout() = layout;
642        self
643    }
644}
645
646/// Methods for configuring how an image is scaled and sampled.
647pub trait ImageExt
648where
649    Self: LayoutExt,
650{
651    /// Returns a mutable reference to the element's image data.
652    fn get_image_data(&mut self) -> &mut ImageData;
653
654    /// Replace all of the element's image data at once. See [`ImageData`].
655    fn image_data(mut self, image_data: ImageData) -> Self {
656        *self.get_image_data() = image_data;
657        self
658    }
659
660    /// Set the filtering used when the image is scaled. See [`SamplingMode`].
661    fn sampling_mode(mut self, sampling_mode: SamplingMode) -> Self {
662        self.get_image_data().sampling_mode = sampling_mode;
663        self
664    }
665
666    /// Set how the image is scaled to fit its bounds. See [`AspectRatio`].
667    fn aspect_ratio(mut self, aspect_ratio: AspectRatio) -> Self {
668        self.get_image_data().aspect_ratio = aspect_ratio;
669        self
670    }
671
672    /// Set how the image is positioned within its bounds. See [`ImageCover`].
673    fn image_cover(mut self, image_cover: ImageCover) -> Self {
674        self.get_image_data().image_cover = image_cover;
675        self
676    }
677}
678
679/// Methods for describing an element in the accessibility tree.
680pub trait AccessibilityExt: Sized {
681    /// Returns a mutable reference to the element's accessibility data.
682    fn get_accessibility_data(&mut self) -> &mut AccessibilityData;
683
684    /// Replace all of the element's accessibility data at once. See [`AccessibilityData`].
685    fn accessibility(mut self, accessibility: AccessibilityData) -> Self {
686        *self.get_accessibility_data() = accessibility;
687        self
688    }
689
690    /// Set an explicit accessibility id instead of an autogenerated one. See [`AccessibilityId`].
691    fn a11y_id(mut self, a11y_id: impl Into<Option<AccessibilityId>>) -> Self {
692        self.get_accessibility_data().a11y_id = a11y_id.into();
693        self
694    }
695
696    /// Set whether the element can receive keyboard focus. See [`Focusable`].
697    fn a11y_focusable(mut self, a11y_focusable: impl Into<Focusable>) -> Self {
698        self.get_accessibility_data().a11y_focusable = a11y_focusable.into();
699        self
700    }
701
702    /// Request that the element be focused automatically when it is mounted.
703    fn a11y_auto_focus(mut self, a11y_auto_focus: impl Into<bool>) -> Self {
704        self.get_accessibility_data().a11y_auto_focus = a11y_auto_focus.into();
705        self
706    }
707
708    /// Mark the element as a member of the group identified by the given [`AccessibilityId`].
709    fn a11y_member_of(mut self, a11y_member_of: impl Into<AccessibilityId>) -> Self {
710        self.get_accessibility_data()
711            .builder
712            .set_member_of(a11y_member_of.into());
713        self
714    }
715
716    /// Set the accessibility role exposed in the accessibility tree. See [`AccessibilityRole`].
717    fn a11y_role(mut self, a11y_role: impl Into<AccessibilityRole>) -> Self {
718        self.get_accessibility_data()
719            .builder
720            .set_role(a11y_role.into());
721        self
722    }
723
724    /// Set the text label that describes the element in the accessibility tree.
725    fn a11y_alt(mut self, value: impl Into<Box<str>>) -> Self {
726        self.get_accessibility_data().builder.set_label(value);
727        self
728    }
729
730    /// Edit the underlying `accesskit` node directly for advanced accessibility properties.
731    fn a11y_builder(mut self, with: impl FnOnce(&mut accesskit::Node)) -> Self {
732        with(&mut self.get_accessibility_data().builder);
733        self
734    }
735}
736
737/// Methods for styling the text rendered by an element and inherited by its children.
738pub trait TextStyleExt
739where
740    Self: Sized,
741{
742    /// Returns a mutable reference to the element's text style data.
743    fn get_text_style_data(&mut self) -> &mut TextStyleData;
744
745    /// Replace all of the element's text style data at once. See [`TextStyleData`].
746    fn text_style(mut self, data: TextStyleData) -> Self {
747        *self.get_text_style_data() = data;
748        self
749    }
750
751    /// Paint the text with any [`Fill`]: a [`Color`], a gradient or a shader.
752    fn color(mut self, color: impl Into<Fill>) -> Self {
753        self.get_text_style_data().color = Some(color.into());
754        self
755    }
756
757    /// Set the horizontal alignment of the text. See [`TextAlign`].
758    fn text_align(mut self, text_align: impl Into<TextAlign>) -> Self {
759        self.get_text_style_data().text_align = Some(text_align.into());
760        self
761    }
762
763    /// Set the text size in pixels. See [`FontSize`].
764    fn font_size(mut self, font_size: impl Into<FontSize>) -> Self {
765        self.get_text_style_data().font_size = Some(font_size.into());
766        self
767    }
768
769    /// Add a font family to try, in order of preference.
770    fn font_family(mut self, font_family: impl Into<Cow<'static, str>>) -> Self {
771        self.get_text_style_data()
772            .font_families
773            .push(font_family.into());
774        self
775    }
776
777    /// Set the slant (style) of the font. See [`FontSlant`].
778    fn font_slant(mut self, font_slant: impl Into<FontSlant>) -> Self {
779        self.get_text_style_data().font_slant = Some(font_slant.into());
780        self
781    }
782
783    /// Set the thickness of the font. See [`FontWeight`].
784    fn font_weight(mut self, font_weight: impl Into<FontWeight>) -> Self {
785        self.get_text_style_data().font_weight = Some(font_weight.into());
786        self
787    }
788
789    /// Set the horizontal width of the font. See [`FontWidth`].
790    fn font_width(mut self, font_width: impl Into<FontWidth>) -> Self {
791        self.get_text_style_data().font_width = Some(font_width.into());
792        self
793    }
794
795    /// Set how the leading of the first and last lines is handled. See [`TextHeightBehavior`].
796    fn text_height(mut self, text_height: impl Into<TextHeightBehavior>) -> Self {
797        self.get_text_style_data().text_height = Some(text_height.into());
798        self
799    }
800
801    /// Set how text that does not fit its bounds is truncated. See [`TextOverflow`].
802    fn text_overflow(mut self, text_overflow: impl Into<TextOverflow>) -> Self {
803        self.get_text_style_data().text_overflow = Some(text_overflow.into());
804        self
805    }
806
807    /// Add a shadow cast behind the text. See [`TextShadow`].
808    fn text_shadow(mut self, text_shadow: impl Into<TextShadow>) -> Self {
809        self.get_text_style_data()
810            .text_shadows
811            .push(text_shadow.into());
812        self
813    }
814
815    /// Set a line drawn through, under or over the text. See [`TextDecoration`].
816    fn text_decoration(mut self, text_decoration: impl Into<TextDecoration>) -> Self {
817        self.get_text_style_data().text_decoration = Some(text_decoration.into());
818        self
819    }
820}
821
822/// Methods for styling an element's box: background, borders, shadows and corners.
823pub trait StyleExt
824where
825    Self: Sized,
826{
827    /// Returns a mutable reference to the element's style data.
828    fn get_style(&mut self) -> &mut StyleState;
829
830    /// Paint the background with any [`Fill`]: a [`Color`], a gradient or a shader.
831    fn background(mut self, background: impl Into<Fill>) -> Self {
832        self.get_style().background = background.into();
833        self
834    }
835
836    /// Add an outline around the element. See [`Border`].
837    fn border(mut self, border: impl Into<Option<Border>>) -> Self {
838        if let Some(border) = border.into() {
839            self.get_style().borders.push(border);
840        }
841        self
842    }
843
844    /// Add a shadow cast by the element. See [`Shadow`].
845    fn shadow(mut self, shadow: impl Into<Shadow>) -> Self {
846        self.get_style().shadows.push(shadow.into());
847        self
848    }
849
850    /// Round the element's corners. See [`CornerRadius`].
851    fn corner_radius(mut self, corner_radius: impl Into<CornerRadius>) -> Self {
852        self.get_style().corner_radius = corner_radius.into();
853        self
854    }
855}
856
857impl<T: StyleExt> CornerRadiusExt for T {
858    fn with_corner_radius(mut self, corner_radius: f32) -> Self {
859        self.get_style().corner_radius = CornerRadius::new_all(corner_radius);
860        self
861    }
862}
863
864/// Shorthand methods for setting an element's [`CornerRadius`] to common values.
865pub trait CornerRadiusExt: Sized {
866    /// Round all four corners to the given radius in pixels.
867    fn with_corner_radius(self, corner_radius: f32) -> Self;
868
869    /// Shortcut for `corner_radius(0.)` - removes border radius.
870    fn rounded_none(self) -> Self {
871        self.with_corner_radius(0.)
872    }
873
874    /// Shortcut for `corner_radius(6.)` - default border radius.
875    fn rounded(self) -> Self {
876        self.with_corner_radius(6.)
877    }
878
879    /// Shortcut for `corner_radius(4.)` - small border radius.
880    fn rounded_sm(self) -> Self {
881        self.with_corner_radius(4.)
882    }
883
884    /// Shortcut for `corner_radius(6.)` - medium border radius.
885    fn rounded_md(self) -> Self {
886        self.with_corner_radius(6.)
887    }
888
889    /// Shortcut for `corner_radius(8.)` - large border radius.
890    fn rounded_lg(self) -> Self {
891        self.with_corner_radius(8.)
892    }
893
894    /// Shortcut for `corner_radius(12.)` - extra large border radius.
895    fn rounded_xl(self) -> Self {
896        self.with_corner_radius(12.)
897    }
898
899    /// Shortcut for `corner_radius(16.)` - extra large border radius.
900    fn rounded_2xl(self) -> Self {
901        self.with_corner_radius(16.)
902    }
903
904    /// Shortcut for `corner_radius(24.)` - extra large border radius.
905    fn rounded_3xl(self) -> Self {
906        self.with_corner_radius(24.)
907    }
908
909    /// Shortcut for `corner_radius(32.)` - extra large border radius.
910    fn rounded_4xl(self) -> Self {
911        self.with_corner_radius(32.)
912    }
913
914    /// Shortcut for `corner_radius(99.)` - fully rounded (pill shape).
915    fn rounded_full(self) -> Self {
916        self.with_corner_radius(99.)
917    }
918}
919
920/// Methods for applying changes to an element conditionally.
921pub trait MaybeExt
922where
923    Self: Sized,
924{
925    /// Apply `then` to the element only when the condition is `true`.
926    fn maybe(self, bool: impl Into<bool>, then: impl FnOnce(Self) -> Self) -> Self {
927        if bool.into() { then(self) } else { self }
928    }
929
930    /// Apply `then` to the element only when the [`Option`] is [`Some`], passing the inner value.
931    fn map<T>(self, data: Option<T>, then: impl FnOnce(Self, T) -> Self) -> Self {
932        if let Some(data) = data {
933            then(self, data)
934        } else {
935            self
936        }
937    }
938}
939
940/// Method for controlling which painting layer an element belongs to.
941pub trait LayerExt
942where
943    Self: Sized,
944{
945    /// Returns a mutable reference to the element's layer.
946    fn get_layer(&mut self) -> &mut Layer;
947
948    /// Set the painting layer of the element. See [`Layer`].
949    fn layer(mut self, layer: impl Into<Layer>) -> Self {
950        *self.get_layer() = layer.into();
951        self
952    }
953}
954
955pub trait ScrollableExt
956where
957    Self: Sized,
958{
959    /// Returns a mutable reference to the element's effect data.
960    fn get_effect(&mut self) -> &mut EffectData;
961
962    /// Mark this element as scrollable.
963    /// You are probably looking for the `ScrollView` component instead.
964    fn scrollable(mut self, scrollable: impl Into<bool>) -> Self {
965        self.get_effect().scrollable = scrollable.into();
966        self
967    }
968}
969
970/// Method for controlling whether an element responds to pointer events.
971pub trait InteractiveExt
972where
973    Self: Sized,
974{
975    /// Returns a mutable reference to the element's effect data.
976    fn get_effect(&mut self) -> &mut EffectData;
977
978    /// Set whether the element receives pointer events. See [`Interactive`].
979    fn interactive(mut self, interactive: impl Into<Interactive>) -> Self {
980        self.get_effect().interactive = interactive.into();
981        self
982    }
983}
984
985/// Methods for visual effects applied to an element: clipping, blur, rotation, opacity and scale.
986pub trait EffectExt: Sized {
987    /// Returns a mutable reference to the element's effect data.
988    fn get_effect(&mut self) -> &mut EffectData;
989
990    /// Replace all of the element's effect data at once. See [`EffectData`].
991    fn effect(mut self, effect: EffectData) -> Self {
992        *self.get_effect() = effect;
993        self
994    }
995
996    /// Set whether content overflowing the element's bounds is clipped. See [`Overflow`].
997    fn overflow(mut self, overflow: impl Into<Overflow>) -> Self {
998        self.get_effect().overflow = overflow.into();
999        self
1000    }
1001
1002    /// Apply a gaussian blur of the given radius to the element.
1003    fn blur(mut self, blur: f32) -> Self {
1004        self.get_effect().blur = Some(blur);
1005        self
1006    }
1007
1008    /// Rotate the element by the given angle in degrees.
1009    fn rotation(mut self, rotation: f32) -> Self {
1010        self.get_effect().rotation = Some(rotation);
1011        self
1012    }
1013
1014    /// Set the element's opacity, from `0.0` (transparent) to `1.0` (opaque).
1015    fn opacity(mut self, opacity: f32) -> Self {
1016        self.get_effect().opacity = Some(opacity);
1017        self
1018    }
1019
1020    /// Scale the element. See [`Scale`].
1021    fn scale(mut self, scale: impl Into<Scale>) -> Self {
1022        self.get_effect().scale = Some(scale.into());
1023        self
1024    }
1025
1026    /// Set the point that the scale and rotation effects pivot around.
1027    ///
1028    /// Defaults to the element's center.
1029    fn transform_origin(mut self, transform_origin: impl Into<TransformOrigin>) -> Self {
1030        self.get_effect().transform_origin = transform_origin.into();
1031        self
1032    }
1033}
freya_core/elements/extensions.rs

freya_core/elements/
extensions.rs
