Build an Excel task pane add-in using Angular

In this article, you'll walk through the process of building an Excel task pane add-in using Angular and the Excel JavaScript API.

Prerequisites

  • Node.js (version 8.0.0 or later)

  • Git

  • The latest version of Yeoman and the Yeoman generator for Office Add-ins. To install these tools globally, run the following command via the command prompt:

    npm install -g yo generator-office
    

    Note

    Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

Create the add-in project

  1. Use the Yeoman generator to create an Excel add-in project. Run the following command and then answer the prompts as follows:

    yo office
    
    • Choose a project type: Office Add-in Task Pane project using Angular framework
    • Choose a script type: TypeScript
    • What do you want to name your add-in? My Office Add-in
    • Which Office client application would you like to support? Excel

    Yeoman generator

    After you complete the wizard, the generator will create the project and install supporting Node components.

  2. Navigate to the root folder of the project.

    cd "My Office Add-in"
    

Explore the project

The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in. If you'd like to explore the key components of your add-in project, open the project in your code editor and review the files listed below. When you're ready to try out your add-in, proceed to the next section.

  • The manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • The ./src/taskpane/app/app.component.html file contains the HTML markup for the task pane.
  • The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • The ./src/taskpane/app/app.component.ts file contains the Office JavaScript API code that facilitates interaction between the task pane and Excel.

Try it out

  1. Complete the following steps to start the local web server and sideload your add-in.

    Note

    Office Add-ins should use HTTPS, not HTTP, even when you are developing. If you are prompted to install a certificate after you run one of the following commands, accept the prompt to install the certificate that the Yeoman generator provides.

    Tip

    If you're testing your add-in on Mac, run the following command before proceeding. When you run this command, the local web server will start.

    npm run dev-server
    
    • To test your add-in in Excel, run the following command in the root directory of your project. When you run this command, the local web server will start (if it's not already running) and Excel will open with your add-in loaded.

      npm start
      
    • To test your add-in in Excel Online, run the following command in the root directory of your project. When you run this command, the local web server will start (if it's not already running).

      npm run start:web
      

      To use your add-in, open a new workbook in Excel Online and then sideload your add-in by following the instructions in Sideload Office Add-ins in Office Online.

  2. In Excel, choose the Home tab, and then choose the Show Taskpane button in the ribbon to open the add-in task pane.

    Excel add-in button

  3. Select any range of cells in the worksheet.

  4. At the bottom of the task pane, choose the Run link to set the color of the selected range to yellow.

    Excel add-in

Next steps

Congratulations, you've successfully created an Excel task pane add-in using Angular! Next, learn more about the capabilities of an Excel add-in and build a more complex add-in by following along with the Excel add-in tutorial.

See also