https://github.com/yogeshpaliyal/speld
PIN View or OTP View for Jetpack compose
https://github.com/yogeshpaliyal/speld
android compose-android hacktoberfest jetpack-compose kotlin otp-view pin-view
Last synced: about 1 year ago
JSON representation
PIN View or OTP View for Jetpack compose
- Host: GitHub
- URL: https://github.com/yogeshpaliyal/speld
- Owner: yogeshpaliyal
- License: apache-2.0
- Created: 2022-01-30T12:44:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-30T13:25:25.000Z (over 1 year ago)
- Last Synced: 2025-02-27T03:47:58.228Z (over 1 year ago)
- Topics: android, compose-android, hacktoberfest, jetpack-compose, kotlin, otp-view, pin-view
- Language: Kotlin
- Homepage: https://github.yogeshpaliyal.com/Speld/
- Size: 296 KB
- Stars: 40
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SPELD
> Android Compose OTP/PIN View
## Implementation
```groovy
implementation 'com.yogeshpaliyal:speld:1.0.1'
```
### Default / Solid Pin View
```kotlin
val text = remember { mutableStateOf("") }
PinInput(value = text.value, obscureText = null) {
text.value = it
}
```
### Bordered Pin View
```kotlin
val text = remember { mutableStateOf("") }
PinInput(
cellModifier = Modifier.border(
BorderStroke(2.dp, Color.Red),
shape = RoundedCornerShape(3.dp)
), value = text.value,
obscureText = "*",
length = 6,
disableKeypad = false // Optional
) {
text.value = it
}
```
## ✍️ Author
👤 **Yogesh Choudhary Paliyal**
* Twitter: @yogeshpaliyal
* Email: yogeshpaliyal.foss@gmail.com
Feel free to ping me 😉
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any
contributions you make are **greatly appreciated**.
1. Open an issue first to discuss what you would like to change.
1. Fork the Project
1. Create your feature branch (`git checkout -b feature/amazing-feature`)
1. Commit your changes (`git commit -m 'Add some amazing feature'`)
1. Push to the branch (`git push origin feature/amazing-feature`)
1. Open a pull request
Please make sure to update tests as appropriate.
## ❤ Show your support
Give a ⭐️ if this project helped you!
## ☑️ TODO
- [x] Solid PIN View
- [x] Bordered PIN View
## 📝 License
```
Copyright © 2023 - Yogesh Choudhary Paliyal
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.
```
_This README was generated by [readgen](https://github.com/theapache64/readgen)_ ❤