From ab2adb11be28a3e44aa77daf41bbf7d86233d4ea Mon Sep 17 00:00:00 2001
From: Michelle Granat <139873465+MichelleGranat@users.noreply.github.com>
Date: Thu, 17 Oct 2024 07:29:31 +0300
Subject: Update button Catalog and Style documentation (#2590)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Update button Catalog and Style documentation

* Clarified button documentation

* fix code typo

* Run `cargo fmt`

* Fixed docs to pass tests

---------

Co-authored-by: Héctor Ramón Jiménez <hector@hecrj.dev>
---
 widget/src/button.rs | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

(limited to 'widget/src/button.rs')

diff --git a/widget/src/button.rs b/widget/src/button.rs
index 552298bb..a3394a01 100644
--- a/widget/src/button.rs
+++ b/widget/src/button.rs
@@ -471,6 +471,9 @@ pub enum Status {
 }
 
 /// The style of a button.
+///
+/// If not specified with [`Button::style`]
+/// the theme will provide the style.
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub struct Style {
     /// The [`Background`] of the button.
@@ -505,6 +508,54 @@ impl Default for Style {
 }
 
 /// The theme catalog of a [`Button`].
+///
+/// All themes that can be used with [`Button`]
+/// must implement this trait.
+///
+/// # Example
+/// ```no_run
+/// # use iced_widget::core::{Color, Background};
+/// # use iced_widget::button::{Catalog, Status, Style};
+/// # struct MyTheme;
+/// #[derive(Debug, Default)]
+/// pub enum ButtonClass {
+///     #[default]
+///     Primary,
+///     Secondary,
+///     Danger
+/// }
+///
+/// impl Catalog for MyTheme {
+///     type Class<'a> = ButtonClass;
+///     
+///     fn default<'a>() -> Self::Class<'a> {
+///         ButtonClass::default()
+///     }
+///     
+///
+///     fn style(&self, class: &Self::Class<'_>, status: Status) -> Style {
+///         let mut style = Style::default();
+///
+///         match class {
+///             ButtonClass::Primary => {
+///                 style.background = Some(Background::Color(Color::from_rgb(0.529, 0.808, 0.921)));
+///             },
+///             ButtonClass::Secondary => {
+///                 style.background = Some(Background::Color(Color::WHITE));
+///             },
+///             ButtonClass::Danger => {
+///                 style.background = Some(Background::Color(Color::from_rgb(0.941, 0.502, 0.502)));
+///             },
+///         }
+///
+///         style
+///     }
+/// }
+/// ```
+///
+/// Although, in order to use [`Button::style`]
+/// with `MyTheme`, [`Catalog::Class`] must implement
+/// `From<StyleFn<'_, MyTheme>>`.
 pub trait Catalog {
     /// The item class of the [`Catalog`].
     type Class<'a>;
-- 
cgit