use crate::{ self as gpui, px, relative, rems, AbsoluteLength, AlignItems, CursorStyle, DefiniteLength, Fill, FlexDirection, FlexWrap, Font, FontStyle, FontWeight, Hsla, JustifyContent, Length, SharedString, StrikethroughStyle, StyleRefinement, WhiteSpace, }; use crate::{TextStyleRefinement, Truncate}; pub use gpui_macros::{ border_style_methods, box_shadow_style_methods, cursor_style_methods, margin_style_methods, overflow_style_methods, padding_style_methods, position_style_methods, visibility_style_methods, }; use taffy::style::{AlignContent, Display}; /// A trait for elements that can be styled. /// Use this to opt-in to a utility CSS-like styling API. pub trait Styled: Sized { /// Returns a reference to the style memory of this element. fn style(&mut self) -> &mut StyleRefinement; gpui_macros::style_helpers!(); gpui_macros::visibility_style_methods!(); gpui_macros::margin_style_methods!(); gpui_macros::padding_style_methods!(); gpui_macros::position_style_methods!(); gpui_macros::overflow_style_methods!(); gpui_macros::cursor_style_methods!(); gpui_macros::border_style_methods!(); gpui_macros::box_shadow_style_methods!(); /// Sets the display type of the element to `block`. /// [Docs](https://tailwindcss.com/docs/display) fn block(mut self) -> Self { self.style().display = Some(Display::Block); self } /// Sets the display type of the element to `flex`. /// [Docs](https://tailwindcss.com/docs/display) fn flex(mut self) -> Self { self.style().display = Some(Display::Flex); self } /// Sets the whitespace of the element to `normal`. /// [Docs](https://tailwindcss.com/docs/whitespace#normal) fn whitespace_normal(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .white_space = Some(WhiteSpace::Normal); self } /// Sets the whitespace of the element to `nowrap`. /// [Docs](https://tailwindcss.com/docs/whitespace#nowrap) fn whitespace_nowrap(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .white_space = Some(WhiteSpace::Nowrap); self } /// Sets the truncate overflowing text with an ellipsis (…) if needed. /// [Docs](https://tailwindcss.com/docs/text-overflow#ellipsis) fn text_ellipsis(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .truncate = Some(Truncate::Ellipsis); self } /// Sets the truncate overflowing text. /// [Docs](https://tailwindcss.com/docs/text-overflow#truncate) fn truncate(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .truncate = Some(Truncate::Truncate); self } /// Sets the flex direction of the element to `column`. /// [Docs](https://tailwindcss.com/docs/flex-direction#column) fn flex_col(mut self) -> Self { self.style().flex_direction = Some(FlexDirection::Column); self } /// Sets the flex direction of the element to `column-reverse`. /// [Docs](https://tailwindcss.com/docs/flex-direction#column-reverse) fn flex_col_reverse(mut self) -> Self { self.style().flex_direction = Some(FlexDirection::ColumnReverse); self } /// Sets the flex direction of the element to `row`. /// [Docs](https://tailwindcss.com/docs/flex-direction#row) fn flex_row(mut self) -> Self { self.style().flex_direction = Some(FlexDirection::Row); self } /// Sets the flex direction of the element to `row-reverse`. /// [Docs](https://tailwindcss.com/docs/flex-direction#row-reverse) fn flex_row_reverse(mut self) -> Self { self.style().flex_direction = Some(FlexDirection::RowReverse); self } /// Sets the element to allow a flex item to grow and shrink as needed, ignoring its initial size. /// [Docs](https://tailwindcss.com/docs/flex#flex-1) fn flex_1(mut self) -> Self { self.style().flex_grow = Some(1.); self.style().flex_shrink = Some(1.); self.style().flex_basis = Some(relative(0.).into()); self } /// Sets the element to allow a flex item to grow and shrink, taking into account its initial size. /// [Docs](https://tailwindcss.com/docs/flex#auto) fn flex_auto(mut self) -> Self { self.style().flex_grow = Some(1.); self.style().flex_shrink = Some(1.); self.style().flex_basis = Some(Length::Auto); self } /// Sets the element to allow a flex item to shrink but not grow, taking into account its initial size. /// [Docs](https://tailwindcss.com/docs/flex#initial) fn flex_initial(mut self) -> Self { self.style().flex_grow = Some(0.); self.style().flex_shrink = Some(1.); self.style().flex_basis = Some(Length::Auto); self } /// Sets the element to prevent a flex item from growing or shrinking. /// [Docs](https://tailwindcss.com/docs/flex#none) fn flex_none(mut self) -> Self { self.style().flex_grow = Some(0.); self.style().flex_shrink = Some(0.); self } /// Sets the initial size of flex items for this element. /// [Docs](https://tailwindcss.com/docs/flex-basis) fn flex_basis(mut self, basis: impl Into) -> Self { self.style().flex_basis = Some(basis.into()); self } /// Sets the element to allow a flex item to grow to fill any available space. /// [Docs](https://tailwindcss.com/docs/flex-grow) fn flex_grow(mut self) -> Self { self.style().flex_grow = Some(1.); self } /// Sets the element to allow a flex item to shrink if needed. /// [Docs](https://tailwindcss.com/docs/flex-shrink) fn flex_shrink(mut self) -> Self { self.style().flex_shrink = Some(1.); self } /// Sets the element to prevent a flex item from shrinking. /// [Docs](https://tailwindcss.com/docs/flex-shrink#dont-shrink) fn flex_shrink_0(mut self) -> Self { self.style().flex_shrink = Some(0.); self } /// Sets the element to allow flex items to wrap. /// [Docs](https://tailwindcss.com/docs/flex-wrap#wrap-normally) fn flex_wrap(mut self) -> Self { self.style().flex_wrap = Some(FlexWrap::Wrap); self } /// Sets the element wrap flex items in the reverse direction. /// [Docs](https://tailwindcss.com/docs/flex-wrap#wrap-reversed) fn flex_wrap_reverse(mut self) -> Self { self.style().flex_wrap = Some(FlexWrap::WrapReverse); self } /// Sets the element to prevent flex items from wrapping, causing inflexible items to overflow the container if necessary. /// [Docs](https://tailwindcss.com/docs/flex-wrap#dont-wrap) fn flex_nowrap(mut self) -> Self { self.style().flex_wrap = Some(FlexWrap::NoWrap); self } /// Sets the element to align flex items to the start of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-items#start) fn items_start(mut self) -> Self { self.style().align_items = Some(AlignItems::FlexStart); self } /// Sets the element to align flex items to the end of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-items#end) fn items_end(mut self) -> Self { self.style().align_items = Some(AlignItems::FlexEnd); self } /// Sets the element to align flex items along the center of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-items#center) fn items_center(mut self) -> Self { self.style().align_items = Some(AlignItems::Center); self } /// Sets the element to align flex items along the baseline of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-items#baseline) fn items_baseline(mut self) -> Self { self.style().align_items = Some(AlignItems::Baseline); self } /// Sets the element to justify flex items against the start of the container's main axis. /// [Docs](https://tailwindcss.com/docs/justify-content#start) fn justify_start(mut self) -> Self { self.style().justify_content = Some(JustifyContent::Start); self } /// Sets the element to justify flex items against the end of the container's main axis. /// [Docs](https://tailwindcss.com/docs/justify-content#end) fn justify_end(mut self) -> Self { self.style().justify_content = Some(JustifyContent::End); self } /// Sets the element to justify flex items along the center of the container's main axis. /// [Docs](https://tailwindcss.com/docs/justify-content#center) fn justify_center(mut self) -> Self { self.style().justify_content = Some(JustifyContent::Center); self } /// Sets the element to justify flex items along the container's main axis /// such that there is an equal amount of space between each item. /// [Docs](https://tailwindcss.com/docs/justify-content#space-between) fn justify_between(mut self) -> Self { self.style().justify_content = Some(JustifyContent::SpaceBetween); self } /// Sets the element to justify items along the container's main axis such /// that there is an equal amount of space on each side of each item. /// [Docs](https://tailwindcss.com/docs/justify-content#space-around) fn justify_around(mut self) -> Self { self.style().justify_content = Some(JustifyContent::SpaceAround); self } /// Sets the element to pack content items in their default position as if no align-content value was set. /// [Docs](https://tailwindcss.com/docs/align-content#normal) fn content_normal(mut self) -> Self { self.style().align_content = None; self } /// Sets the element to pack content items in the center of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-content#center) fn content_center(mut self) -> Self { self.style().align_content = Some(AlignContent::Center); self } /// Sets the element to pack content items against the start of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-content#start) fn content_start(mut self) -> Self { self.style().align_content = Some(AlignContent::FlexStart); self } /// Sets the element to pack content items against the end of the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-content#end) fn content_end(mut self) -> Self { self.style().align_content = Some(AlignContent::FlexEnd); self } /// Sets the element to pack content items along the container's cross axis /// such that there is an equal amount of space between each item. /// [Docs](https://tailwindcss.com/docs/align-content#space-between) fn content_between(mut self) -> Self { self.style().align_content = Some(AlignContent::SpaceBetween); self } /// Sets the element to pack content items along the container's cross axis /// such that there is an equal amount of space on each side of each item. /// [Docs](https://tailwindcss.com/docs/align-content#space-around) fn content_around(mut self) -> Self { self.style().align_content = Some(AlignContent::SpaceAround); self } /// Sets the element to pack content items along the container's cross axis /// such that there is an equal amount of space between each item. /// [Docs](https://tailwindcss.com/docs/align-content#space-evenly) fn content_evenly(mut self) -> Self { self.style().align_content = Some(AlignContent::SpaceEvenly); self } /// Sets the element to allow content items to fill the available space along the container's cross axis. /// [Docs](https://tailwindcss.com/docs/align-content#stretch) fn content_stretch(mut self) -> Self { self.style().align_content = Some(AlignContent::Stretch); self } /// Sets the background color of the element. fn bg(mut self, fill: F) -> Self where F: Into, Self: Sized, { self.style().background = Some(fill.into()); self } /// Returns a mutable reference to the text style that has been configured on this element. fn text_style(&mut self) -> &mut Option { let style: &mut StyleRefinement = self.style(); &mut style.text } /// Sets the text color of this element. /// /// This value cascades to its child elements. fn text_color(mut self, color: impl Into) -> Self { self.text_style().get_or_insert_with(Default::default).color = Some(color.into()); self } /// Sets the font weight of this element /// /// This value cascades to its child elements. fn font_weight(mut self, weight: FontWeight) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_weight = Some(weight); self } /// Sets the background color of this element. /// /// This value cascades to its child elements. fn text_bg(mut self, bg: impl Into) -> Self { self.text_style() .get_or_insert_with(Default::default) .background_color = Some(bg.into()); self } /// Sets the text size of this element. /// /// This value cascades to its child elements. fn text_size(mut self, size: impl Into) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(size.into()); self } /// Sets the text size to 'extra small'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_xs(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(0.75).into()); self } /// Sets the text size to 'small'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_sm(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(0.875).into()); self } /// Sets the text size to 'base'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_base(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(1.0).into()); self } /// Sets the text size to 'large'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_lg(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(1.125).into()); self } /// Sets the text size to 'extra large'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_xl(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(1.25).into()); self } /// Sets the text size to 'extra extra large'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_2xl(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(1.5).into()); self } /// Sets the text size to 'extra extra extra large'. /// [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size) fn text_3xl(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_size = Some(rems(1.875).into()); self } /// Sets the font style of the element to italic. /// [Docs](https://tailwindcss.com/docs/font-style#italicizing-text) fn italic(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_style = Some(FontStyle::Italic); self } /// Sets the font style of the element to normal (not italic). /// [Docs](https://tailwindcss.com/docs/font-style#italicizing-text) fn not_italic(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_style = Some(FontStyle::Normal); self } /// Sets the decoration of the text to have a line through it. /// [Docs](https://tailwindcss.com/docs/text-decoration#setting-the-text-decoration) fn line_through(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); style.strikethrough = Some(StrikethroughStyle { thickness: px(1.), ..Default::default() }); self } /// Removes the text decoration on this element. /// /// This value cascades to its child elements. fn text_decoration_none(mut self) -> Self { self.text_style() .get_or_insert_with(Default::default) .underline = None; self } /// Sets the color for the underline on this element fn text_decoration_color(mut self, color: impl Into) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.color = Some(color.into()); self } /// Sets the text decoration style to a solid line. /// [Docs](https://tailwindcss.com/docs/text-decoration-style) fn text_decoration_solid(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.wavy = false; self } /// Sets the text decoration style to a wavy line. /// [Docs](https://tailwindcss.com/docs/text-decoration-style) fn text_decoration_wavy(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.wavy = true; self } /// Sets the text decoration to be 0px thick. /// [Docs](https://tailwindcss.com/docs/text-decoration-thickness) fn text_decoration_0(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.thickness = px(0.); self } /// Sets the text decoration to be 1px thick. /// [Docs](https://tailwindcss.com/docs/text-decoration-thickness) fn text_decoration_1(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.thickness = px(1.); self } /// Sets the text decoration to be 2px thick. /// [Docs](https://tailwindcss.com/docs/text-decoration-thickness) fn text_decoration_2(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.thickness = px(2.); self } /// Sets the text decoration to be 4px thick. /// [Docs](https://tailwindcss.com/docs/text-decoration-thickness) fn text_decoration_4(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.thickness = px(4.); self } /// Sets the text decoration to be 8px thick. /// [Docs](https://tailwindcss.com/docs/text-decoration-thickness) fn text_decoration_8(mut self) -> Self { let style = self.text_style().get_or_insert_with(Default::default); let underline = style.underline.get_or_insert_with(Default::default); underline.thickness = px(8.); self } /// Sets the font family of this element and its children. fn font_family(mut self, family_name: impl Into) -> Self { self.text_style() .get_or_insert_with(Default::default) .font_family = Some(family_name.into()); self } /// Sets the font of this element and its children. fn font(mut self, font: Font) -> Self { let Font { family, features, fallbacks, weight, style, } = font; let text_style = self.text_style().get_or_insert_with(Default::default); text_style.font_family = Some(family); text_style.font_features = Some(features); text_style.font_weight = Some(weight); text_style.font_style = Some(style); text_style.font_fallbacks = fallbacks; self } /// Sets the line height of this element and its children. fn line_height(mut self, line_height: impl Into) -> Self { self.text_style() .get_or_insert_with(Default::default) .line_height = Some(line_height.into()); self } /// Sets the opacity of this element and its children. fn opacity(mut self, opacity: f32) -> Self { self.style().opacity = Some(opacity); self } /// Draws a debug border around this element. #[cfg(debug_assertions)] fn debug(mut self) -> Self { self.style().debug = Some(true); self } /// Draws a debug border on all conforming elements below this element. #[cfg(debug_assertions)] fn debug_below(mut self) -> Self { self.style().debug_below = Some(true); self } }