named-colour

Crates.ionamed-colour
lib.rsnamed-colour
version0.3.7
sourcesrc
created_at2021-09-29 17:22:47.15013
updated_at2024-12-07 08:25:36.346688
descriptionnamed-colour provides Hex Codes for popular colour names.
homepage
repositoryhttps://github.com/jerus-org/named-colour
max_upload_size
id458222
size152,485
Jeremiah Russell (jerusdp)

documentation

https://docs.rs/named-colour

README

Rust library named-colour

Crates.io MIT licensed Build Status Rust 1.46+ FOSSA Status Docs BuyMeaCoffee GitHubSponsors

The rust library named-colour provides a convenient set of named colours and the Hex Code for each colour.

Installation

To use named-colour in your project you can add the following to your Cargo.toml:

[dependencies]
named-colour = "0.3.7"

Usage

Provides Hex Codes for colours:

  • enums that return a hex code string for named colours
  • rgb colour struct to configure a colour an rgb colour and display as decimal or hex

Examples

Use Basic colour

use named_colour::Basic;
println!("The colour Hex Code is: {} for the RGB colour Aqua: {}",
    Basic::Aqua,
    Basic::Aqua.as_rgb()
);

Use Extended colour

Enable the feature in the toml file:

[dependencies]
named-colour = { version = "0.3.7", features = ["extended"]}
use named_colour::ext::Indigo;
println!("The colour Hex Code is: {} for the RGB colour Dark Orchid: {}",
    Indigo::DarkOrchid,
    Indigo::DarkOrchid.as_rgb()
);

Create a custom colour

use named_colour::ColourRgb;
let my_colour =ColourRgb::new(12,24,48);
println!("The Hex Code is: {} for my_colour: {}",
    my_colour.as_hex(),
    my_colour.to_string()
);

Features

  • Basic contains just 16 colours with 18 names (default)
  • Extended contains a fuller set of colours divided in 11 collections

To use the extended colour set only configure toml with no-default features

[dependencies]
named-colour = { version = "0.3.7", default_features = false, features = ["extended"]}

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 308

cargo fmt