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.
The four shortcuts above are produced by the following code:
@Shortcut(id = "movies", icon = R.drawable.ic_shortcut_movies, shortLabel = "Movies")
class MoviesActivity : Activity() {
// ...
@Shortcut(id = "add_movie", icon = R.drawable.ic_shortcut_add, shortLabel = "Add movie")
fun addMovie() {
// could show an AddMovieDialogFragment for example
}
}
@Shortcut(id = "books", icon = R.drawable.ic_shortcut_books, shortLabel = "Books")
class BooksActivity : Activity() {
// ...
@Shortcut(id = "favorite_books", icon = R.drawable.ic_shortcut_favorite, shortLabel = "Favorite books")
fun showFavoriteBooks() {
// 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.
class App : Application() {
override fun onCreate() {
super.onCreate()
Shortbread.create(this)
}
}
Shortcuts can be customized with attributes, just like using the framework API.
Kotlin
@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, MainActivity::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
)
Java
@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
)
Download
Shortbread is available on mavenCentral().
Kotlin
apply plugin: 'kotlin-kapt'
dependencies {
implementation 'com.github.matthiasrobbers:shortbread:1.2.0'
kapt 'com.github.matthiasrobbers:shortbread-compiler:1.2.0'
}
Java
dependencies {
implementation 'com.github.matthiasrobbers:shortbread:1.2.0'
annotationProcessor 'com.github.matthiasrobbers:shortbread-compiler:1.2.0'
}
Non-final resource IDs
If you are using resource IDs in @Shortcut attributes auch as shortLabelRes, which is recommended, you may see this warning in Android Studio:
Resource IDs will be non-final in Android Gradle Plugin version 5.0, avoid using them as annotation attributes.
If the annotation is located inside a library, the project won't even compile. To overcome this, add the Shortbread Gradle plugin and apply it to your modules:
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.github.matthiasrobbers:shortbread-gradle-plugin:1.2.0'
}
}
apply plugin: 'com.github.matthiasrobbers.shortbread'
Now make sure you use R2 instead of R inside all @Shortcut annotations. If you are using mipmap as shortcut icon resource type, switch to drawable by simply moving the resources from the mipmap- folders to the corresponding drawable- folders.
@Shortcut(icon = R2.drawable.ic_shortcut_movies, shortLabelRes = R2.string.label_movies)
The plugin uses the Butter Knife Gradle plugin to generate the R2 class with final values. Referencing them does not make the warning disappear (you can suppress it with @SuppressLint("NonConstantResourceId")), but most likely will be the only way to use resource IDs in annotations in the future.
Alternative to Gradle plugin
If for you can't (or don't want to) use the plugin, you can use the additional deprecated string attributes like iconResName, shortLabelResName and so on.
@Shortcut(iconResName = "ic_shortcut_movies", shortLabelResName = "label_movies")
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.
![Ability to remove and add shortcuts [Enhancement]](https://avatars.githubusercontent.com/u/11215286?v=4)
1 Feb 26, 2022
68 Jan 6, 2023
13 Apr 4, 2020
2 Jun 26, 2022
3 Feb 2, 2022
37 Oct 28, 2022
6 Mar 31, 2022
31 Jun 10, 2022
2 Jan 20, 2022
0 Nov 23, 2021
127 Dec 28, 2022
1 Jan 18, 2022
87 Nov 30, 2022
1 Jan 1, 2022
0 Jan 8, 2022
4 Oct 2, 2022
2 Aug 31, 2022
1 Oct 28, 2021
65 Dec 19, 2022