use-css-variables
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

useCSSVariables

useCSSVariables is a React custom hook designed to easily fetch and list all CSS custom properties (variables) applied to a specified element.

The useCSSVariables hook accepts a selector as parameter: A string that specifies the CSS selector of the element you want to inspect.

Usage

const { element, variables, error } = useCSSVariables(":root") 

It returns an object with the following properties:

  • element: string - The CSS selector used.
  • variables: Array<{ name: string; value: string }> - A list of CSS variables applied to the element.
  • error: string | null - Error message if the element is not found or any other error occurs.

License

This project, developed by Peter R. Stuhlmann, is licensed under the MIT License.

Readme

Keywords

Package Sidebar

Install

npm i use-css-variables

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

5.22 kB

Total Files

5

Last publish

Collaborators

  • peter-stuhlmann