Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up some ButtonLike doc comments

Browse source
This commit is contained in:
Marshall Bowers 2023-12-01 13:09:35 -05:00
parent be5eb3e3b5
commit f09d9ef723
1 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
crates/ui2/src/components/button/button_like.rs
View file

@ -5,20 +5,23 @@ use crate::h_stack;
use crate::prelude::*; use crate::prelude::*;
pub trait ButtonCommon: Clickable + Disableable { pub trait ButtonCommon: Clickable + Disableable {
/// A unique element id to help identify the button. /// A unique element ID to identify the button.
fn id(&self) -> &ElementId; fn id(&self) -> &ElementId;
/// The visual style of the button. /// The visual style of the button.
/// ///
/// Mosty commonly will be `ButtonStyle::Subtle`, or `ButtonStyle::Filled` /// Mosty commonly will be [`ButtonStyle::Subtle`], or [`ButtonStyle::Filled`]
/// for an emphasized button. /// for an emphasized button.
fn style(self, style: ButtonStyle) -> Self; fn style(self, style: ButtonStyle) -> Self;
/// The size of the button. /// The size of the button.
/// ///
/// Most buttons will use the default size. /// Most buttons will use the default size.
/// ///
/// ButtonSize can also be used to help build non-button elements /// [`ButtonSize`] can also be used to help build non-button elements
/// that are consistently sized with buttons. /// that are consistently sized with buttons.
fn size(self, size: ButtonSize) -> Self; fn size(self, size: ButtonSize) -> Self;
/// The tooltip that shows when a user hovers over the button. /// The tooltip that shows when a user hovers over the button.
/// ///
/// Nearly all interactable elements should have a tooltip. Some example /// Nearly all interactable elements should have a tooltip. Some example
@ -31,15 +34,18 @@ pub enum ButtonStyle {
/// A filled button with a solid background color. Provides emphasis versus /// A filled button with a solid background color. Provides emphasis versus
/// the more common subtle button. /// the more common subtle button.
Filled, Filled,
/// 🚧 Under construction 🚧 /// 🚧 Under construction 🚧
/// ///
/// Used to emphasize a button in some way, like a selected state, or a semantic /// Used to emphasize a button in some way, like a selected state, or a semantic
/// coloring like an error or success button. /// coloring like an error or success button.
Tinted, Tinted,
/// The default button style, used for most buttons. Has a transparent background, /// The default button style, used for most buttons. Has a transparent background,
/// but has a background color to indicate states like hover and active. /// but has a background color to indicate states like hover and active.
#[default] #[default]
Subtle, Subtle,
/// Used for buttons that only change forground color on hover and active states. /// Used for buttons that only change forground color on hover and active states.
/// ///
/// TODO: Better docs for this. /// TODO: Better docs for this.