Appearance
@line/bot-sdk • Docs
@line/bot-sdk / RichMenu
Type Alias: RichMenu
RichMenu:
object
Rich menus consist of either of these objects.
- Rich menu object without the rich menu ID. Use this object when you create a rich menu.
- Rich menu response object with the rich menu ID. This object is returned when you get a rich menu or get a list of rich menus.
Area objects and action objects are included in these objects.
Type declaration
areas
areas:
object[]
Array of area objects which define the coordinates and size of tappable areas (Max: 20 area objects)
chatBarText
chatBarText:
string
Text displayed in the chat bar (Max: 14 characters)
name
name:
string
Name of the rich menu.
This value can be used to help manage your rich menus and is not displayed to users.
(Max: 300 characters)
selected
selected:
boolean
true to display the rich menu by default. Otherwise, false.
size
size:
Size
size object which contains the width and height of the rich menu displayed in the chat. Rich menu images must be one of the following sizes: 2500x1686px or 2500x843px.