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

1.0.8 • Public • Published

use-glassmorphism

Installation

npm install use-glassmorphism

or

yarn add use-glassmorphism

Usage

import React from 'react';
import { useGlassmorphism } from 'use-glassmorphism';

const MyComponent = () => {
  const glassRef = useGlassmorphism<HTMLDivElement>({
    color: 'rgba(255, 255, 255)',
    blur: 10,
    transparency: 0.5,
    outline: 0.5,
    animation: {
      duration: 0.5,
      timingFunction: 'ease-in-out',
      delay: 0.1,
    },
  });

  return (
    <div ref={glassRef} style={{ width: '200px', height: '200px', padding: '20px' }}>
      {/* Your content goes here */}
    </div>
  );
};

Options

  • color: The color for the glassmorphic effect. Accepts RGB, RGBA, or hex values.
  • blur: The blur strength for the glassmorphic effect. Should be in the range 0 to 20. Default is 5.
  • transparency: The transparency level for the glassmorphic effect. Should be in the range 0 to 1.
  • outline: The oultine level for the glassmorphic effect. Should be in the range 0 to 1.
  • animation: Animation properties for the glassmorphic effect.
    • duration: The duration of the animation. Default is 0.3 seconds.
    • timingFunction: The timing function for the animation. Default is 'ease'.
    • delay: The delay before the animation starts. Default is 0 seconds.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Readme

Keywords

Package Sidebar

Install

npm i use-glassmorphism

Weekly Downloads

1

Version

1.0.8

License

MIT

Unpacked Size

8.1 kB

Total Files

8

Last publish

Collaborators

  • reim