Skip to content
Android library that generates app shortcuts from Shortcut annotations
Branch: master
Clone or download
MatthiasRobbers Merge pull request #18 from MatthiasRobbers/mr/fix_method_shortcuts_c…
…alled_before_on_create

Fix #13 Method annotations don't work
Latest commit a3f99c9 Sep 24, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper Update gradle and wrapper Mar 15, 2017
sample Fix #13 Method annotations don't work Sep 24, 2017
shortbread-annotations Add more unit tests and javadoc Feb 28, 2017
shortbread-compiler
shortbread Fix #13 Method annotations don't work Sep 24, 2017
.gitignore initial commit Feb 11, 2017
LICENSE.txt initial commit Feb 11, 2017
README.md Fix #13 Method annotations don't work Sep 24, 2017
bintray.gradle initial commit Feb 11, 2017
build.gradle Fix #13 Method annotations don't work Sep 24, 2017
gradle.properties Add more unit tests and javadoc Feb 28, 2017
gradlew Update gradle and wrapper Mar 15, 2017
gradlew.bat Update gradle and wrapper Mar 15, 2017
install.gradle initial commit Feb 11, 2017
sample.png initial commit Feb 11, 2017
settings.gradle initial commit Feb 11, 2017

README.md

Shortbread

Android library that generates app shortcuts for activities and methods annotated with @Shortcut. No need to touch the manifest, create XML files or use the shortcut manager. Just annotate the code that you want the shortcut to call.

Sample

The four shortcuts above are produced by the following code:

@Shortcut(id = "movies", icon = R.drawable.ic_shortcut_movies, shortLabel = "Movies")
public class MoviesActivity extends Activity {

    // ...
    
    @Shortcut(id = "add_movie", icon = R.drawable.ic_shortcut_add, shortLabel = "Add movie")
    public void addMovie() {
        // code to add movie, could show an AddMovieDialogFragment for example 
    }
}
@Shortcut(id = "books", icon = R.drawable.ic_shortcut_books, shortLabel = "Books")
public class BooksActivity extends Activity {

    // ...
    
    @Shortcut(id = "favorite_books", icon = R.drawable.ic_shortcut_favorite, shortLabel = "Favorite books")
    public void showFavoriteBooks() {
        // code to display favorite books, could show a FavoriteBooksFragment for example 
    }
}

To display the shortcuts, call Shortbread.create(Context context) as early as possible in the app, for example in onCreate of a custom Application.

public class App extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        Shortbread.create(this);
    }
}

Shortcuts can be customized with attributes, just like using the framework API.

@Shortcut(
    id = "books", 
    icon = R.drawable.ic_shortcut_books, 
    shortLabel = "Books",
    shortLabelRes = R.string.shortcut_books_short_label,
    longLabel = "List of books",
    longLabelRes = R.string.shortcut_books_long_label,
    rank = 2, // order in list, relative to other shortcuts
    disabledMessage = "No books are available",
    disabledMessageRes = R.string.shortcut_books_disabled_message,
    enabled = true, // default
    backStack = {MainActivity.class, LibraryActivity.class},
    activity = MainActivity.class, // the launcher activity to which the shortcut should be attached
    action = "shortcut_books" // intent action to identify the shortcut from the launched activity
)
public class BooksActivity extends Activity { /*...*/ }

Download

dependencies {
    compile 'com.github.matthiasrobbers:shortbread:1.0.2'
    annotationProcessor 'com.github.matthiasrobbers:shortbread-compiler:1.0.2'
}

License

Copyright 2017 Matthias Robbers

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.
You can’t perform that action at this time.