https://github.com/st235/samuraiview
Simple showcase library. Made Samurai great again! ⚔️
https://github.com/st235/samuraiview
Last synced: over 1 year ago
JSON representation
Simple showcase library. Made Samurai great again! ⚔️
- Host: GitHub
- URL: https://github.com/st235/samuraiview
- Owner: st235
- License: mit
- Created: 2019-05-28T13:26:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-06T07:39:34.000Z (over 5 years ago)
- Last Synced: 2025-04-12T06:43:49.363Z (over 1 year ago)
- Language: Kotlin
- Homepage:
- Size: 3.99 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SamuraiView
[](https://maven-badges.herokuapp.com/maven-central/com.github.st235/samuraiview)
Simple showcase library. Made Samurai great again! ⚔️
## Download
__Important: library was migrated from JCenter to MavenCentral__
It means that it may be necessary to add __mavenCentral__ repository to your repositories list
```groovy
allprojects {
repositories {
// your repositories
mavenCentral()
}
}
```
- Maven
```text
com.github.st235
samuraiview
X.X
pom
```
- Gradle
```text
implementation 'com.github.st235:samuraiview:X.X'
```
- Ivy
```text
```
## Usage
First of all, you should declare your SamuraiView at xml file
```xml
```
Yeap, forget to say: SamuraiView is a viewgroup, so you may add children to it directly in xml
Then to highlight some views just `capture` it!
```kotlin
Harakiri(into = samuraiView)
.circle()
.overlayColorRes(R.color.colorWhite95)
.frameColorRes(R.color.colorPrimaryDark)
.frameThickness(2F)
.margins(20, 20, 20, 20)
.withTooltip(R.layout.tooltip_share, width = ViewGroup.LayoutParams.MATCH_PARENT)
.capture(toolbar.findViewById(R.id.action_share))
```
## Screens
### Licenses
Photos were taken from [unsplash](https://unsplash.com/)
```text
MIT License
Copyright (c) 2019 Alexander Dadukin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```