Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Discuss] isColorDark documentation #2945

Closed
elizabetdev opened this issue Feb 28, 2020 · 5 comments
Closed

[Discuss] isColorDark documentation #2945

elizabetdev opened this issue Feb 28, 2020 · 5 comments
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@elizabetdev
Copy link
Contributor

Yesterday, while using the EUI utility isColorDark I had to transform hex colors to rbg because this utility only accepts rgb.

I created my own function and then I realized that EUI has an hexToRgb utility and even other color utilities. I believe they are not documented. I found them searching through the codebase.

  1. Should we improve the isColorDark docs section with more examples? With one that uses the EUI hexToRgb function?

  2. Or should we have a color section under utilities where isColorDark would be included among other color utilities?

@elizabetdev elizabetdev added documentation Issues or PRs that only affect documentation - will not need changelog entries discussion labels Feb 28, 2020
@cchaos
Copy link
Contributor

cchaos commented Feb 28, 2020

Is this in JS or SASS?

@snide
Copy link
Contributor

snide commented Feb 28, 2020

Think the JS. They are essentially part of our services folder. We could document them, but my guess is that with our moves towards Chroma or Polished, we'll end up deprecating these functions. I know @thompsongl was thinking along these lines somewhere (can't find the issue)

@elizabetdev
Copy link
Contributor Author

I should have included the link 😊:
https://elastic.github.io/eui/#/utilities/is-color-dark

@thompsongl
Copy link
Contributor

my guess is that with our moves towards Chroma or Polished, we'll end up deprecating these functions

Right, #2804 gets at this. I think all new color manipulation should use chroma-js, and we're already fairly close to being able to remove the custom utilities

@snide
Copy link
Contributor

snide commented Mar 2, 2020

OK. Gonna close this out then, thinking that having these somewhat hidden for the moment makes sense.

@snide snide closed this as completed Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

No branches or pull requests

4 participants