npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@atomyde/readable-text-color

v1.0.1

Published

Apply dark/bright text color based on the background-color

Downloads

100

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

karavaxkaravax

Keywords

darkbrightcolorcontrastreadabletextblackwhite

Readme

readable-text-color

If the background color of some element that contains text is dynamically chaotic, don't worry, we got you!

This simple and lightweight package applies dark or light color to text based on it's background or the parent's background

It only supports the background-color attribute

Installation

npm i @atomyde/readable-text-color

Usage

Here is a simple example:

import ReadableText from "@atomyde/readable-text-color";

// Choose the best method for you
ReadableText.byId("id")
ReadableText.byClass("class")
ReadableText.byTagName("tagName")
ReadableText.byElement(element)
ReadableText.byElements(elements)

Configuration

The configuration contains the following keys and values (the defaults!):

{
    "threshold": 128,
    "brightColor": "rgba(255, 255, 255, 1)",
    "darkColor": "rgba(0, 0, 0, 1)",
    "topTag": "html"
}
  • threshold [1-255] determines, based on the grey equivalent of the color, the limit to apply wich color
  • brightColor [RGBA/HEX] the bright color to apply on dark backgrounds
  • darkColor [RGBA/HEX] the dark color to apply on light backgrounds
  • topTag [HTMLTag] The upper tag to look for background-color (when it reahces <html> it stops)

You can obtain the configuration with:

ReadableText.getConfig()

You can modify any configuration key with:

ReadableText.setConfig({
    threshold: 182,
    brightColor: "rgba(255, 255, 255, 1)",
})

It is recommended to use the setters of the class instead of ReadableText.setConfig()

// Threshold setter
ReadableText.setThreshold(182)

// Bright color setters
ReadableText.setBrightColor(255, 255, 255, 1)
ReadableText.setBrightColorHex("#FFFFFF", 1)
ReadableText.setBrightColorRGBA("rgba(255, 255, 255, 1)")

// Dark color setters
ReadableText.setDarkColor(0, 0, 0, 1)
ReadableText.setDarkColorHex("#000000", 1)
ReadableText.setDarkColorRGBA("rgba(0, 0, 0, 1)")

// Top tag setter
ReadableText.setTopTag("html")

License

Use it whatever u want for :D

MIT