Skip to content

Commit

Permalink
Merge pull request #3277 from MicrosoftDocs/user/bhuvanap/removemv2
Browse files Browse the repository at this point in the history
Remove MV2 code from "Create an extension tutorial, part 1"
  • Loading branch information
captainbrosset authored Oct 25, 2024
2 parents d3618cf + 8588c8b commit 6f2cef4
Show file tree
Hide file tree
Showing 28 changed files with 337 additions and 245 deletions.
4 changes: 2 additions & 2 deletions microsoft-edge/developer/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ landingContent:
- text: Getting started tutorial
url: ../extensions-chromium/getting-started/index.md

- text: Port a Chromium extension to Microsoft Edge
- text: Port a Chrome extension to Microsoft Edge
url: ../extensions-chromium/developer-guide/port-chrome-extension.md
- linkListType: how-to-guide
links:
Expand All @@ -108,7 +108,7 @@ landingContent:
- text: Register as a Microsoft Edge extension developer
url: ../extensions-chromium/publish/create-dev-account.md

- text: Create a simple extension
- text: "Tutorial part 1: Display an image in a pop-up"
url: ../extensions-chromium/getting-started/part1-simple-extension.md
# =============================================================================
# Row 2 with 3 cards
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/devtools-guide-chromium/sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ When the debugger steps into code that you don't recognize, you might want to ad

