Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Fbada006/ArtMaker
ArtMaker is a flexible and customisable library that allows users to draw anything they want on screen and has been built fully with Jetpack Compose.
https://github.com/Fbada006/ArtMaker
Last synced: 3 months ago
JSON representation
ArtMaker is a flexible and customisable library that allows users to draw anything they want on screen and has been built fully with Jetpack Compose.
- Host: GitHub
- URL: https://github.com/Fbada006/ArtMaker
- Owner: Fbada006
- Created: 2024-07-22T16:24:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T09:34:07.000Z (3 months ago)
- Last Synced: 2024-08-29T10:52:38.046Z (3 months ago)
- Language: Kotlin
- Homepage:
- Size: 463 KB
- Stars: 27
- Watchers: 1
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - Fbada006/ArtMaker - ArtMaker is a flexible and customisable library that allows users to draw anything they want on screen and has been built fully with Jetpack Compose. (Kotlin)
README
[](https://github.com/Fbada006/ArtMaker/actions/workflows/build.yml)
[](https://androidweekly.net/issues/issue-637)
Flexible and lightweight Drawing Library
ArtMaker is a flexible and customisable library that allows users to draw anything they want on screen and has been built fully with Jetpack Compose. It allows drawing through the `Canvas`, sharing the drawn `Bitmap`, or programmatically exposing the `Bitmap` for use in the calling application.
## Getting started
## Download
[](https://search.maven.org/artifact/io.github.fbada006/artmaker)
### Gradle
Add the dependency below to your **module**'s `build.gradle` file:
```gradle
dependencies {
implementation "io.github.fbada006:artmaker:$latest_version"
}
```
Find latest version and release notes [here](https://github.com/Fbada006/ArtMaker/releases)
## Usage
**ArtMaker** implements canvas, which allows you to draw points with custom properties.
You can use the `ArtMaker` with default configuration as the following example:
```kotlin
ArtMaker(
modifier = Modifier.fillMaxSize(),
)
```
You also have full control of the ArtMaker and choose how you want the control menu composable (the bar below the drawing area) to be
displayed by customizing the `ArtMakerConfiguration` object as shown below:
```kotlin
ArtMaker(
modifier = Modifier.fillMaxSize(),
artMakerConfiguration = ArtMakerConfiguration(
strokeSliderThumbColor = MaterialTheme.colorScheme.primary,
strokeSliderActiveTrackColor = MaterialTheme.colorScheme.onPrimary,
strokeSliderInactiveTickColor = MaterialTheme.colorScheme.inversePrimary,
strokeSliderTextColor = MaterialTheme.colorScheme.secondaryContainer,
pickerCustomColors = listOf(
Color.Red, Color.Blue, Color.Green,
),
canvasBackgroundColor = Color.Green.toArgb(),
controllerBackgroundColor = Color.Cyan,
strokeSliderBackgroundColor = Color.Magenta,
canShareArt = true
)
)
```
If you wish to receive the completed image as a bitmap, you can utilise the `onFinishDrawing: (Bitmap) -> Unit` callback exposed by `ArtMaker` as follows:
```kotlin
ArtMaker(
modifier = Modifier.fillMaxSize(),
onFinishDrawing = { bitmap ->
// Utilise the bitmap here
}
)
```
> **_NOTE:_** The default Jetpack Compose project created by Android Studio has `enableEdgeToEdge()` added in the `onCreate()`. To effectively use the library, please ensure that you remove this line.
## Contribute
Do you see any improvements or want to implement a missing feature? Contributions are very welcome!
- Is your contribution relatively small? You can, make your changes, run the code checks, open a PR
and make sure the CI is green. That's it!
- Are the changes big and do they make a lot of impact? Please open an
issue [here](https://github.com/Fbada006/ArtMaker/issues?q=is%3Aissue) or reach out to [Ferdinand](https://github.com/Fbada006), [Emmanuel](https://github.com/emmanuelmuturia) or [Caleb](https://github.com/CalebKL) and
let's discuss.
- Ensure your change is properly formatted by running the following command from the terminal:
```gradle
./gradlew spotlessApply
```
The CI will fail if the code is not properly formatted. Please correct any failures before requesting a review.
Take into account that changes and requests can be rejected if they don't align with the **purpose
of the library**. To ensure you do not waste any time, you can always open an
issue [here](https://github.com/Fbada006/ArtMaker/issues?q=is%3Aissue) or talk to us before you
start making any changes.
## License
Copyright 2024 ArtMaker, Inc. All Rights Reserved.
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.