https://github.com/bryanx/cakecutter

🍰 A tiny android annotation library for injecting styled attributes into custom views.
https://github.com/bryanx/cakecutter

android android-annotation-library android-annotation-processor android-annotations android-library kotlin kotlin-android kotlin-library

Last synced: 17 days ago
JSON representation

🍰 A tiny android annotation library for injecting styled attributes into custom views.

• Host: GitHub
• URL: https://github.com/bryanx/cakecutter
• Owner: Bryanx
• License: apache-2.0
• Created: 2020-03-24T17:47:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-06T12:27:52.000Z (over 4 years ago)
• Last Synced: 2023-07-05T15:44:03.086Z (over 1 year ago)
• Topics: android, android-annotation-library, android-annotation-processor, android-annotations, android-library, kotlin, kotlin-android, kotlin-library
• Language: Kotlin
• Homepage:
• Size: 118 KB
• Stars: 45
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🍰 CakeCutter

A tiny annotation library for injecting styled attributes into custom views.

## Example

Traditional way of loading styled attributes:

```kotlin

class CustomView(ctx: Context, attrs: AttributeSet) : FrameLayout(ctx, attrs) {

    var customText: String = ""

    var customNumber: Int = 0

    var customSize: Float = 0F

    init {

        val styledAttrs = ctx.obtainStyledAttributes(attrs, R.styleable.CustomView)

        try {

            customText = styledAttrs.getString(R.styleable.CustomView_customText) ?: customText

            customNumber = styledAttrs.getInt(R.styleable.CustomView_customNumber, customNumber)

            customSize = styledAttrs.getDimension(R.styleable.CustomView_customSize, customSize)

        } finally {

            styledAttrs.recycle()

        }

    }

}

```

With cakecutter:

```kotlin

class CustomView(ctx: Context, internal val attrs: AttributeSet) : FrameLayout(ctx, attrs) {

    @Styleable var customText: String = ""

    @Styleable var customNumber: Float = 0F

    @Styleable var customSize: Int = 0

    init {

        CakeCutter.bind(this)

    }

}

```

The styleables are bound by property name.

Some advantages:

* Default values are assigned once instead of twice.

* Layout/programmatic setters are combined.

* Less boilerplate.

Alternative annotation:

```kotlin

@BindStyleable("customText") var otherTextName: String = ""

```

With this annotation the props can have different names than the styleables.

## Generated code

It works similarly to [Dagger](https://github.com/google/dagger) and [ButterKnife](https://github.com/JakeWharton/butterknife), here is the generated code for above example:

```kotlin

fun bind(view: CustomView) {

  view.context.obtainStyledAttributes(view.attrs, R.styleable.CustomView)

    .apply {

      try {

        view.customText = getBoolean(6, view.customText)

        view.customNumber = getString(R.styleable.CustomView_customNumber) ?: view.customNumber

        view.customSize = getDimension(R.styleable.CustomView_customSize, view.customSize)

      } finally {

        recycle()

      }

  }

}

```

## Install

Add these dependencies in your app's `build.gradle` file:

```groovy

implementation 'nl.bryanderidder.cakecutter:annotations:0.2.1'

kapt 'nl.bryanderidder.cakecutter:compiler:0.2.1'

```

Use `annotationProcessor` instead of `kapt` for Java projects. \

For kotlin projects add this to the top of your `build.gradle` file if it's not added yet:

```groov

apply plugin: "kotlin-kapt"

```

After adding the annotations you have to rebuild the project to load the generated code.

## Note

This project is more of an expirement/study on annotation libraries and [ButterKnife](https://github.com/JakeWharton/butterknife).

At the moment this library does not support these custom attribute types:

* Fraction types

* Multi types







The cake is now ready to be served.

🍰