gleam_community_colour - v1.4.1

gleam_community/colour/accessibility

This package was heavily inspired by the elm-color-extra module. The original source code can be found here.

The license of that package is produced below:

MIT License

Copyright (c) 2016 Andreas Köberle

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Functions

contrast_ratio

</> 
pub fn contrast_ratio(
  between colour_a: Colour,
  and colour_b: Colour,
) -> Float

Returns the contrast between two Colour values as a Float between 1.0, and 21.0 with 1.0 being no contrast and, 21.0 being the highest possible contrast.

Example: 
fn example() {
  contrast_ratio(between: colour.white, and: colour.black) // 21.0
}

luminance

</> 
pub fn luminance(colour: Colour) -> Float

Returns the relative brightness of the given Colour as a Float between 0.0, and 1.0 with 0.0 being the darkest possible colour and 1.0 being the lightest.

Example: 
fn example() {
  luminance(colour.white) // 1.0
}

maximum_contrast

</> 
pub fn maximum_contrast(
  base: Colour,
  colours: List(Colour),
) -> Result(Colour, Nil)

Returns the Colour with the highest contrast between the base Colour, and and the other provided Colour values.

Example: 
fn example() {
  maximum_contrast(
   colour.yellow,
   [colour.white, colour.dark_blue, colour.green],
 )
}
✨ Search Document