Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JakeWharton/butterknife

Bind Android views and callbacks to fields and methods.
https://github.com/JakeWharton/butterknife

Last synced: about 1 month ago
JSON representation

Bind Android views and callbacks to fields and methods.

Awesome Lists containing this project

README 

        
Butter Knife

============



**Attention**: This tool is now deprecated. Please switch to

[view binding](https://developer.android.com/topic/libraries/view-binding).

Existing versions will continue to work, obviously, but only critical bug fixes for integration

with AGP will be considered. Feature development and general bug fixes have stopped.



![Logo](website/static/logo.png)



Field and method binding for Android views which uses annotation processing to generate boilerplate

code for you.



 * Eliminate `findViewById` calls by using `@BindView` on fields.

 * Group multiple views in a list or array. Operate on all of them at once with actions,

   setters, or properties.

 * Eliminate anonymous inner-classes for listeners by annotating methods with `@OnClick` and others.

 * Eliminate resource lookups by using resource annotations on fields.



```java

class ExampleActivity extends Activity {

  @BindView(R.id.user) EditText username;

  @BindView(R.id.pass) EditText password;



  @BindString(R.string.login_error) String loginErrorMessage;



  @OnClick(R.id.submit) void submit() {

    // TODO call server...

  }



  @Override public void onCreate(Bundle savedInstanceState) {

    super.onCreate(savedInstanceState);

    setContentView(R.layout.simple_activity);

    ButterKnife.bind(this);

    // TODO Use fields...

  }

}

```



For documentation and additional information see [the website][3].



__Remember: A butter knife is like a [dagger][1], only infinitely less sharp.__



Download

--------



```groovy

android {

  ...

  // Butterknife requires Java 8.

  compileOptions {

    sourceCompatibility JavaVersion.VERSION_1_8

    targetCompatibility JavaVersion.VERSION_1_8

  }

}



dependencies {

  implementation 'com.jakewharton:butterknife:10.2.3'

  annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.3'

}

```



If you are using Kotlin, replace `annotationProcessor` with `kapt`.



Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



Library projects

--------------------



To use Butter Knife in a library, add the plugin to your `buildscript`:



```groovy

buildscript {

  repositories {

    mavenCentral()

    google()

  }

  dependencies {

    classpath 'com.jakewharton:butterknife-gradle-plugin:10.2.3'

  }

}

```



and then apply it in your module:



```groovy

apply plugin: 'com.android.library'

apply plugin: 'com.jakewharton.butterknife'

```



Now make sure you use `R2` instead of `R` inside all Butter Knife annotations.



```java

class ExampleActivity extends Activity {

  @BindView(R2.id.user) EditText username;

  @BindView(R2.id.pass) EditText password;

...

}

```



License

-------



    Copyright 2013 Jake Wharton



    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.



 [1]: https://dagger.dev/

 [2]: https://search.maven.org/remote_content?g=com.jakewharton&a=butterknife&v=LATEST

 [3]: http://jakewharton.github.com/butterknife/

 [snap]: https://oss.sonatype.org/content/repositories/snapshots/