Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the W/X quickstart articles + remove preview labels of previous articles when the Dev Kit GA #4944

Open
wants to merge 42 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
4be2d9d
Update excel-quickstart-jquery.md
MingjiaLiu1995 Nov 18, 2024
b36a73b
Add files via upload
MingjiaLiu1995 Nov 18, 2024
f1761ba
Update word-quickstart-yo.md
MingjiaLiu1995 Nov 18, 2024
0151746
Merge branch 'OfficeDev:main' into main
MingjiaLiu1995 Nov 22, 2024
9468361
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
4d2e785
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
074ad23
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Nov 22, 2024
d540a61
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Nov 22, 2024
c935e3a
Create devkit-prerequisites
MingjiaLiu1995 Nov 22, 2024
baf9b8c
Update excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
9349148
Rename devkit-prerequisites to dev-kit-prerequisites
MingjiaLiu1995 Nov 22, 2024
f430c6b
Rename dev-kit-prerequisites to dev-kit-prerequisites.md
MingjiaLiu1995 Nov 22, 2024
2d1bf91
Update excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
ecc441a
Update excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
53e225b
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Nov 22, 2024
dd54fc8
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Nov 22, 2024
e09e338
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Nov 22, 2024
d76721e
Address review comments
MingjiaLiu1995 Nov 22, 2024
4f3ef68
Merge branch 'main' of https://github.com/MingjiaLiu1995/office-js-do…
MingjiaLiu1995 Nov 22, 2024
f6e6f13
Update sample snapshots
MingjiaLiu1995 Nov 22, 2024
7de3643
Merge branch 'OfficeDev:main' into main
MingjiaLiu1995 Nov 26, 2024
9ce48fb
Update docs/includes/devkit-project-components-taskpane.md
MingjiaLiu1995 Dec 2, 2024
b630f91
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Dec 2, 2024
90f0035
Update docs/quickstarts/word-quickstart-yo.md
MingjiaLiu1995 Dec 2, 2024
42e5f22
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Dec 2, 2024
ff3de87
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Dec 2, 2024
8ae6caf
Update docs/quickstarts/excel-quickstart-jquery.md
MingjiaLiu1995 Dec 2, 2024
da09b93
Address review comments
MingjiaLiu1995 Dec 2, 2024
9fc6055
Merge branch 'main' of https://github.com/MingjiaLiu1995/office-js-do…
MingjiaLiu1995 Dec 2, 2024
c6a03be
Address review comments
MingjiaLiu1995 Dec 2, 2024
c3c3860
Address review comments
MingjiaLiu1995 Dec 2, 2024
3e14e91
Apply suggestions from code review
MingjiaLiu1995 Dec 3, 2024
b61bf70
Merge branch 'OfficeDev:main' into main
MingjiaLiu1995 Dec 11, 2024
6858bb7
Remove preview labels in existing articles
MingjiaLiu1995 Dec 11, 2024
fcbe2b6
Update development-kit-overview.md
MingjiaLiu1995 Dec 12, 2024
6b915ee
Update word-quickstart-yo.md
MingjiaLiu1995 Dec 12, 2024
b209c29
Update excel-quickstart-jquery.md
MingjiaLiu1995 Dec 12, 2024
73afdbe
Update set-up-your-dev-environment.md
MingjiaLiu1995 Dec 12, 2024
c7b3d37
Update word-quickstart-yo.md
MingjiaLiu1995 Dec 12, 2024
4bc209d
Update sample links and notes
MingjiaLiu1995 Dec 12, 2024
13a99cc
Merge branch 'DevKitGAUpdate' of https://github.com/OfficeDev/office-…
MingjiaLiu1995 Dec 12, 2024
7052561
Update notes of corner cases
MingjiaLiu1995 Dec 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 7 additions & 32 deletions docs/develop/development-kit-overview.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
---
title: Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code (preview)
title: Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code
description: Learn how to create Office Add-in projects using Office Add-ins Development Kit extension.
ms.date: 09/09/2024
ms.date: 12/12/2024
ms.localizationpriority: high
---

# Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code (preview)
# Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code

The Office Add-ins Development Kit helps set up your environment, create Office Add-ins, and debug your code in a streamlined experience.

[!INCLUDE [Information about the preview status of the dev kit.](../includes/dev-kit-preview-note.md)]

## Prerequisites

