Edit

Ribbon API requirement sets

  • Article

Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office application supports APIs that an add-in needs. For more information, see Office versions and requirement sets.

The Ribbon API set supports programmatic control of when custom add-in commands (that is, custom ribbon buttons and menu items) are enabled and disabled and when contextual tabs appear on the ribbon.

Office Add-ins run across multiple versions of Office. The following table lists the Ribbon API requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.

Requirement set Office on the web Office on Windows
(Microsoft 365 subscription)		 Office on Windows
(retail perpetual)		 Office on Windows
(volume-licensed perpetual)		 Office on Mac Office on iPad
RibbonApi 1.2 Supported Version 2102 (Build 13801.20294) Version 2102 (Build 13801.20294) Office 2021: Version 2108 (Build 14326.20454) 16.53.806.0 Not supported
RibbonApi 1.1 Supported See support
section		 Version 2006 (Build 13001.20266) Office 2021: Version 2108 (Build 14326.20454) 16.38 Not supported

Important

  • The RibbonApi requirement sets are supported only on task pane add-ins.
  • The RibbonApi requirement sets are supported for production add-ins only in Excel.
  • RibbonApi 1.1 (not 1.2) is available as a preview in PowerPoint and Word, but only in Office on Windows (Microsoft 365 subscription) and Office on Mac. It's also available for preview in PowerPoint on the web. To understand how to access Office.js preview APIs, see Accessing the Office JavaScript API library.

Support for version 1.1 in Office on Windows (Microsoft 365 subscription)

The 1.1 version of the RibbonApi requirement set is supported in the Consumer Channel from Version 2006 (Build 13001.20498). That requirement set is also supported in the Semi-Annual Channel and Monthly Enterprise Channel builds available since July 14, 2020. The minimum supported builds for each channel are as follows:

Channel Minimum version Minimum build
Current Channel 2006 13001.20266
Monthly Enterprise Channel 2005 12827.20538
Monthly Enterprise Channel 2004 12730.20602
Semi-Annual Enterprise Channel 2002 12527.20880

More information

To find out more about versions and build numbers, see:

Office Common API requirement sets

For information about Common API requirement sets, see Office Common API requirement sets.

Ribbon API 1.1

The Ribbon API 1.1 is the first version of the API. For details about the API, see the Office.ribbon reference topic.

This requirement set includes support for enabling and disabling Add-in Commands. For more information, see Enable and Disable Add-in Commands.

Ribbon API 1.2

The Ribbon API 1.2 adds support for contextual tabs. For more information, see Create custom contextual tabs in Office Add-ins.

Note

The RibbonApi 1.2 requirement set isn't yet supported in the manifest, so you shouldn't specify it in the manifest's <Requirements> section.

See also