feat: add iced feature

Author: backwardspy

.github/workflows/build.yml

@@ -46,4 +46,5 @@ jobs:
         with:
           toolchain: stable
           components: rustfmt
+      - uses: Swatinem/rust-cache@v2
       - run: cargo fmt --all --check

.github/workflows/release-plz.yml

@@ -23,6 +23,7 @@ jobs:
           fetch-depth: 0
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
       - name: Run release-plz
         uses: release-plz/[email protected]
         with:
@@ -48,6 +49,7 @@ jobs:
           fetch-depth: 0
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
       - name: Run release-plz
         uses: release-plz/[email protected]
         with:

Cargo.toml

@@ -23,6 +23,7 @@ clippy.nursery = "warn"
 ansi_term = { version = "0.12", optional = true }
 bevy = { version = "0.17", optional = true }
 css-colors = { version = "1.0", optional = true }
+iced = { version = "0.13.1", optional = true }
 ratatui = { version = "0.29", optional = true }
 serde = { version = "1.0", features = ["derive"], optional = true }
 
@@ -41,10 +42,11 @@ serde_json = "1.0.145"
 
 [features]
 ansi-term = ["dep:ansi_term"]
+bevy = ["dep:bevy"]
 css-colors = ["dep:css-colors"]
+iced = ["dep:iced"]
 ratatui = ["dep:ratatui"]
 serde = ["dep:serde"]
-bevy = ["dep:bevy"]
 
 [[example]]
 name = "css"

README.md

@@ -47,23 +47,39 @@ More examples can be found
 ### ANSI string painting
 
 Enable the `ansi-term` feature to add the
