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.
Support
RibbonApi 1.1 is available with Excel, PowerPoint, and Word. RibbonApi 1.2 is only available with Excel. Both are only for use with task pane add-ins. The following table lists the Ribbon API requirement sets, the supported platforms, and the minimum builds or versions 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 | In preview* | Version 2002 (12527.20880) | Version 2006 (Build 13001.20266) | Office 2021: Version 2108 (Build 14326.20454) | 16.38 | Not supported |
* To use Office.js preview APIs, see Accessing the Office JavaScript API library.
To find out more about versions and build numbers, see:
- Version and build numbers of update channel releases for Microsoft 365 clients
- What version of Office am I using?
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 includes support for enabling and disabling Add-in Commands. To learn the patterns for this functionality, see Enable and Disable Add-in Commands. 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 isn't yet supported in the manifest, so you shouldn't specify it in the manifest's <Requirements> section.
See also
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for