catppuccin 2.6.0

🦀 Soothing pastel theme for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

<h3 align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
	Catppuccin for <a href="https://www.rust-lang.org/">Rust</a>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>

<p align="center">
	<a href="https://github.com/catppuccin/rust/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/rust?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
	<a href="https://github.com/catppuccin/rust/issues"><img src="https://img.shields.io/github/issues/catppuccin/rust?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
	<a href="https://github.com/catppuccin/rust/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/rust?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
</p>

<p align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/rust/main/assets/ferris.webp"/>
</p>

## Usage

Add Catppuccin to your project's `Cargo.toml`:

```console
$ cargo add catppuccin
```

## Example

```rust
struct Button {
    text: String,
    background_color: String,
};

fn confirm(text: String) -> Button {
    Button {
        text,
        background_color: catppuccin::PALETTE.mocha.colors.green.hex.to_string(),
    }
}
```

More examples can be found
[here](https://github.com/catppuccin/rust/tree/main/examples).

## Optional Features

### ANSI string painting

Enable the `ansi-term` feature to add the
[`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.
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.
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)

#### Serde

Enable the `serde` feature to enable the serialization of Catppuccin's palette,
flavor, and color types.
This adds [serde](https://crates.io/crates/serde) as a dependency.

Example: [`examples/serde.rs`](https://github.com/catppuccin/rust/blob/main/examples/serde.rs)

## Contributing

This project uses [pre-commit](https://pre-commit.com/) to maintain consistent code style and standards.

See also [CONTRIBUTING.md](https://github.com/catppuccin/catppuccin/blob/main/CONTRIBUTING.md)

## 💝 Thanks to

- [backwardspy](https://github.com/backwardspy)
- [Gingeh](https://github.com/Gingeh)
- [Julius](https://github.com/juliuskreutz)
- [Nyx](https://github.com/nyxkrage)

&nbsp;

<p align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
</p>

<p align="center">
	Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
</p>

<p align="center">
	<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>