See also:
* [Content scripts](https://developer.mozilla.org/Add-ons/WebExtensions/Content_scripts)
* [Create an extension tutorial, part 2](../../extensions-chromium/getting-started/part2-content-scripts.md)
* [Tutorial part 2: Use JavaScript to insert an image in the webpage](../../extensions-chromium/getting-started/part2-content-scripts.md)


<!-- ------------------------------ -->
Expand Down
4 changes: 2 additions & 2 deletions microsoft-edge/extensions-chromium/developer-guide/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,8 @@ See [Types](https://developer.chrome.com/docs/extensions/reference/sidePanel/#ty
* [Supported APIs for Microsoft Edge extensions](../developer-guide/api-support.md)
* [Declare API permissions in the manifest](../developer-guide/declare-permissions.md)
* [Manifest file format for extensions](../getting-started/manifest-format.md)
* [Create an extension tutorial, part 1](../getting-started/part1-simple-extension.md)
* [Create an extension tutorial, part 2](../getting-started/part2-content-scripts.md)
* [Tutorial part 1: Display an image in a pop-up](../getting-started/part1-simple-extension.md)
* [Tutorial part 2: Use JavaScript to insert an image in the webpage](../getting-started/part2-content-scripts.md)


<!-- ====================================================================== -->
Expand Down
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,42 +1,66 @@
---
title: Sideload an extension
description: How to test an extension by sideloading it in the browser.
title: Sideload an extension to install and test it locally
description: Test an extension locally by sideloading it, so that it's locally installed in your instance of Microsoft Edge.
author: MSEdgeTeam
ms.author: msedgedevrel
ms.topic: conceptual
ms.service: microsoft-edge
ms.subservice: extensions
ms.date: 11/07/2022
ms.date: 10/04/2024
---
# Sideload an extension
# Sideload an extension to install and test it locally

During development, you can use Microsoft Edge browser to run and debug your extension safely. By sideloading your extension locally in your browser, you can run and test your extension without changing any settings. This helps you test new extensions safely.
To test an extension quickly and safely, sideload the extension in your own copy of Microsoft Edge, which means locally installing the extension. You can then run and test your extension without having to upload the extension to the Microsoft Edge Add-ins website (the _store_) and then install the extension from there.

To sideload an extension into Microsoft Edge:

1. In Microsoft Edge, select **Settings and more** (...) > **Extensions**.
<!-- ====================================================================== -->
## Locally installing and running an extension

![Opening the edge://extensions page](./extension-sideloading-images/part1-threedots.png)
To sideload an extension into Microsoft Edge, so that it's locally installed in your browser for testing:

The **Extensions** pop-up box opens.
1. In Microsoft Edge, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button, next to the Address bar, if this icon is displayed. Or, select **Settings and more** (...) > **Extensions**. The **Extensions** pop-up opens:

1. Click **Manage extensions**. The **Extensions** page (`edge://extensions`) opens in a new tab.
![The Extensions popup when no extensions are installed](./extension-sideloading-images/extensions-popup-no-extensions.png)

1. Turn on the **Developer mode** toggle:
1. Click **Manage extensions**. The **Extensions** management page opens in a new tab:

![Turning on Developer Mode](./extension-sideloading-images/part1-developermode-toggle.png)

1. When installing your extension for the first time, click the **Load unpacked** button. The **Select the extension directory** dialog opens.
1. Turn on the **Developer mode** toggle.

1. When installing your extension for the first time, click the **Load unpacked** (![The "Load unpacked" icon](./extension-sideloading-images/load-unpacked-icon.png)) button. The **Select the extension directory** dialog opens.

1. Select the directory that contains the extension's source files, such as `manifest.json`, and then click the **Select Folder** button.

Example path for [Tutorial part 1: Display an image in a pop-up](./part1-simple-extension.md):

`C:\Users\myUsername\GitHub\MicrosoftEdge-Extensions\Extension samples\extension-getting-started-part1\part1\`

1. Select the directory that contains your extension source files, and then click the **Select Folder** button. Your extension is installed in your browser, similar to extensions that are installed from the store:
Example path for [Tutorial part 2: Use JavaScript to insert an image in the webpage](./part2-content-scripts.md):

`C:\Users\myUsername\GitHub\MicrosoftEdge-Extensions\Extension samples\extension-getting-started-part2\extension-getting-started-part2\`

The extension is installed in your browser, similar to extensions that are installed from the store:

![Installed extensions page, showing a sideloaded extension](./extension-sideloading-images/part1-installed-extension.png)

1. To run the extension, first open a webpage, if the extension requires that a webpage is open. For example, go to a webpage, such as [Microsoft.com](https://www.microsoft.com), in a new window or tab.

1. In the upper right of Microsoft Edge, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. Or, select **Settings and more** (...) > **Extensions**.

The **Extensions** pop-up opens:

![The Extensions pop-up](./extension-sideloading-images/extensions-popup.png)

1. Click the extension's icon or name. The extension opens, and the extension's icon is added next to the Address bar and Extensions (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) icon:

![An extension running](./extension-sideloading-images/extension-running.png)


<!-- ====================================================================== -->
## Updating an extension
## Locally updating an extension

To update a sideloaded extension:
To update an extension that's been installed locally (sideloaded) in your browser:

1. Make any required changes to the extension.

Expand All @@ -46,10 +70,18 @@ To update a sideloaded extension:


<!-- ====================================================================== -->
## Removing an extension
## Locally removing an extension

To remove the extension from your browser:
To remove an extension that's been installed locally (sideloaded) in your browser:

1. Go to `edge://extensions`.

1. On the extension, click **Remove**.


<!-- ====================================================================== -->
## See also
<!-- all links in article -->

* [Tutorial part 1: Display an image in a pop-up](./part1-simple-extension.md)
* [Tutorial part 2: Use JavaScript to insert an image in the webpage](./part2-content-scripts.md)
3 changes: 2 additions & 1 deletion microsoft-edge/extensions-chromium/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ ms.subservice: extensions
ms.date: 02/06/2022
---
# Extension concepts and architecture
<!-- https://aka.ms/EdgeAddonsLearn -->

This article introduces concepts about building a Microsoft Edge extension. Follow along to understand how multi-tab browsers work.

Expand Down Expand Up @@ -72,4 +73,4 @@ An extension provides opt-in permissions at install time. You specify the exten
<!-- ====================================================================== -->
## Next steps

For information on getting started with your extension, see [Create an extension tutorial, part 1](part1-simple-extension.md).
For information on getting started with your extension, see [Tutorial part 1: Display an image in a pop-up](part1-simple-extension.md).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6f2cef4

Please sign in to comment.