- Download and install [Visual Studio Code](https://code.visualstudio.com/).
- Node.js (the latest LTS version). Visit the [Node.js site](https://nodejs.org/) to download and install the right version for your operating system. To verify if 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](https://developer.microsoft.com/microsoft-365/dev-program), see [FAQ](/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-) for details. Alternatively, you can [sign up for a 1-month free trial](https://www.microsoft.com/microsoft-365/try?rtc=1) or [purchase a Microsoft 365 plan](https://www.microsoft.com/microsoft-365/buy/compare-all-microsoft-365-products).
[!include[Dev_kit prerequisites](../includes/dev-kit-prerequisites.md)]

## Install the development kit

Expand Down Expand Up @@ -67,29 +63,8 @@ To understand how the add-in will work in an Office application, use the Office
> [!NOTE]
> These steps are the same as the ones listed in Visual Studio Code by the extension when you create a new project.

1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**.
1. Select **Preview Your Office Add-in (F5)**
1. In the Quick Pick menu, select the option **{Office Host} Desktop (Edge Chromium)**. This will launch the add-in and debug the code.

The development kit 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 Office desktop application launches and sideloads the add-in. Please note that the first time you run a project, it may make take a few minutes to install the dependencies. You will need to install the certificate when prompted.

## Stop testing your Office Add-in

Once you are finished testing and debugging the add-in, close the add-in by following these steps.

1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**.
1. Select **Stop Previewing Your Office Add-in**. This closes the web server and removes the add-in from the registry and cache.
1. Close the Office application window at your convenience.

## Troubleshooting

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

- Close any open instances of Office.
- 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.

The article [Troubleshoot development errors with Office Add-ins](../testing/troubleshoot-development-errors.md) contains solutions to common problems. If you're still having issues, [create a GitHub issue](https://aka.ms/officedevkitnewissue) and we'll help you.
[!include[Dev_kit_start_debugging](../includes/dev-kit-start-debugging.md)]

For information on running the add-in on Office on the web, see [Sideload Office Add-ins to Office on the web](../testing/sideload-office-add-ins-for-testing.md).
[!include[Dev_kit_stop_debugging](../includes/dev-kit-stop-debugging.md)]

For information on debugging on older versions of Office, see [Debug add-ins using developer tools in Microsoft Edge Legacy](../testing/debug-add-ins-using-devtools-edge-legacy.md).
[!include[Dev_kit_troubleshooting](../includes/dev-kit-troubleshooting.md)]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/includes/dev-kit-prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Prerequisites

- Download and install [Visual Studio Code](https://code.visualstudio.com/).
- Node.js (the latest LTS version). Visit the [Node.js site](https://nodejs.org/) to download and install the right version for your operating system. To verify if 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](https://developer.microsoft.com/microsoft-365/dev-program), see [FAQ](/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-) for details. Alternatively, you can [sign up for a 1-month free trial](https://www.microsoft.com/microsoft-365/try?rtc=1) or [purchase a Microsoft 365 plan](https://www.microsoft.com/microsoft-365/buy/compare-all-microsoft-365-products).
5 changes: 5 additions & 0 deletions docs/includes/dev-kit-start-debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**.
1. Select **Preview Your Office Add-in (F5)**
1. In the Quick Pick menu, select the option **{Office Application} Desktop (Edge Chromium)**, where '{Office Application}' is the appropriate application, such as "Excel" or "Word". This will launch the add-in and debug the code.

The development kit 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 Office desktop application launches and sideloads the add-in. Please note that the first time you run a project, it may make take a few minutes to install the dependencies. You'll need to install the certificate when prompted.
7 changes: 7 additions & 0 deletions docs/includes/dev-kit-stop-debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Stop testing your Office Add-in

Once you are finished testing and debugging the add-in, *always* close the add-in by following these steps. (Closing the Office application or web server window doesn't reliably deregister the add-in.)

1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**.
1. Select **Stop Previewing Your Office Add-in**. This closes the web server and removes the add-in from the registry and cache.
1. Close the Office application window.
12 changes: 12 additions & 0 deletions docs/includes/dev-kit-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Troubleshooting

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

- Close any open instances of Office.
- 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.

The article [Troubleshoot development errors with Office Add-ins](../testing/troubleshoot-development-errors.md) contains solutions to common problems. If you're still having issues, [create a GitHub issue](https://aka.ms/officedevkitnewissue) and we'll help you.

For information on running the add-in on Office on the web, see [Sideload Office Add-ins to Office on the web](../testing/sideload-office-add-ins-for-testing.md).

For information on debugging on older versions of Office, see [Debug add-ins using developer tools in Microsoft Edge Legacy](../testing/debug-add-ins-using-devtools-edge-legacy.md).
8 changes: 8 additions & 0 deletions docs/includes/devkit-project-components-taskpane.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Explore the project

The add-in project that you've created with the Office Add-ins Development Kit contains sample code for a basic task pane add-in. If you'd like to explore the 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.

1. The **./manifest.xml** or **./manifest.json** file in the root directory of the project defines the settings and capabilities of the add-in.
1. The **./src/taskpane/taskpane.html** file contains the HTML markup for the task pane.
1. The **./src/taskpane/taskpane.css** file contains the CSS that's applied to content in the task pane.
1. The **./src/taskpane/taskpane.js** file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application.
4 changes: 2 additions & 2 deletions docs/overview/set-up-your-dev-environment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Set up your development environment
description: Set up your developer environment to build Office Add-ins.
ms.date: 08/22/2024
ms.date: 12/12/2024
ms.topic: install-set-up-deploy
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -124,7 +124,7 @@ You can create Office add-in projects in Visual Studio Code with either the Team

Install [Visual Studio Code](https://code.visualstudio.com/) and then install the latest version of Teams Toolkit as described in [Install Teams Toolkit](/microsoftteams/platform/toolkit/install-teams-toolkit?tabs=vscode).

#### Install the Office Add-ins Development Kit extension (preview)
#### Install the Office Add-ins Development Kit extension

The Office Add-ins Development Kit extension for Visual Studio Code lets you create and run new add-ins directly from the IDE. For more information about the extension, see [Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code](../develop/development-kit-overview.md).

Expand Down
33 changes: 31 additions & 2 deletions docs/quickstarts/excel-quickstart-jquery.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,44 @@
---
title: Build your first Excel task pane add-in
description: Learn how to build a simple Excel task pane add-in by using the Office JS API and the Yo Office tool.
ms.date: 08/20/2024
ms.date: 12/12/2024
ms.service: excel
ms.localizationpriority: high
---

# Build an Excel task pane add-in

In this article, you'll walk through the process of building an Excel task pane add-in with Yo Office.
In this article, you'll walk through the process of building an Excel task pane add-in. You'll use either the Office Add-ins Development Kit or the Yeoman generator to create your Office Add-in. Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally. If you'd like to create the add-in project within Visual Studio Code, we recommend the Office Add-ins Development Kit.

# [Office Add-ins Development Kit](#tab/devkit)

[!include[Dev_kit prerequisites](../includes/dev-kit-prerequisites.md)]

## Create the add-in project

Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. You'll be prompted to install the extension if don't already have it. A page that contains the project description will open in Visual Studio Code.

> [!div class="nextstepaction"]
> [Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=excel-get-started-with-dev-kit)

In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project.

:::image type="content" source="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt-text="The Development Kit sample gallery in Visual Studio Code":::

The Office Add-ins Development Kit will create the project. It will then open the project in a *second* Visual Studio Code window. Close the original Visual Studio Code window.

> [!NOTE]
> If you use VSCode Insiders, or you have problems opening the project page in VSCode, install the extension manually by following [these steps](../develop/development-kit-overview.md?tabs=vscode), and find the sample in the sample gallery.
[!include[Devkit_project_components_taskpane](../includes/devkit-project-components-taskpane.md)]

## Try it out

[!include[Dev_kit_start_debugging](../includes/dev-kit-start-debugging.md)]

[!include[Dev_kit_stop_debugging](../includes/dev-kit-stop-debugging.md)]

[!include[Dev_kit_troubleshooting](../includes/dev-kit-troubleshooting.md)]
# [Yeoman generator](#tab/yeoman)
## Prerequisites

[!include[Yeoman generator prerequisites](../includes/quickstart-yo-prerequisites.md)]
Expand Down
34 changes: 32 additions & 2 deletions docs/quickstarts/word-quickstart-yo.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,45 @@
---
title: Build your first Word task pane add-in
description: Learn how to build a simple Word task pane add-in by using the Office JavaScript API.
ms.date: 08/20/2024
ms.date: 12/12/2024
ms.service: word
ms.localizationpriority: high
---

# Build your first Word task pane add-in

In this article, you'll walk through the process of building a Word task pane add-in.
In this article, you'll walk through the process of building a Word task pane add-in. You'll use either the Office Add-ins Development Kit or the Yeoman generator to create your Office Add-in. Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally. If you'd like to create the add-in project within Visual Studio Code, we recommend the Office Add-ins Development Kit.

# [Office Add-ins Development Kit](#tab/devkit)

[!include[Dev_kit prerequisites](../includes/dev-kit-prerequisites.md)]

## Create the add-in project

Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. You'll be prompted to install the extension if don't already have it. A page that contains the project description will open in Visual Studio Code.

> [!div class="nextstepaction"]
> [Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=word-get-started-with-dev-kit)

In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project.

:::image type="content" source="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt-text="The Development Kit sample gallery in Visual Studio Code":::

The Office Add-ins Development Kit will create the project. It will then open the project in a *second* Visual Studio Code window. Close the original Visual Studio Code window.

> [!NOTE]
> If you use VSCode Insiders, or you have problems opening the project page in VSCode, install the extension manually by following [these steps](../develop/development-kit-overview.md?tabs=vscode), and find the sample in the sample gallery.

[!include[Devkit_project_components_taskpane](../includes/devkit-project-components-taskpane.md)]

## Try it out

[!include[Dev_kit_start_debugging](../includes/dev-kit-start-debugging.md)]

[!include[Dev_kit_stop_debugging](../includes/dev-kit-stop-debugging.md)]

[!include[Dev_kit_troubleshooting](../includes/dev-kit-troubleshooting.md)]
# [Yeoman generator](#tab/yeoman)
## Prerequisites

[!include[Yeoman generator prerequisites](../includes/quickstart-yo-prerequisites.md)]
Expand Down