Update doc

veerjainATgmail · Sep 11, 2018 · d408210 · d408210
1 parent d174021
commit d408210
Show file tree

Hide file tree

Showing 2 changed files with 99 additions and 8 deletions.
diff --git a/Android/chatinput/README.md b/Android/chatinput/README.md
@@ -266,7 +266,7 @@ mChatInput.setCameraCaptureFile(path, fileName);
 ```
 
 ## MenuManager(从0.9.0版本开始支持)
-菜单功能管理类，用于添加自定义菜单，自由设置菜单项的位置，包括输入框的左边/右边/下边位置。
+菜单功能管理类，用于添加自定义菜单，自由设置菜单项的位置，包括输入框的左边/右边/下边位置。
 
 ### 获取MenuManager
 
@@ -275,9 +275,7 @@ mChatInput.setCameraCaptureFile(path, fileName);
 
 ### 添加自定义菜单
 
-`
-
-1. 添加菜单项布局，根节点为MenuItem（继承自LinearLayout）
+1. 添加菜单项布局，根节点为MenuItem（继承自LinearLayout）
 ```xml
 <cn.jiguang.imui.chatinput.menu.view.MenuItem 
     android:layout_width="match_parent"
@@ -288,7 +286,7 @@ mChatInput.setCameraCaptureFile(path, fileName);
 </cn.jiguang.imui.chatinput.menu.view.MenuItem>
 ```
 
-2. 添加对应菜单功能布局，根节点为MenuFeature（继承自LinearLayout）
+2. 添加对应菜单功能布局，根节点为MenuFeature（继承自LinearLayout）
 ```xml
 <cn.jiguang.imui.chatinput.menu.view.MenuFeature 
     android:layout_width="match_parent"
@@ -331,7 +329,7 @@ menuManager.setCustomMenuClickListener(new CustomMenuEventListener() {
 `setMenu(Menu menu)`
 
 #### Menu
-通过传入菜单项的tag来控制布局,默认可使用的布局tag有：
+通过传入菜单项的tag来控制布局,默认可使用的布局tag有：
 ```Java
 Menu.TAG_VOICE 
 Menu.TAG_EMOJI
@@ -349,12 +347,12 @@ Menu.newBuilder().
         setBottom(String ... tag).//输入框下侧菜单项
         build()
 ```
-#### 示例
+#### 示例
 ```java
 menuManager.setMenu(Menu.newBuilder().
                 customize(true).
                 setRight(Menu.TAG_SEND).
-                setBottom(Menu.TAG_VOICE,Menu.TAG_EMOJI,Menu.TAG_GALLERY,Menu.TAG_CAMERA,"MY_CUSTOM").
+                setBottom(Menu.TAG_VOICE,Menu.TAG_EMOJI,Menu.TAG_GALLERY,Menu.TAG_CAMERA).
                 build());
 ```
 

diff --git a/Android/chatinput/README_EN.md b/Android/chatinput/README_EN.md
@@ -273,5 +273,98 @@ Since 0.4.5, take picture will return default path.
 mChatInput.setCameraCaptureFile(path, fileName);
 ```
 
+## MenuManager(Support since 0.9.0)
+
+Menu management class, used to add a custom menu, freely set the position of the menu item, including the left/right/lower position of the chatinput.
+
+### Get MenuManager
+
+`MenuManager menuManager = mChatInput.getMenuManager();`
+
+
+### Add custom menu
+
+1. Add custom menu item layout，the root node has to be MenuItem(Extends LinearLayout)
+```xml
+<cn.jiguang.imui.chatinput.menu.view.MenuItem 
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    ...
+
+</cn.jiguang.imui.chatinput.menu.view.MenuItem>
+```
+
+2. Add custom menu feature layout，the root node has to be MenuFeature(Extends LinearLayout)
+```xml
+<cn.jiguang.imui.chatinput.menu.view.MenuFeature 
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    ...
+
+</cn.jiguang.imui.chatinput.menu.view.MenuFeature>
+```
+3. Add custom menu by MenuManager
+```java
+//First：add view mode, tag must be unique
+//If set menuFeature as null means that this menu item does not require a corresponding function.
+addCustomMenu(String tag, MenuItem menuItem, MenuFeature menuFeature)
+
+//Second: add layout resources, tag must be unique
+//If set menuFeatureResource as -1 means that this menu item does not require a corresponding function.
+addCustomMenu(String tag, int menuItemResource, int menuFeatureResource) 
+```
+4. CustomMenuEventListener
+```java
+menuManager.setCustomMenuClickListener(new CustomMenuEventListener() {
+            @Override
+            public boolean onMenuItemClick(String tag, MenuItem menuItem) {
+                //Menu feature will not be shown if return false；
+                return true;
+            }
+
+            @Override
+            public void onMenuFeatureVisibilityChanged(int visibility, String tag, MenuFeature menuFeature) {
+                if(visibility == View.VISIBLE){
+                    // Menu feature is visible.
+                }else {
+                    // Menu feature is gone.
+                }
+            }
+        });
+```
+### Set the position of the menu item
+`setMenu(Menu menu)`
+
+#### Menu
+
+The position is controlled by passing in the tag of the menu item. The default layout tags are:
+
+```Java
+Menu.TAG_VOICE 
+Menu.TAG_EMOJI
+Menu.TAG_GALLERY
+Menu.TAG_CAMERA
+Menu.TAG_SEND
+```
+Set position,tag cannot be repeated：
+
+```java
+Menu.newBuilder().
+        customize(boolean customize).// Whether to customize the position
+        setLeft(String ... tag).// Set left menu items
+        setRight(String ... tag).// Set right menu items
+        setBottom(String ... tag).//Set bottom menu items
+        build()
+```
+#### Sample
+```java
+menuManager.setMenu(Menu.newBuilder().
+                customize(true).
+                setRight(Menu.TAG_SEND).
+                setBottom(Menu.TAG_VOICE,Menu.TAG_EMOJI,Menu.TAG_GALLERY,Menu.TAG_CAMERA).
+                build());
+```