ContextMenuItem

Describes an item that will be embedded in the Actions item of the file context menu.

key

Defines the unique item identifier used by the service to recognize the item.

Type: string

Example: "convert-file-item"

label

Defines the item display name.

Type: string

Example: "Convert to PDF"

icon

Defines the item display icon. The icon image must be uploaded to the assets folder. Only the image name with the extension must be specified in this field. The required icon size is 16x16 px. Otherwise, it will be compressed to this size.

Type: string

Example: "convert-16.png"

onClick

Defines a function that takes the file/folder/room id as an argument. This function can be asynchronous.

Type: func

Example: (id: number) => {}

fileExt

Defines the extensions of files where the current item will be displayed in the context menu. It only works if the FilesType.Files is specified in the fileType parameter. If this parameter is not specified, then the current context menu item will be displayed in any file extension.

Type: array of FilesExst / string

Example: [FilesExst.docx, FilesExst.xlsx]

fileType

Defines the types of files where the current item will be displayed in the context menu. Presently the following file types are available: room, file, folder, image, video. If this parameter is not specified, then the current context menu item will be displayed in any file type.

Type: array of FilesType

Example: [FilesType.file]

usersType

Defines the types of users who will see the current item in the context menu. Currently the following user types are available: owner, docSpaceAdmin, roomAdmin, collaborator, user. If this parameter is not specified, then the current context menu item will be displayed for all user types.

Type: array of UsersType

Example: [UsersType.owner, UsersType.docSpaceAdmin, UsersType.roomAdmin]

devices

Defines the types of devices where the current item will be displayed in the context menu. At the moment the following device types are available: mobile, tablet, desktop. If this parameter is not specified, then the current context menu item will be displayed in any device types.

Type: array of Devices

Example: [Devices.desktop]

security

Defines the security parameters of the parent folder or room that will be checked. If all the parameters are true, the current item will be displayed in the context menu. If this parameter is undefined, it will be ignored.

Type: array of Security

Example: [Security.Create]

withActiveItem

Specifies whether to add the action state to the item in the file list when the onClick event is triggered.

Type: boolean

Example: true

Example

import {FilesType, type IContextMenuItem, UsersType} from "@onlyoffice/docspace-plugin-sdk"

export const convertFileItem: IContextMenuItem = {
  key: "convert-file-item",
  label: "Convert to PDF",
  icon: "convert-16.png",
  onClick: (id: number) => {},
  fileType: [FilesType.file],
  usersTypes: [UsersType.owner, UsersType.docSpaceAdmin, UsersType.roomAdmin],
}