Overflow Menu
Android library for Jetpack Compose providing an Overflow Menu via fast and easy to use DSL.
How to add to project
Step 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
....
maven { url 'https://jitpack.io' }
}
}
Step 2. Add the dependency
dependencies {
implementation 'com.github.ceribe:compose-overflow-menu:version'
}
How to use
OverflowMenu {
shownIconsCount = 2 //How many icons will be shown on top app bar, rest will be hidden under overflow icon
icons {
icon {
imageVector = Icons.Filled.Edit
onClick = { context.toast("First Icon Clicked") }
}
icon {
imageVector = Icons.Filled.Delete
onClick = { context.toast("Second Icon Clicked") }
}
icon {
label = "Third Example"
onClick = { context.toast("Third Icon Clicked") }
}
}
//Default values for icons. If icon does not have some parameter set it will use the one from defaults
defaults {
tint = Color.Red
}
//Parameters for overflow icon
overflowIcon {
tint = Color.Yellow
}
}
Possible icon parameters
- onClick - Lambda called when this icon is clicked
- modifier - Will be applied to Icon or DropdownMenuItem
- enabled - Will be applied to Icon or DropdownMenuItem
- imageVector - Will be applied to Icon
- label - Label used when this icon is hidden
- contentDescription - Will be applied to Icon
- tint - Will be applied to Icon
For more in examples check here
License
Copyright 2021 Ceribe Kagami
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
https://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.2k Dec 31, 2022
4 Aug 27, 2022
22 Oct 6, 2022
5 Oct 25, 2022
35 Dec 10, 2022
0 Nov 17, 2022
19 Nov 23, 2022
2 Aug 4, 2022
6 Oct 18, 2022
888 Oct 11, 2022
0 Jan 30, 2022
10 Dec 17, 2022
46 Nov 29, 2022
198 Dec 17, 2022
13 Dec 15, 2022
8 Oct 15, 2022
13 Feb 21, 2022
1 Nov 27, 2021
3 Jul 11, 2022