@enumura/liquidui-animation
v0.1.67
Published
liquidui-animation UI is available as a component in this package.
Downloads
3
Readme
liquidui-animation
This liquidui-animation Component makes it easy to create a shaking UI React application.
With the liquidui-animation Component, you can implement UI elements with Liquid-like shaking animation in a short time.
Demo
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<main>
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgColor={"#FFE2FF"}
animationIntensity={"middle"}
liquidDuration={10}
rotateDuration={0}
blurIntensity={10}
></LiquidUI>
<LiquidUI
figureShape={"square"}
size={"middle"}
bgColor={"linear-gradient(90deg, #fbd5fb, #95e9f3"}
animationIntensity={"strong"}
liquidDuration={10}
rotateDuration={0}
></LiquidUI>
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgColor={"linear-gradient(90deg, #C3F1FF, #0072ff)"}
animationIntensity={"strong"}
liquidDuration={12}
rotateDuration={1000}
></LiquidUI>
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgImg={"assets/sampleImg.webp"}
animationIntensity={"strong"}
liquidDuration={12}
blurIntensity={0}
></LiquidUI>
</main>
);
};
export default App;
Advantages
- Customizability:The liquidui-animation Component allows customization of various parameters such as shape, size, and animation intensity.
Installation
npm i @enumura/liquidui-animation
Example
1. Example of rotation
This is a sample of a rotating liquid UI.
Decreasing the value of the rotateDuration
property speeds up the rotation and increasing the value slows it down.
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgColor={"linear-gradient(90deg, #C3F1FF, #0072ff)"}
animationIntensity={"strong"}
liquidDuration={12}
rotateDuration={10}
></LiquidUI>
);
};
2. Example of animation speed adjustment
This is an example of adjusting the liquidDuration
property to change how fast the UI moves.
Lowering the value makes the UI move faster, and raising the value makes the UI move slower.
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<>
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgColor={"blue"}
animationIntensity={"strong"}
liquidDuration={1}
rotateDuration={30}
></LiquidUI>
</>
);
};
3. Example of displaying image
This is a sample of liquid UI including images.
Specify the path of the image for the bgImg
property.
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgImg={"assets/sampleImg.webp"}
animationIntensity={"strong"}
liquidDuration={12}
blurIntensity={0}
></LiquidUI>
);
};
4. Example with blur
This is a sample of liquid UI with blurring.
Increasing the value of the blurIntensity
property increases the blur intensity.
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<LiquidUI
figureShape={"circle"}
size={"middle"}
bgColor={"#FFE2FF"}
animationIntensity={"middle"}
liquidDuration={10}
blurIntensity={10}
></LiquidUI>
);
};
5. Example of liquidui-animation component with custom size
This is an example of a case where you want to specify a custom UI size.
Specify an arbitrary value for the size
property in object format such as {width: 'XXXpx', height: '○○○px'}
.
import LiquidUI from "@enumura/liquidui-animation";
const App = () => {
return (
<LiquidUI
figureShape={"circle"}
size={{ width: "100px", height: "100px" }}
bgImg={"assets/sampleImg.webp"}
animationIntensity={"strong"}
liquidDuration={12}
blurIntensity={0}
></LiquidUI>
);
};
Properties
| Property | Type | Description | | ---------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | figureShape | string | Specifies the shape of the UI. Supported values are 'circle' and 'square'. | | size | string, object | Specifies the size of the UI. Specify 'small', 'middle', or 'large' as a string, or specify an object in the form {width: 'XXXpx', height: '○○○px'}. | | bgColor | string | Specifies the background color of the UI. Specify CSS color names, color codes, gradients, etc. | | bgImg | string | Specifies the background image of the UI. should be a valid path to an image file located in the 'public/assets' directory. | | liquidDuration | number | Specifies the background color of the UI; can be a CSS color code or a gradient. | | liquidDuration | number | Specifies the time in milliseconds that a set of animations assigned to the UI will run. | | animationIntensity | string | Specifies the animation intensity. Supported values are 'small', 'middle', and 'strong'. | | rotateDuration | number | Specifies the time in milliseconds per rotation when the UI rotates. | | blurIntensity | number | Specifies the intensity of the blur applied to the UI; a value greater than 0 will blur the UI. |
Contributors
Tags
react
UI
Animation
License
MIT license. See the LICENSE file for details.