# RippleEffect

**Repository Path**: HarmonyOS-tpc/RippleEffect

## Basic Information

- **Project Name**: RippleEffect
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2021-04-01
- **Last Updated**: 2023-04-17

## Categories & Tags

**Categories**: harmonyos-animate

**Tags**: None

## README

# Demo

<img src="art/demo.gif" width="40%"/>

# how to user?

```
dependencies{
    implementation 'io.openharmony.tpc.thirdlib:RippleEffect:1.0.1'
}
```

```xml
RippleType = SIMPLE

<com.andexert.library.RippleView
     ohos:height="match_content"
     ohos:width="match_content">
     <Image
          ohos:height="match_content"
          ohos:width="match_content"
          ohos:image_src="$media:icon"/>
</com.andexert.library.RippleView>


RippleType = SIMPLE   isCentered = true;

<com.andexert.library.RippleView
      ohos:height="match_content"
      ohos:width="match_content"
      ripple:rv_centered="true">
      <Image
           ohos:height="match_content"
           ohos:width="match_content"
           ohos:image_src="$media:icon"/>
</com.andexert.library.RippleView>


RippleType = DOUBLE

<com.andexert.library.RippleView
      ohos:height="match_content"
      ohos:width="match_content"
      ripple:rv_type="1">

      <Image
           ohos:height="match_content"
           ohos:width="match_content"
           ohos:image_src="$media:icon"/>
</com.andexert.library.RippleView>


RippleType = RECTANGLE

<com.andexert.library.RippleView
     ohos:padding="10vp"
     ohos:height="match_content"
     ohos:width="match_content"
     ripple:rv_type="2"
     ripple:rv_zoom="true">

     <Image
           ohos:height="100vp"
           ohos:width="200vp"
           ohos:background_element="red"/>
</com.andexert.library.RippleView>
```

# API:

## class:RippleView
**public void animateRipple(TouchEvent event)**
- description: animate ripple with touch event

**public void animateRipple(final float x, final float y)**
- description: animate ripple with the x-coordinate and the y-coordinate

**public void setRippleColor(int rippleColor)**
- description: set ripple color

**public int getRippleColor()**
- description: get ripple color

**public RippleType getRippleType()**
- description: get ripple type

**public void setRippleType**
- description: set ripple type

**public Boolean isCentered()**
- description: is centered mode

**public void setCentered(final Boolean isCentered)**
- description: set centered mode

**public int getRipplePadding()**
- description: get ripple padding

**public void setRipplePadding(int ripplePadding)**
- description: set ripple padding

**public Boolean isZooming()**
- description: child is zoom

**public void setZooming(Boolean hasToZoom)**
- description: set child is zoom

**public float getZoomScale()**
- description: get zoom scale

**public void setZoomScale(float zoomScale)**
- description: set zoom scale

**public int getZoomDuration()**
- description: get zoom duration

**public void setZoomDuration(int zoomDuration)**
- description: set zoom duration

**public int getFrameRate()**
- description: get frame rate

**public void setFrameRate(int frameRate)**
- description: set frame rate

**public float getRippleAlpha()**
- description: get ripple alpha

**public void setRippleAlpha(float rippleAlpha)**
- description: set ripple alpha

**public void setOnRippleCompleteListener(OnRippleCompleteListener listener)**
- description: set ripple complete listener

# AttrSet:

|name|format|description|
|:---:|:---:|:---:|
| rv_color | color | set ripple color
| rv_type | int | set ripple type
| rv_zoom | boolean | has to zoom
| rv_centered | boolean | is centered
| rv_rippleDuration | int | set ripple duration
| rv_alpha | float | set ripple alpha
| rv_ripplePadding | int | set ripple padding
| rv_zoomScale | float | set ripple zoom scale
| rv_zoomDuration | int | set zoome duration