Build Excel add-ins using Office Add-ins Development Kit (YEHOSHUA)

Excel add-ins are integrations built by third parties into Excel by using Excel JavaScript API and Office Platform capabilities.

How to run this project

Prerequisites

• Node.js (the latest LTS version). Visit the Node.js site to download and install the right version for your operating system. To verify that you've already installed these tools, run the commands node -v and npm -v in your terminal.
• Office connected to a Microsoft 365 subscription. You might qualify for a Microsoft 365 E5 developer subscription through the Microsoft 365 Developer Program, see FAQ for details. Alternatively, you can sign up for a 1-month free trial or purchase a Microsoft 365 plan.

Run the add-in using Office Add-ins Development Kit extension

1. Open the Office Add-ins Development Kit

   In the Activity Bar, select the Office Add-ins Development Kit icon to open the extension.

2. Preview Your Office Add-in (F5)

   Select Preview Your Office Add-in(F5) to launch the add-in and debug the code. In the Quick Pick menu, select the option Excel Desktop (Edge Chromium).

   The extension then checks that the prerequisites are met before debugging starts. Check the terminal for detailed information if there are issues with your environment. After this process, the Excel desktop application launches and sideloads the add-in.

3. Stop Previewing Your Office Add-in

   Once you are finished testing and debugging the add-in, select Stop Previewing Your Office Add-in. This closes the web server and removes the add-in from the registry and cache.

Use the add-in project

The add-in project that you've created contains sample code for a basic task pane add-in.

Explore the add-in code

To explore an Office add-in project, you can start with the key files listed below.

• The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  You can check whether your manifest file is valid by selecting Validate Manifest File option from the Office Add-ins Development Kit.
• The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
• The ./src/taskpane/**/*.tsx file contains the react code and Office JavaScript API code that facilitates interaction between the task pane and the Excel application.

Troubleshooting

If you have problems running the add-in, take these steps.

• Close any open instances of Excel.
• Close the previous web server started for the add-in with the Stop Previewing Your Office Add-in Office Add-ins Development Kit extension option.

If you still have problems, see troubleshoot development errors or create a GitHub issue and we'll help you.

For information on running the add-in on Excel on the web, see Sideload Office Add-ins to Office on the web.

For information on debugging on older versions of Office, see Debug add-ins using developer tools in Microsoft Edge Legacy.

Make code changes

All the information about Office Add-ins is found in our official documentation. You can also explore more samples in the Office Add-ins Development Kit. Select View Samples to see more samples of real-world scenarios.

If you edit the manifest as part of your changes, use the Validate Manifest File option in the Office Add-ins Development Kit. This shows you errors in the manifest syntax.

Engage with the team

Did you experience any problems? Create an issue and we'll help you out.

Want to learn more about new features and best practices for the Office platform? Join the Microsoft Office Add-ins community call.

Copyright

Copyright (c) 2024 Microsoft Corporation. All rights reserved.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.