Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
11 changes: 6 additions & 5 deletions .config/samples-config-v3.json
Original file line number Diff line number Diff line change
Expand Up @@ -391,17 +391,18 @@
"suggested": false
},
{
"id": "hello-world-teams-tab-and-outlook-add-in",
"shortId": "helloworld-outlook",
"id": "hello-world-teams-tab-and-office-add-in",
"shortId": "helloworld-office",
"onboardDate": "2023-03-02",
"title": "Hello World Teams Tab and Outlook add-in",
"shortDescription": "A hello world project that contains both Teams Tab and Outlook add-in capability",
"fullDescription": "Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context. Outlook add-ins are integrations built by third parties into Outlook by using our web-based platform. Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.",
"title": "Hello World Teams Tab and Office add-in",
"shortDescription": "A hello world project that contains both Teams Tab and Office add-in capability",
"fullDescription": "Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context. Office add-ins are integrations built by third parties into Office by using our web-based platform. Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.",
"types": [
"Tab"
],
"tags": [
"Tab",
"Office Add-in",
"Outlook Add-in"
],
"time": "5min to run",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,44 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug in Word Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Word Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in Excel Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Excel Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in PowerPoint Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start PowerPoint Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in Outlook Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Add-in Locally",
"preLaunchTask": "Start Outlook Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,21 +116,69 @@
"showReuseMessage": false
}
},
{
"label": "Debug: Excel Desktop",
"type": "npm",
"script": "start:desktop:excel",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Debug: Outlook Desktop",
"type": "npm",
"script": "start:desktop -- --app outlook",
"script": "start:desktop:outlook",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
],
]
},
{
"label": "Debug: PowerPoint Desktop",
"type": "npm",
"script": "start:desktop:powerpoint",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated",
"panel": "dedicated"
},
"problemMatcher": []
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Debug: Word Desktop",
"type": "npm",
"script": "start:desktop:word",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Dev Server",
Expand Down Expand Up @@ -209,7 +257,31 @@
"problemMatcher": []
},
{
"label": "Start Add-in Locally",
"label": "Start Word Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Word Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start Excel Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Excel Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start PowerPoint Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: PowerPoint Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start Outlook Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Outlook Desktop"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@ languages:
products:
- office-teams
- office
name: Hello World Teams Tab and Outlook add-in
urlFragment: officedev-teamsfx-samples-tab-hello-world-teams-tab-and-outlook-add-in
description: A hello world project that contains both Teams Tab and Outlook add-in capability.
name: Hello World Teams Tab and Office add-in
urlFragment: officedev-teamsfx-samples-tab-hello-world-teams-tab-and-office-add-in
description: A hello world project that contains both Teams Tab and Office add-in capability.
extensions:
createdDate: "2023-03-02"
---
# Getting Started with Hello World Teams Tab and Outlook add-in Sample
# Getting Started with Hello World Teams Tab and Office add-in Sample

Microsoft Teams supports the ability to run web-based UI inside "custom tabs" that users can install either for just themselves (personal tabs) or within a team or group chat context.

Outlook add-ins are integrations built by third parties into Outlook by using our web-based platform.
Office add-ins are integrations built by third parties into Office by using our web-based platform.

Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.

## This sample illustrates

- How a Teams Tab and an Outlook add-in share the same JSON manifest in one project.
- How a Teams Tab and an Office add-in share the same JSON manifest in one project.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

The unified app manifest for Word, Excel, and PowerPoint is in preview. Visit this link to check the required Office Versions.

## Prerequisites to use this sample

- [Node.js](https://nodejs.org/), supported versions: 16, 18
- Edge or Chrome installed for debugging Teams Tab. Edge installed for debugging Outlook add-in.
- [Node.js](https://nodejs.org/), supported versions: 18, 20
- Edge or Chrome installed for debugging Teams Tab. Edge installed for debugging Office add-in.
- Outlook for Windows: Beta Channel, Build 16320 or higher. Follow [this link](https://github.com/OfficeDev/TeamsFx/wiki/How-to-switch-Outlook-client-update-channel-and-verify-Outlook-client-build-version) for information about how to update channels and check your Outlook client build version.
- An M365 account. If you do not have M365 account, apply one from [M365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)
Expand Down Expand Up @@ -116,6 +116,7 @@ To check that your manifest file is valid:
|April 11, 2023 | yufuwang | comment out manifest validation |
|May 24, 2023 | yefuwang | update outdated content |
|September 10, 2023 | joshuapa | added images |
|Nov 29, 2024 | hermanwen | replace outlook with office capability |

## Feedback

Expand Down
69 changes: 69 additions & 0 deletions hello-world-teams-tab-and-office-add-in/add-in/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
{
"name": "office-addin-taskpane",
"version": "0.0.1",
"repository": {
"type": "git",
"url": "https://github.com/OfficeDev/Office-Addin-TaskPane.git"
},
"license": "MIT",
"config": {
"app_to_debug": "excel",
"app_type_to_debug": "desktop",
"dev_server_port": 53000
},
"scripts": {
"build": "webpack --mode production",
"build:dev": "webpack --mode development",
"dev-server": "webpack serve --mode development",
"lint": "office-addin-lint check",
"lint:fix": "office-addin-lint fix",
"prettier": "office-addin-lint prettier",
"signin": "office-addin-dev-settings m365-account login",
"signout": "office-addin-dev-settings m365-account logout",
"start": "office-addin-debugging start ../appPackage/build/appPackage.local.zip",
"start:desktop": "office-addin-debugging start ../appPackage/build/appPackage.local.zip desktop",
"start:desktop:word": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app word",
"start:desktop:excel": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app excel",
"start:desktop:powerpoint": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app powerpoint",
"start:desktop:outlook": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app outlook",
"start:web": "office-addin-debugging start ../appPackage/build/appPackage.local.zip web",
"stop": "office-addin-debugging stop ../appPackage/build/manifest.local.json",
"validate": "office-addin-manifest validate ../appPackage/build/manifest.local.json",
"watch": "webpack --mode development --watch"
},
"dependencies": {
"core-js": "^3.36.0",
"regenerator-runtime": "^0.14.1"
},
"devDependencies": {
"@babel/core": "^7.24.0",
"@babel/preset-typescript": "^7.23.3",
"@types/office-js": "^1.0.377",
"@types/office-runtime": "^1.0.35",
"babel-loader": "^9.1.3",
"copy-webpack-plugin": "^12.0.2",
"eslint-plugin-office-addins": "^3.0.2",
"file-loader": "^6.2.0",
"html-loader": "^5.0.0",
"html-webpack-plugin": "^5.6.0",
"office-addin-cli": "^1.6.3",
"office-addin-debugging": "^5.1.4",
"office-addin-dev-certs": "^1.13.3",
"office-addin-lint": "^2.3.3",
"office-addin-manifest": "^1.13.4",
"office-addin-prettier-config": "^1.2.1",
"os-browserify": "^0.3.0",
"process": "^0.11.10",
"source-map-loader": "^5.0.0",
"ts-loader": "^9.5.1",
"typescript": "^5.4.2",
"webpack": "^5.90.3",
"webpack-cli": "^5.1.4",
"webpack-dev-server": "5.0.3"
},
"prettier": "office-addin-prettier-config",
"browserslist": [
"last 2 versions",
"ie 11"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { insertBlueParagraphInWord } from "./word";
import { setRangeColorInExcel } from "./excel";
import { insertTextInPowerPoint } from "./powerpoint";
import { setNotificationInOutlook } from "./outlook";

/* global Office */

// Register the add-in commands with the Office host application.
Office.onReady(async (info) => {
switch (info.host) {
case Office.HostType.Word:
Office.actions.associate("action", insertBlueParagraphInWord);
break;
case Office.HostType.Excel:
Office.actions.associate("action", setRangeColorInExcel);
break;
case Office.HostType.PowerPoint:
Office.actions.associate("action", insertTextInPowerPoint);
break;
case Office.HostType.Outlook:
Office.actions.associate("action", setNotificationInOutlook);
break;
default: {
throw new Error(`${info.host} not supported.`);
}
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
* See LICENSE in the project root for license information.
*/

/* global Office Excel console */

/**
* Set range color to selected range in excel when the add-in command is executed.
* @param event
*/
export async function setRangeColorInExcel(event: Office.AddinCommands.Event) {
try {
await Excel.run(async (context) => {
const range = context.workbook.getSelectedRange();
range.format.fill.color = "yellow";
await context.sync();
});
} catch (error) {
// Note: In a production add-in, notify the user through your add-in's UI.
console.error(error);
}

// Be sure to indicate when the add-in command function is complete
event.completed();
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,23 @@
* See LICENSE in the project root for license information.
*/

/* global global, Office, self, window */

Office.onReady(() => {
// If needed, Office.js is ready to be called
});
/* global Office */

/**
* Shows a notification when the add-in command is executed.
* Show an outlook notification when the add-in command is executed.
* @param event
*/
function action(event: Office.AddinCommands.Event) {
export function setNotificationInOutlook(event: Office.AddinCommands.Event) {
const message: Office.NotificationMessageDetails = {
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Performed action.",
icon: "Icon.80x80",
persistent: true,
};

// Show a notification message
// Show a notification message.
Office.context.mailbox.item.notificationMessages.replaceAsync("ActionPerformanceNotification", message);

// Be sure to indicate when the add-in command function is complete
// Be sure to indicate when the add-in command function is complete.
event.completed();
}

function getGlobal() {
return typeof self !== "undefined"
? self
: typeof window !== "undefined"
? window
: typeof global !== "undefined"
? global
: undefined;
}

const g = getGlobal() as any;

// The add-in command functions need to be available in global scope
g.action = action;
Loading