@material/material-color-utilities

v0.3.0

Algorithms and utilities that power the Material Design 3 (M3) color system, including choosing theme colors from images and creating tones of colors; all in a new color space. For more information about how to use this package see README

Latest version published 5 months ago

License: Apache-2.0

NPM

GitHub

Package Health Score

67 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.3.0	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.7	\|	06/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (24,275)

GitHub Stars: 1.7K
Forks: 150
Contributors: 4

Direct Usage Popularity

The npm package @material/material-color-utilities receives a total of 24,275 downloads a week. As such, we scored @material/material-color-utilities popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @material/material-color-utilities, we found that it has been starred 1,696 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @material/material-color-utilities is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 72
Open PR: 12
Last Release: 5 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of @material/material-color-utilities based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @material/material-color-utilities demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 13
Install Size: 758 kB
Dist-tags: 1
# of Files: 126
Maintainers: 1
TS Typings: No

@material/material-color-utilities has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

material-color-utilities

Algorithms and utilities that power the Material Design 3 (M3) color system, including choosing theme colors from images and creating tones of colors; all in a new color space.

See the main README for more information.

Getting started

npm i @material/material-color-utilities or yarn add @material/material-color-utilities

import { Hct } from "@material/material-color-utilities";

// Simple demonstration of HCT.
const color = Hct.fromInt(0xff4285f4);
console.log(`Hue: ${color.hue}`);
console.log(`Chrome: ${color.chroma}`);
console.log(`Tone: ${color.tone}`);

Theming

import { argbFromHex, themeFromSourceColor, applyTheme } from "@material/material-color-utilities";

// Get the theme from a hex color
const theme = themeFromSourceColor(argbFromHex('#f82506'), [
  {
    name: "custom-1",
    value: argbFromHex("#ff0000"),
    blend: true,
  },
]);

// Print out the theme as JSON
console.log(JSON.stringify(theme, null, 2));

// Check if the user has dark mode turned on
const systemDark = window.matchMedia("(prefers-color-scheme: dark)").matches;

// Apply the theme to the body by updating custom properties for material tokens
applyTheme(theme, {target: document.body, dark: systemDark});

Contributing

This repo is not accepting external contributions, but feature requests and bug reports are welcome on GitHub.

@material/material-color-utilities development dependencies

@types/jasmine @types/node jasmine typescript wireit

FAQs

What is @material/material-color-utilities?

Algorithms and utilities that power the Material Design 3 (M3) color system, including choosing theme colors from image... Visit Snyk Advisor to see a full health score report for @material/material-color-utilities, including popularity, security, maintenance & community analysis.

Is @material/material-color-utilities popular?

The npm package @material/material-color-utilities receives a total of 24,275 weekly downloads. As such, @material/material-color-utilities popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @material/material-color-utilities well maintained?

We found indications that @material/material-color-utilities maintenance is sustainable demonstrating some project activity. We saw a total of 4 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @material/material-color-utilities safe to use?

The npm package @material/material-color-utilities was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 15 November-2024, at 00:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP