Skip to content

Commit d94292b

Browse files
committed
Update Sideload article
1 parent b091a40 commit d94292b

13 files changed

Lines changed: 79 additions & 24 deletions
73.2 KB
Loading
-83.4 KB
Loading
-51.8 KB
Loading
-136 KB
Loading
92.1 KB
Loading
609 Bytes
Loading

microsoft-edge/extensions-chromium/getting-started/extension-sideloading.md

Lines changed: 70 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,77 +6,129 @@ ms.author: msedgedevrel
66
ms.topic: conceptual
77
ms.service: microsoft-edge
88
ms.subservice: extensions
9-
ms.date: 10/04/2024
9+
ms.date: 01/15/2025
1010
---
1111
# Sideload an extension to install and test it locally
1212

1313
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.
1414

1515

16+
<!-- ====================================================================== -->
17+
## Prerequisite: Have an extension to install
18+
19+
This article assumes that your local drive contains an extension that you want to load, such as a sample from the [MicrosoftEdge-Extensions](https://github.com/microsoft/MicrosoftEdge-Extensions) repo.
20+
21+
If you want to obtain the samples, see [Clone the MicrosoftEdge-Extensions repo](./picture-viewer-popup-webpage.md#clone-the-microsoftedge-extensions-repo) in _Sample: Picture viewer pop-up webpage_.
22+
23+
1624
<!-- ====================================================================== -->
1725
## Locally installing and running an extension
1826

1927
To sideload an extension into Microsoft Edge, so that it's locally installed in your browser for testing:
2028

21-
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:
29+
1. Go to a webpage, such as [TODO app](https://microsoftedge.github.io/Demos/demo-to-do/), in a new window or tab. For some samples, this step is optional and is just to match the screenshots below; some samples don't require a webpage to be open.
30+
31+
1. In Microsoft Edge to the right of the Address bar, if this icon is displayed, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. Or, select **Settings and more** (![The "Settings and more" icon](./extension-sideloading-images/settings-and-more-icon.png)) > **Extensions**.
32+
33+
The **Extensions** pop-up opens:
2234

2335
![The Extensions popup when no extensions are installed](./extension-sideloading-images/extensions-popup-no-extensions.png)
2436

2537
1. Click **Manage extensions**. The **Extensions** management page opens in a new tab:
2638

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

2941
1. Turn on the **Developer mode** toggle.
3042

3143
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.
3244

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

35-
Example path for [Sample: Picture viewer pop-up webpage](./picture-viewer-popup-webpage.md):
47+
Example path for the **Picture viewer pop-up webpage** sample:
3648

37-
`C:\Users\myUsername\GitHub\MicrosoftEdge-Extensions\Extension samples\extension-getting-started-part1\part1\`
49+
`C:\Users\localAccount\GitHub\MicrosoftEdge-Extensions\Extension samples\picture-viewer-popup-webpage`
3850

39-
Example path for [Sample: Picture inserter using content script](./picture-inserter-content-script.md):
51+
Example path for the **Picture inserter using content script** sample:
4052

41-
`C:\Users\myUsername\GitHub\MicrosoftEdge-Extensions\Extension samples\extension-getting-started-part2\extension-getting-started-part2\`
53+
`C:\Users\localAccount\GitHub\MicrosoftEdge-Extensions\Extension samples\picture-inserter-content-script`
54+
55+
1. Click the **Select Folder** button.
56+
57+
The **Select the extension directory** dialog closes.
4258

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

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

47-
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.
63+
1. If the extension requires that a webpage is open, make sure a webpage is open, such as [TODO app](https://microsoftedge.github.io/Demos/demo-to-do/).
4864

49-
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**.
65+
1. In Microsoft Edge to the right of the Address bar, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. Or, select **Settings and more** (![The "Settings and more" icon](./extension-sideloading-images/settings-and-more-icon.png)) > **Extensions**.
5066

5167
The **Extensions** pop-up opens:
5268

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

55-
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:
71+
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)) button:
5672

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

5975

6076
<!-- ====================================================================== -->
61-
## Locally updating an extension
77+
## Locally updating an extension (Reload)
6278

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

65-
1. Make any required changes to the extension.
81+
1. Make any required changes to the extension, and save changes.
82+
83+
1. In Microsoft Edge, if the **Extensions** management tab is open, click it.
84+
85+
Or, to the right of the Address bar, if this icon is displayed, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. The **Extensions** pop-up opens. Click **Manage extensions**.
6686

67-
1. Go to `edge://extensions`.
87+
Or, select **Settings and more** (![The "Settings and more" icon](./extension-sideloading-images/settings-and-more-icon.png)) > **Extensions** > **Manage extensions**.
6888

69-
1. Click the **Reload** button for the sideloaded extension. The updated extension is reloaded.
89+
The **Extensions** management tab is displayed.
90+
91+
1. Click the **Reload** link in the extension's card.
92+
93+
1. Depending on the sample, you might need to refresh the webpage where the sample was run.
7094

7195

7296
<!-- ====================================================================== -->
7397
## Locally removing an extension
7498

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

77-
1. Go to `edge://extensions`.
101+
1. In Microsoft Edge, if the **Extensions** management tab is open, click it.
102+
103+
Or, to the right of the Address bar, if this icon is displayed, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. The **Extensions** pop-up opens. Click **Manage extensions**.
104+
105+
Or, select **Settings and more** (![The "Settings and more" icon](./extension-sideloading-images/settings-and-more-icon.png)) > **Extensions** > **Manage extensions**.
106+
107+
The **Extensions** management tab is displayed.
108+
109+
1. Click the **Remove** link in the extension's card.
110+
111+
112+
<!-- ====================================================================== -->
113+
## Error reporting in the Extensions management page
114+
115+
If running an extension causes an error, in some cases, an **Error** link is added in the extension's card in the **Extensions** management page between the **Remove** and **Reload** links.
116+
117+
1. In Microsoft Edge, if the **Extensions** management tab is open, click it.
118+
119+
Or, to the right of the Address bar, if this icon is displayed, click the **Extensions** (![Extensions icon](./extension-sideloading-images/extensions-icon.png)) button. The **Extensions** pop-up opens. Click **Manage extensions**.
120+
121+
Or, select **Settings and more** (![The "Settings and more" icon](./extension-sideloading-images/settings-and-more-icon.png)) > **Extensions** > **Manage extensions**.
122+
123+
The **Extensions** management tab is displayed.
124+
125+
1. Click the **Error** link in the extension's card.
126+
127+
1. Fix the error in the extension's code.
128+
129+
1. In the **Extensions** management page, click the **Reload** link.
78130

79-
1. On the extension, click **Remove**.
131+
1. To make the **Error** link in the extension's card go away, in the **Extensions** management page, click the **Clear errors** button.
80132

81133

82134
<!-- ====================================================================== -->
609 Bytes
Loading

0 commit comments

Comments
 (0)