Update TextField (#10415)

This PR makes some simple updates to the TextField api and update it's
styling.

Release Notes:

- N/A
This commit is contained in:
Nate Butler 2024-04-11 10:03:36 -04:00 committed by GitHub
parent ea165e134d
commit 837b7111b3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -13,6 +13,7 @@ use ui::*;
#[derive(Debug, Clone, Copy, PartialEq)] #[derive(Debug, Clone, Copy, PartialEq)]
pub enum FieldLabelLayout { pub enum FieldLabelLayout {
Hidden,
Inline, Inline,
Stacked, Stacked,
} }
@ -30,10 +31,8 @@ pub struct TextField {
/// An optional label for the text field. /// An optional label for the text field.
/// ///
/// Its position is determined by the [`FieldLabelLayout`]. /// Its position is determined by the [`FieldLabelLayout`].
label: Option<SharedString>, label: SharedString,
/// The placeholder text for the text field. /// The placeholder text for the text field.
///
/// All text fields must have placeholder text that is displayed when the field is empty.
placeholder: SharedString, placeholder: SharedString,
/// Exposes the underlying [`View<Editor>`] to allow for customizing the editor beyond the provided API. /// Exposes the underlying [`View<Editor>`] to allow for customizing the editor beyond the provided API.
/// ///
@ -44,7 +43,7 @@ pub struct TextField {
/// For example, a magnifying glass icon in a search field. /// For example, a magnifying glass icon in a search field.
start_icon: Option<IconName>, start_icon: Option<IconName>,
/// The layout of the label relative to the text field. /// The layout of the label relative to the text field.
label_layout: FieldLabelLayout, with_label: FieldLabelLayout,
} }
impl FocusableView for TextField { impl FocusableView for TextField {
@ -54,7 +53,11 @@ impl FocusableView for TextField {
} }
impl TextField { impl TextField {
pub fn new(placeholder: impl Into<SharedString>, cx: &mut WindowContext) -> Self { pub fn new(
cx: &mut WindowContext,
label: impl Into<SharedString>,
placeholder: impl Into<SharedString>,
) -> Self {
let placeholder_text = placeholder.into(); let placeholder_text = placeholder.into();
let editor = cx.new_view(|cx| { let editor = cx.new_view(|cx| {
@ -64,31 +67,21 @@ impl TextField {
}); });
Self { Self {
label: None, label: label.into(),
placeholder: placeholder_text, placeholder: placeholder_text,
editor, editor,
start_icon: None, start_icon: None,
label_layout: FieldLabelLayout::Stacked, with_label: FieldLabelLayout::Hidden,
} }
} }
pub fn label(mut self, label: impl Into<SharedString>) -> Self {
self.label = Some(label.into());
self
}
pub fn placeholder(mut self, placeholder: impl Into<SharedString>) -> Self {
self.placeholder = placeholder.into();
self
}
pub fn start_icon(mut self, icon: IconName) -> Self { pub fn start_icon(mut self, icon: IconName) -> Self {
self.start_icon = Some(icon); self.start_icon = Some(icon);
self self
} }
pub fn label_layout(mut self, layout: FieldLabelLayout) -> Self { pub fn with_label(mut self, layout: FieldLabelLayout) -> Self {
self.label_layout = layout; self.with_label = layout;
self self
} }
} }
@ -133,52 +126,43 @@ impl Render for TextField {
..Default::default() ..Default::default()
}; };
let stacked_label: Option<Label> = if self.label_layout == FieldLabelLayout::Stacked {
self.label
.clone()
.map(|label| Label::new(label).size(LabelSize::Small))
} else {
None
};
let inline_label: Option<Label> = if self.label_layout == FieldLabelLayout::Inline {
self.label
.clone()
.map(|label| Label::new(label).size(LabelSize::Small))
} else {
None
};
div() div()
.when_some(stacked_label, |this, label| this.child(label)) .id(self.placeholder.clone())
.group("text-field")
.w_full()
.when(self.with_label == FieldLabelLayout::Stacked, |this| {
this.child(Label::new(self.label.clone()).size(LabelSize::Default))
})
.child( .child(
v_flex() v_flex().w_full().child(
.w_full() h_flex()
.px_2() .w_full()
.py_1() .flex_grow()
.bg(style.background_color) .gap_2()
.text_color(style.text_color) .when(self.with_label == FieldLabelLayout::Inline, |this| {
.rounded_lg() this.child(Label::new(self.label.clone()).size(LabelSize::Default))
.border() })
.border_color(style.border_color) .child(
.w_48() h_flex()
.child( .px_2()
h_flex() .py_1()
.gap_2() .bg(style.background_color)
.when_some(inline_label, |this, label| this.child(label)) .text_color(style.text_color)
.child( .rounded_lg()
h_flex() .border()
.gap_1() .border_color(style.border_color)
.when_some(self.start_icon, |this, icon| { .min_w_48()
this.child( .w_full()
Icon::new(icon) .flex_grow()
.size(IconSize::Small) .gap_1()
.color(Color::Muted), .when_some(self.start_icon, |this, icon| {
) this.child(
}) Icon::new(icon).size(IconSize::Small).color(Color::Muted),
.child(EditorElement::new(&self.editor, editor_style)), )
), })
), .child(EditorElement::new(&self.editor, editor_style)),
),
),
) )
} }
} }