diff --git a/api/@internal/component/ets/text_common.d.ts b/api/@internal/component/ets/text_common.d.ts index bb0a8e515e49b2a331a3cf4cc1882a0d40733073..a48d13b89575c589a5b48fbcf7508b1f84a75b2f 100644 --- a/api/@internal/component/ets/text_common.d.ts +++ b/api/@internal/component/ets/text_common.d.ts @@ -1214,6 +1214,35 @@ declare interface TextMenuItem { labelInfo?: ResourceStr; } +/** + * Callback function when the selection menu create. + * + * @typedef { function } OnCreateMenuCallback + * @param { Array } menuItems - currently displayed menu items. + * @returns { Array } Return the menu items will displayed after operations. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type OnCreateMenuCallback = (menuItems: Array) => Array; + +/** + * Invoke upon clicking an item, capable of intercepting the default system menu execution behavior. + * + * @typedef { function } OnMenuItemClickCallback + * @param { TextMenuItem } menuItem - current default menu. + * @param { TextRange } range - current selected range. + * @returns { boolean } - Return True, the event is consumed, false otherwise. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type OnMenuItemClickCallback = (menuItem: TextMenuItem, range: TextRange) => boolean + /** * EditMenuOptions * @@ -1233,8 +1262,7 @@ declare interface EditMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ onCreateMenu(menuItems: Array): Array; /** @@ -1246,10 +1274,33 @@ declare interface EditMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ onMenuItemClick(menuItem: TextMenuItem, range: TextRange): boolean; + + /** + * Passes the default menu, invokes before every display to generate a menu for triggering click events. + * + * @type { OnCreateMenuCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onCreateMenu: OnCreateMenuCallback; + + /** + * Invoke upon clicking an item, capable of intercepting the default system menu execution behavior. + * + * @type { OnMenuItemClickCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onMenuItemClick: OnMenuItemClickCallback; } /**