# TextButton

**Repository Path**: duanhong169/TextButton

## Basic Information

- **Project Name**: TextButton
- **Description**: An easy to use `TextButton` when you need a TextView-like button, with handy touch feedback effects.
- **Primary Language**: Android
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 0
- **Created**: 2018-07-17
- **Last Updated**: 2025-06-25

## Categories & Tags

**Categories**: android-modules

**Tags**: None

## README

# Text Button [![gitHub release](https://img.shields.io/github/release/duanhong169/TextButton.svg?style=social)](https://github.com/duanhong169/TextButton/releases) [![platform](https://img.shields.io/badge/platform-android-brightgreen.svg)](https://developer.android.com/index.html) <a target="_blank" href="https://android-arsenal.com/api?level=14"><img src="https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat"></a> [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-TextButton-green.svg?style=flat)](https://android-arsenal.com/details/1/6998) [![license](https://img.shields.io/badge/license-Apache%202-green.svg)](https://github.com/duanhong169/TextButton/blob/master/LICENSE) [![Build status](https://build.appcenter.ms/v0.1/apps/11265091-9854-4788-9202-8386c553ece6/branches/master/badge)](https://appcenter.ms)

An easy to use `TextButton` when you need a TextView-like button, with handy touch feedback effects.

![screen-record](art/screen-record.gif)

## Gradle

```
dependencies {
    implementation 'com.github.duanhong169:text-button:${latestVersion}'
    ...
}
```

> Replace `${latestVersion}` with the latest version code. See [releases](https://github.com/duanhong169/TextButton/releases).

## Usage

### Use the built-in effects

Config `TextButton` in xml:

```xml
<top.defaults.view.TextButton
    android:id="@+id/button3"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="animateTextColor"
    android:padding="4dp"
    android:textSize="16sp"
    app:defaultTextColor="@android:color/holo_blue_dark"
    app:pressedTextColor="@android:color/holo_orange_dark"
    app:disabledTextColor="@android:color/darker_gray"
    app:underline="true"
    app:effectDuration="200"
    app:textEffect="animateColor"
    app:backgroundEffect="ripple"/>
```

There are 4 text effects: `default`, `animateColor`, `animateSize` and `animateColorAndSize` and 3 background effects: `colorState`, `ripple`, `animateColor` for now.

See [`top_defaults_view_attrs.xml`](./text-button/src/main/res/values/top_defaults_view_attrs.xml) for all supported attributes.

### Implement your own effect

```java
button5.setEffect(new TextButtonEffect() {
    private TextButton textButton;

    @Override
    public void init(TextButton textButton) {
        this.textButton = textButton;
    }

    @Override
    public void actionDown() {
        textButton.setAlpha(0.5f);
    }

    @Override
    public void actionUp() {
        textButton.setAlpha(1);
    }
});
```

For more details, see the sample app.

## License

See the [LICENSE](./LICENSE) file.