This library offers a Box Composable that can be expanded/reduced through up/down swipe gestures.
| MusicPlayer Sample | Article Page Sample |
|---|---|
| Map Sample | Calendar Sample |
|---|---|
And add a dependency code to your module's build.gradle file.
dependencies {
implementation 'io.groovin:expandablebox:x.x.x'
}ExpandableBox is Expandable Layout based on Box through up/down swipe gestures.
ExpandableBox(
modifier = modifier,
expandableBoxState = rememberExpandableBoxState(initialValue = ExpandableBoxStateValue.Fold),
swipeDirection = ExpandableBoxSwipeDirection.SwipeUpToExpand,
foldHeight = 100.dp,
halfExpandHeight = 300.dp,
expandHeight = Dp.Unspecified,
swipeGestureEnabled = true,
nestedScrollEnabled = true,
newAnchorsWithAnimated = true
) {
Content(...) //Contents Composable
}Key arguments are listed below.
expandableBoxState: ExpandableBox needs ExpandableBoxState for store and use its status. See the section below for details.swipeDirection: You can set the Swipe direction for expanding this.default = SwipeUpToExpandfoldHeight: Define the Minimized Height.MandatoryhalfExpandHeight: Define the Half Expanded Height If you want to use Half Expanded State. If not defined, half expanded state is not used.OptionalexpandHeight: Define the Fully Expanded Height. The default isDp.Unspecified, which sets it to the parent's maximum height.OptionalswipeGestureEnabled: You can disable swipe gesture.default = truenestedScrollEnabled: You can enable nested scrolling to allow seamless swipe gesture with scrollable composable like Column or LazyColumn.default = truenewAnchorsWithAnimated: When the box anchors change, animate to the new offset instead of snapping immediately.default = true
ExpandableBox needs ExpandableBoxState instance for store and use its status.
val expandableBoxState = rememberExpandableBoxState(initialValue = ExpandableBoxStateValue.Fold)Only one of the values below must be set as the initial value.
ExpandableBoxStateValue.Fold: Begin with Minimized state.ExpandableBoxStateValue.HalfExpand: Begin with Half Expanded state. Note thathalfExpandHeightmust be different fromfoldHeightto use this.ExpandableBoxStateValue.Expand: Begin with Fully Expanded state.
ExpandableBoxState exposes following parameters.
completedValue: Indicates that latest completion State :Fold,HalfExpand,ExpandprogressValue: Indicates that current Progress State :Fold,Folding,HalfExpand,Expanding,Expandoffset: Indicates the current height offset in pixels. Note thatFoldingandHalfExpandStates are only available when Half Expand state is used.
A ExpandableBoxScope provides a scope with attributes for the content of ExpandableBox.
progress: Float: Progress value(0 ~ 1f) betweenFoldtoExpand(in use Half Expand state case,FoldtoHalfExpand, orHalfExpandtoExpand).completedState: ExpandableBoxStateValue: It is same with ExpandableBoxState.completedValueprogressState: ExpandableBoxStateValue: It is same with ExpandableBoxState.progressValue
also, ExpandableBoxScope inheriting BoxScope, it can be used the same as BoxScope.
Copyright 2023 gaiuszzang (Mincheol Shin)
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.