Edge API

This section details the API for interacting with the Microsoft Edge browser features and capabilities. This API allows developers to extend and integrate with Edge's functionalities in a secure and controlled manner.

Introduction

The Edge API provides access to various browser features, enabling richer web applications and extensions. It is designed with security and performance in mind, adhering to modern web standards and best practices.

Key Features

• Navigation Control: Programmatically navigate to URLs, manage browsing history, and control tab behavior.
• Content Access: Safely access and manipulate page content, including DOM elements and metadata.
• Extension Integration: Develop extensions that can interact with the browser and other web content.
• Platform Features: Leverage underlying operating system features through browser APIs, where applicable and secure.

API Reference

edge.tabs

Provides methods for managing browser tabs.

Methods:

Method	Description	Parameters	Returns
edge.tabs.create(options)	Creates a new tab.	options (object) - url (string, optional): The URL to load in the new tab. - active (boolean, optional): Whether the new tab should be active.	Promise<Tab>
edge.tabs.query(queryInfo)	Gets information about one or more tabs.	queryInfo (object) - active (boolean, optional): Whether the tab is active. - url (string | RegExp, optional): The URL of the tab.	Promise<Array<Tab>>
edge.tabs.update(tabId, updateProperties)	Updates the properties of a tab.	tabId (number) updateProperties (object) - url (string, optional): The new URL to navigate to. - active (boolean, optional): Whether to make the tab active.	Promise<Tab>
edge.tabs.remove(tabId)	Closes one or more tabs.	tabId (number | Array<number>)	Promise<void>

Tab Object:

Represents a browser tab.

• id (number): The ID of the tab.
• url (string): The URL of the tab.
• title (string): The title of the tab.
• active (boolean): Whether the tab is active.
• windowId (number): The ID of the window the tab belongs to.

edge.windows

Provides methods for managing browser windows.

Methods:

Method	Description	Parameters	Returns
edge.windows.create(options)	Creates a new browser window.	options (object, optional) - url (string, optional): The URL to load in the first tab. - focused (boolean, optional): Whether the new window should be focused.	Promise<Window>
edge.windows.getCurrent(options)	Gets the current window.	options (object, optional) - populate (boolean, optional): Whether to include tabs in the returned Window object.	Promise<Window>

Window Object:

Represents a browser window.

• id (number): The ID of the window.
• tabs (Array<Tab>, optional): An array of tabs in the window.
• focused (boolean): Whether the window is focused.

Permissions

To use the Edge API, you may need to declare permissions in your web application's manifest. The specific permissions depend on the features you intend to use.

{
  "manifest_version": 3,
  "name": "My Edge Extension",
  "version": "1.0",
  "permissions": [
    "tabs",
    "windows",
    "activeTab"
  ],
  "action": {
    "default_popup": "popup.html"
  }
}

Examples

Creating a new tab:

edge.tabs.create({ url: "https://example.com", active: true }).then(tab => {
    console.log(`New tab created with ID: ${tab.id}`);
});

Getting all active tabs:

edge.tabs.query({ active: true }).then(tabs => {
    tabs.forEach(tab => {
        console.log(`Active tab: ${tab.title} (${tab.url})`);
    });
});