https://github.com/line/clay
Clay is an Android library project that provides image trimming which is originally an UI component of LINE Creators Studio
https://github.com/line/clay
android android-library kotlin
Last synced: 12 days ago
JSON representation
Clay is an Android library project that provides image trimming which is originally an UI component of LINE Creators Studio
- Host: GitHub
- URL: https://github.com/line/clay
- Owner: line
- License: apache-2.0
- Created: 2017-09-14T05:15:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-06T06:37:45.000Z (over 2 years ago)
- Last Synced: 2025-06-08T08:07:38.763Z (5 months ago)
- Topics: android, android-library, kotlin
- Language: Kotlin
- Homepage:
- Size: 2.33 MB
- Stars: 122
- Watchers: 13
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-kotlin-android - clay - 图片自由裁剪库🔥 (开源库 / 图片)
README
# Clay
[](https://android-arsenal.com/api?level=16) 
Clay is an Android library project that provides image trimming. Fully written in Kotlin, Clay is originally a UI component of [LINE Creators Studio](https://creator.line.me/en/studio/), a LINE app for creating LINE stickers. You can use Clay with any Android application to trim the outline of an image and create your own custom shape.
* Produce a trimmed image
* Zoom in/out an image
* Undo previous trimming actions
Click [here](https://github.com/line/clay/blob/master/screenshot/example.gif) to see how you can trim an image into a random shape.
## How to build
Use Gradle to build the library. Download it from [JCenter](https://bintray.com/bintray/jcenter) and add configurations in the build.gradle file as follows.
```gradle
allprojects {
repositories {
jcenter()
}
}
dependencies {
implementation "com.linecorp:clayview:0.1.2"
}
```
## Getting started
To get started with Clay, define its view in an XML layout file as follows.
```gradle
```
Then you can use ClayView as follows.
```java
val clayView = findViewById(R.id.clay) as ClayView
clayView.undoSelect() // undo
clayView.getCroppedImage() // get the cropped image
```
You can find a more advanced way of using the library from the [example](https://github.com/line/clay/tree/master/app).
## How to contribute to Clay
See [CONTRIBUTE.md](https://github.com/line/clay/blob/master/CONTRIBUTING.md)
## License
```
Copyright 2017 LINE Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```