-`Color::ansi_paint` method.
+[`Color::ansi_paint`](Color::ansi_paint) method.
 This adds [ansi-term](https://crates.io/crates/ansi_term) as a dependency.
 
 Example: [`examples/term_grid.rs`](https://github.com/catppuccin/rust/blob/main/examples/term_grid.rs)
 
+#### Bevy
+
+Enable the `bevy` feature to enable the conversion of Catppuccin colors to
+[`bevy::prelude::Color`] instances.
+This adds [bevy](https://crates.io/crates/bevy) as a dependency.
+
+Example: [`examples/bevy.rs`](https://github.com/catppuccin/rust/blob/main/examples/bevy.rs)
+
 #### CSS colors
 
 Enable the `css-colors` feature to enable the conversion of Catppuccin colors to
-`css_colors::RGB` instances.
+[`css_colors::RGB`] instances.
 This adds [css-colors](https://crates.io/crates/css-colors) as a dependency.
 
 Example: [`examples/css.rs`](https://github.com/catppuccin/rust/blob/main/examples/css.rs)
 
+#### Iced
+
+Enable the `iced` feature to enable the conversion of Catppuccin colors to
+[`iced::Color`] instances.
+This adds [iced](https://crates.io/crates/iced) as a dependency.
+
+Example: [`examples/iced.rs`](https://github.com/catppuccin/rust/blob/main/examples/iced.rs)
+
 #### Ratatui
 
 Enable the `ratatui` feature to enable the conversion of Catppuccin colors to
-`ratatui::style::Color` instances.
+[`ratatui::style::Color`] instances.
 This adds [ratatui](https://crates.io/crates/ratatui) as a dependency.
 
 Example: [`examples/ratatui.rs`](https://github.com/catppuccin/rust/blob/main/examples/ratatui.rs)

examples/iced.rs

@@ -0,0 +1,77 @@
+//! Example demonstrating integration with the `iced` crate.
+use iced::{
+    application,
+    daemon::Appearance,
+    widget::{button, column, container, text},
+    Alignment::Center,
+    Element,
+    Length::Fill,
+    Result,
+};
+
+const COLORS: catppuccin::FlavorColors = catppuccin::PALETTE.latte.colors;
+
+#[derive(Default)]
+struct Counter {
+    value: i64,
+}
+
+#[derive(Clone, Copy, Debug)]
+enum Message {
+    Increment,
+    Decrement,
+}
+
+impl Counter {
+    const fn update(&mut self, message: Message) {
+        match message {
+            Message::Increment => {
+                self.value += 1;
+            }
+            Message::Decrement => {
+                self.value -= 1;
+            }
+        }
+    }
+
+    fn view(&self) -> Element<'_, Message> {
+        let green: iced::Color = COLORS.green.into();
+        let red: iced::Color = COLORS.red.into();
+        container(
+            column![
+                button(text("+").size(50).center())
+                    .style(move |_, _| button::Style {
+                        background: Some(green.into()),
+                        text_color: COLORS.crust.into(),
+                        ..Default::default()
+                    })
+                    .width(60)
+                    .on_press(Message::Increment),
+                text(self.value).size(50),
+                button(text("-").size(50).center())
+                    .style(move |_, _| button::Style {
+                        background: Some(red.into()),
+                        text_color: COLORS.crust.into(),
+                        ..Default::default()
+                    })
+                    .width(60)
+                    .on_press(Message::Decrement),
+            ]
+            .align_x(Center)
+            .spacing(10),
+        )
+        .padding(20)
+        .center_x(Fill)
+        .center_y(Fill)
+        .into()
+    }
+}
+
+fn main() -> Result {
+    application("Counter", Counter::update, Counter::view)
+        .style(move |_, _| Appearance {
+            background_color: COLORS.base.into(),
+            text_color: COLORS.text.into(),
+        })
+        .run()
+}

src/lib.rs

@@ -37,6 +37,14 @@
 //!
 //! Example: [`examples/term_grid.rs`](https://github.com/catppuccin/rust/blob/main/examples/term_grid.rs)
 //!
+//! ### Bevy
+//!
+//! Enable the `bevy` feature to enable the conversion of Catppuccin colors to
+//! [`bevy::prelude::Color`] instances.
+//! This adds [bevy](https://crates.io/crates/bevy) as a dependency.
+//!
+//! Example: [`examples/bevy.rs`](https://github.com/catppuccin/rust/blob/main/examples/bevy.rs)
+//!
 //! ### CSS colors
 //!
 //! Enable the `css-colors` feature to enable the conversion of Catppuccin colors to
@@ -45,6 +53,14 @@
 //!
 //! Example: [`examples/css.rs`](https://github.com/catppuccin/rust/blob/main/examples/css.rs)
 //!
+//! ### Iced
+//!
+//! Enable the `iced` feature to enable the conversion of Catppuccin colors to
+//! [`iced::Color`] instances.
+//! This adds [iced](https://crates.io/crates/iced) as a dependency.
+//!
+//! Example: [`examples/iced.rs`](https://github.com/catppuccin/rust/blob/main/examples/iced.rs)
+//!
 //! ### Ratatui
 //!
 //! Enable the `ratatui` feature to enable the conversion of Catppuccin colors to
@@ -53,14 +69,6 @@
 //!
 //! Example: [`examples/ratatui.rs`](https://github.com/catppuccin/rust/blob/main/examples/ratatui.rs)
 //!
-//! ### Bevy
-//!
-//! Enable the `bevy` feature to enable the conversion of Catppuccin colors to
-//! [`bevy::prelude::Color`] instances.
-//! This adds [bevy](https://crates.io/crates/bevy) as a dependency.
-//!
-//! Example: [`examples/bevy.rs`](https://github.com/catppuccin/rust/blob/main/examples/bevy.rs)
-//!
 //! ### Serde
 //!
 //! Enable the `serde` feature to enable the serialization of Catppuccin's palette,
@@ -559,6 +567,58 @@ impl From<(f64, f64, f64)> for Hsl {
     }
 }
 
+#[cfg(feature = "ansi-term")]
+mod ansi_term {
+    use crate::{AnsiColor, Color};
+
+    impl Color {
+        /// Paints the given input with a color à la [ansi_term](https://docs.rs/ansi_term/latest/ansi_term/)
+        pub fn ansi_paint<'a, I, S: 'a + ToOwned + ?Sized>(
+            &self,
+            input: I,
+        ) -> ansi_term::ANSIGenericString<'a, S>
+        where
+            I: Into<std::borrow::Cow<'a, S>>,
+            <S as ToOwned>::Owned: core::fmt::Debug,
+        {
+            ansi_term::Color::RGB(self.rgb.r, self.rgb.g, self.rgb.b).paint(input)
+        }
+    }
+
+    impl AnsiColor {
+        /// Paints the given input with a color à la [ansi_term](https://docs.rs/ansi_term/latest/ansi_term/)
+        pub fn ansi_paint<'a, I, S: 'a + ToOwned + ?Sized>(
+            &self,
+            input: I,
+        ) -> ansi_term::ANSIGenericString<'a, S>
+        where
+            I: Into<std::borrow::Cow<'a, S>>,
+            <S as ToOwned>::Owned: core::fmt::Debug,
+        {
+            ansi_term::Color::RGB(self.rgb.r, self.rgb.g, self.rgb.b).paint(input)
+        }
+    }
+}
+
+#[cfg(feature = "bevy")]
+mod bevy {
+    use crate::{AnsiColor, Color};
+
+    impl From<Color> for bevy::prelude::Color {
+        fn from(value: Color) -> Self {
+            #[allow(clippy::cast_possible_truncation)]
+            Self::hsl(value.hsl.h as f32, value.hsl.s as f32, value.hsl.l as f32)
+        }
+    }
+
+    impl From<AnsiColor> for bevy::prelude::Color {
+        fn from(value: AnsiColor) -> Self {
+            #[allow(clippy::cast_possible_truncation)]
+            Self::hsl(value.hsl.h as f32, value.hsl.s as f32, value.hsl.l as f32)
+        }
+    }
+}
+
 #[cfg(feature = "css-colors")]
 mod css_colors {
     use crate::{AnsiColor, Color};
@@ -606,35 +666,19 @@ mod css_colors {
     }
 }
 
-#[cfg(feature = "ansi-term")]
-mod ansi_term {
+#[cfg(feature = "iced")]
+mod iced {
     use crate::{AnsiColor, Color};
 
-    impl Color {
-        /// Paints the given input with a color à la [ansi_term](https://docs.rs/ansi_term/latest/ansi_term/)
-        pub fn ansi_paint<'a, I, S: 'a + ToOwned + ?Sized>(
-            &self,
-            input: I,
-        ) -> ansi_term::ANSIGenericString<'a, S>
-        where
-            I: Into<std::borrow::Cow<'a, S>>,
-            <S as ToOwned>::Owned: core::fmt::Debug,
-        {
-            ansi_term::Color::RGB(self.rgb.r, self.rgb.g, self.rgb.b).paint(input)
+    impl From<Color> for iced::Color {
+        fn from(value: Color) -> Self {
+            Self::from_rgb8(value.rgb.r, value.rgb.g, value.rgb.b)
         }
     }
 
-    impl AnsiColor {
-        /// Paints the given input with a color à la [ansi_term](https://docs.rs/ansi_term/latest/ansi_term/)
-        pub fn ansi_paint<'a, I, S: 'a + ToOwned + ?Sized>(
-            &self,
-            input: I,
-        ) -> ansi_term::ANSIGenericString<'a, S>
-        where
-            I: Into<std::borrow::Cow<'a, S>>,
-            <S as ToOwned>::Owned: core::fmt::Debug,
-        {
-            ansi_term::Color::RGB(self.rgb.r, self.rgb.g, self.rgb.b).paint(input)
+    impl From<AnsiColor> for iced::Color {
+        fn from(value: AnsiColor) -> Self {
+            Self::from_rgb8(value.rgb.r, value.rgb.g, value.rgb.b)
         }
     }
 }
@@ -655,20 +699,3 @@ mod ratatui {
         }
     }
 }
-
-#[cfg(feature = "bevy")]
-mod bevy {
-    use crate::{AnsiColor, Color};
-
-    impl From<Color> for bevy::prelude::Color {
-        fn from(value: Color) -> Self {
-            Self::hsl(value.hsl.h as f32, value.hsl.s as f32, value.hsl.l as f32)
-        }
-    }
-
-    impl From<AnsiColor> for bevy::prelude::Color {
-        fn from(value: AnsiColor) -> Self {
-            Self::hsl(value.hsl.h as f32, value.hsl.s as f32, value.hsl.l as f32)
-        }
-    }
-}