PanelSwitchHelper
Introduction: :heavy_check_mark: A framework that helps the keyboard smoothly transition to the function panel
Tags:
README: 中文文档
Introduction to the framework
When developing a chat/video/live/information interface, users are expected to maintain a smooth transition between the input method and the function panel (such as the expression panel/more options panel, etc.). Investigate the mainstream app effects and implementation in the market, and realize a set of input panel switching framework compatible with multiple scenes. Currently the framework has been tested and used.
Framework advantages
- Improve the traditional technical solution of using
Weight+LinearLayoutto dynamically change the layout height to suit the panel, and support multiple native ViewGroup containers - In pursuit of a smoother adaptation effect, when the input method dynamically adjusts the height or dynamically hides the navigation bar, the function panel can be adapted in real time
- In pursuit of a smoother switching effect, the sliding mode is supported, the sliding will be smoother, and the fixed mode is also supported
- Rich model adaptation, adapt to non-conventional Phone models such as full screen/bang screen/digging screen/Pad
- Rich scene support, support Activity/Fragment/Dialog/PopupWindow, apply to chat/video/live broadcast/stream comment, etc.
- Rich API support, customizable content container, business panel, flexible control panel hiding, flexible control of switching panel speed
- Support full screen mode, and panel switching can also be handled in FullScreen mode
For more details, please refer to
Demo content is as follows
Download from QR code
The Androidx version runs by default. If you need to open non-Androidx, open the app in Settings.gradle and close the Androidx configuration in gradle.properties.
Instructions
- How to
1.1 Add library dependencies in module script build.gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
1.2 Add the dependency
//1.4.0 版本及后续，仅支持 Androidx
dependencies {
implementation 'com.github.DSAppTeam:PanelSwitchHelper:v1.5.8'
}
- Use the container provided by the framework in the layout file Xml
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">
<LinearLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<!-- Layout that does not need to be processed by the frame, can be arranged freely -->
<RelativeLayout
android:id="@+id/cus_title_bar"
android:layout_width="match_parent"
android:layout_height="50dp"
android:background="@color/colorPrimary"
android:visibility="gone">
<TextView
android:id="@+id/title"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="left|center_vertical"
android:paddingLeft="20dp"
android:text="自定义标题栏"
android:textColor="@android:color/white"
android:textSize="20sp"
android:textStyle="bold" />
</RelativeLayout>
<com.effective.android.panel.view.PanelSwitchLayout
android:id="@+id/panel_switch_layout"
android:layout_width="match_parent"
app:animationSpeed="standard"
android:layout_height="match_parent"
android:orientation="vertical">
<!-- ContentContainer -->
<!-- linear_edit_view, Specify an EditText for input, required-->
<!-- linear_auto_reset_enable,Specifies whether the LinearContentContainer can accept Touch events and automatically hide the panel-->
<!-- linear_auto_reset_area, Specifies whether the LinearContentContainer only accepts Touch events in a View area to customize the hidden panel-->
<com.effective.android.panel.view.content.LinearContentContainer
android:id="@+id/content_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
app:edit_view="@id/edit_text">
<com.example.demo.scene.chat.view.HookActionUpRecyclerView
android:id="@+id/recycler_view"
android:layout_width="match_parent"
android:layout_height="0dp"
android:layout_weight="1"/>
<LinearLayout
android:id="@+id/bottom_action"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="@drawable/shape_input_layout"
android:gravity="bottom"
android:minHeight="@dimen/dp_50"
android:orientation="horizontal"
android:paddingLeft="@dimen/dp_10"
android:paddingRight="@dimen/dp_10"
android:paddingBottom="@dimen/dp_7.5">
<!--More entrances -->
<ImageView
android:id="@+id/add_btn"
android:layout_width="@dimen/dp_35"
android:layout_height="@dimen/dp_35"
android:layout_marginRight="@dimen/dp_10"
android:src="@drawable/icon_add" />
<!-- Input entrances -->
<EditText
android:id="@+id/edit_text"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_marginEnd="@dimen/dp_10"
android:layout_marginRight="@dimen/dp_10"
android:layout_weight="1"
android:background="@drawable/selector_edit_focus"
android:imeOptions="actionSearch"
android:maxLines="5"
android:minHeight="@dimen/dp_35"
android:paddingLeft="@dimen/dp_3"
android:paddingTop="@dimen/dp_7.5"
android:paddingRight="@dimen/dp_3"
android:paddingBottom="@dimen/dp_3"
android:textCursorDrawable="@drawable/shape_edit_cursor"
android:textSize="@dimen/sp_16" />
<LinearLayout
android:layout_width="wrap_content"
android:layout_height="@dimen/dp_35"
android:orientation="horizontal">
<!-- Emotion entrances -->
<ImageView
android:id="@+id/emotion_btn"
android:layout_width="@dimen/dp_35"
android:layout_height="@dimen/dp_35"
android:layout_marginEnd="@dimen/dp_10"
android:layout_marginRight="@dimen/dp_10"
android:src="@drawable/selector_emotion_btn" />
<TextView
android:id="@+id/send"
android:layout_width="@dimen/dp_50"
android:layout_height="@dimen/dp_35"
android:background="@drawable/selector_send_btn"
android:gravity="center"
android:text="@string/send"
android:textColor="@color/color_send_btn"
android:textSize="@dimen/sp_15" />
</LinearLayout>
</LinearLayout>
</com.effective.android.panel.view.content.LinearContentContainer>
<!--Panel Container, can only contain PanelView-->
<com.effective.android.panel.view.panel.PanelContainer
android:id="@+id/panel_container"
android:layout_width="match_parent"
android:background="@color/common_page_bg_color"
android:layout_height="wrap_content">
<!-- Each panel -->
<!-- panel_layout,Used to specify the layout corresponding to the ID of the panel, required-->
<!-- panel_trigger, Used to switch to this panel when the user clicks the View corresponding to this ID -->
<!-- panel_toggle ,When the panel is displayed, if the user clicks the View corresponding to panel_trigger again, whether to switch back to the input method-->
<com.effective.android.panel.view.panel.PanelView
android:id="@+id/panel_emotion"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:panel_layout="@layout/panel_emotion_layout"
app:panel_trigger="@id/emotion_btn" />
<!-- In addition to using the PanelView provided by the framework, you can also use a custom Panel -->
<com.example.demo.scene.api.CusPanelView
android:id="@+id/panel_addition"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:cus_panel_trigger="@id/add_btn"
app:cus_panel_toggle="true"/>
</com.effective.android.panel.view.panel.PanelContainer>
</com.effective.android.panel.view.PanelSwitchLayout>
</LinearLayout>
</layout>
- Initialize the PanelSwitchHelper object, and the framework will automatically collect layout information. At the same time, intercept the processing when the return key is adjusted.
//Activity scene, initialized in onStart method, others such as Fragment/Dialog/PopupWindow refer to Demo
private PanelSwitchHelper mHelper;
@Override
protected void onStart() {
super.onStart();
if (mHelper == null) {
mHelper = new PanelSwitchHelper.Builder(this)
.addKeyboardStateListener {
onKeyboardChange {
//Optional implementation, monitor input method changes
}
}
.addEditTextFocusChangeListener {
onFocusChange { _, hasFocus ->
//Optional implementation, monitor input box focus changes
}
}
.addViewClickListener {
onClickBefore {
//Optional implementation, listen for trigger clicks
}
}
.addPanelChangeListener {
onKeyboard {
//Optional implementation, input method display callback
}
onNone {
//Optional implementation, default state callback
}
onPanel {
//Optional implementation, panel display callback
}
onPanelSizeChange { panelView, _, _, _, width, height ->
//Optional implementation, dynamic callback of panel height change caused by input method dynamic adjustment
}
}
.addContentScrollMeasurer { //Optional, in sliding mode, the sliding distance can be customized for the view in the content panel, the default sliding distance is defaultDistance
getScrollDistance { defaultDistance -> defaultDistance - 200 }
getScrollViewId { R.id.recycler_view }
}
.addPanelHeightMeasurer { //Optional It is used to set the height of the front panel without obtaining the height of the input method. If it is not set, the height within the frame is the default
synchronizeKeyboardHeight { false }
getTargetPanelDefaultHeight { DisplayUtils.dip2px(this@DefaultHeightPanelActivity,400f)}
getPanelTriggerId { R.id.add_btn }
}
.logTrack(true) //Optional, default false, whether to enable log information output
.build(true) //Optional, default false, whether to open the input method by default
}
}
@Override
public void onBackPressed() {
//When the user presses the return key, if the panel is displayed, it needs to be hidden
if (mHelper != null && mHelper.hookSystemBackForHindPanel()) {
return;
}
super.onBackPressed();
}
Expectations
The project was written only to improve the efficiency of daily development and focus on processing business. If you have better practices or suggestions, please write to yummyl.lau@gmail.com.
Or search WeChat "lym_llllll" and add WeChat for feedback.
If the framework is helpful to you, Amway can give the partners around you, and every star is an affirmation of the framework.
