Ribbon API requirement sets

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 Office client applications that support that requirement set, and the build or version numbers for the Office application.

Requirement set Office 2021 or later on Windows
(one-time purchase)
Office on Windows
(connected to a Microsoft 365 subscription)
Office on iPad
(connected to a Microsoft 365 subscription)
Office on Mac
(both subscription
and one-time purchase Office on Mac 2019 and later)
Office on the web Office Online Server
RibbonApi 1.2 Build 16.0.14326.20454 or later 2102 (Build 13801.20294) N/A 16.53.806.0 May, 2021 N/A
RibbonApi 1.1 Build 16.0.14326.20454 or later See support
section below
N/A 16.38 November, 2020 N/A

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 (subscription) and Office on Mac. It is not available in Office on the web.

Support for version 1.1 on Office on Windows (subscription)

The 1.1 version of the RibbonApi requirement set is supported in the Consumer Channel version 2006 (build 13001.20498 or greater). For Office on Windows the feature is also supported in the Semi-Annual Channel and Monthly Enterprise Channel builds available July 14th, 2020 or later. The minimum supported builds for each channel are as follows:

Channel Version Build
Current Channel 2006 or greater 20266.20266 or greater
Monthly Enterprise Channel 2005 or greater 12827.20538 or greater
Monthly Enterprise Channel 2004 12730.20602 or greater
Semi-Annual Enterprise Channel 2002 or greater 12527.20880 or greater

More information

To find out more about versions, build numbers, and Office Online Server, 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.

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 is not yet supported in the manifest, so you shouldn't specify it in the manifest's <Requirements> section.

See also