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.

Sign up for GitHub

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

Jump to bottom

Add devtools.panels.ExtensionSidebarPane.setHeight #32150

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+80 −0
Open

Add devtools.panels.ExtensionSidebarPane.setHeight #32150

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb0238c
Add devtools.panels.ExtensionSidebarPane.setHeight
rebloor Feb 7, 2024
dadcb54
Merge branch 'main' into add-devtools.panels.ExtensionSidebarPane.set…
rebloor Sep 10, 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
2 changes: 2 additions & 0 deletions ...mozilla/add-ons/webextensions/api/devtools/panels/extensionsidebarpane/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ To create an `ExtensionSidebarPane`, call the [`browser.devtools.panels.elements

- [`devtools.panels.ExtensionSidebarPane.setExpression()`](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools/panels/ExtensionSidebarPane/setExpression)
- : Evaluate a JavaScript expression in the web page that the inspector is inspecting. The result is displayed in the sidebar pane.
- [`devtools.panels.ExtensionSidebarPane.setHeight()`](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools/panels/ExtensionSidebarPane/setHeight)
- : Sets the height of the sidebar.
- [`devtools.panels.ExtensionSidebarPane.setObject()`](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools/panels/ExtensionSidebarPane/setObject)
- : Sets a JSON object that will be displayed in the sidebar pane.
- [`devtools.panels.ExtensionSidebarPane.setPage()`](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools/panels/ExtensionSidebarPane/setPage)
Expand Down
78 changes: 78 additions & 0 deletions ...d-ons/webextensions/api/devtools/panels/extensionsidebarpane/setheight/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: devtools.panels.ExtensionSidebarPane.setHeight()
slug: Mozilla/Add-ons/WebExtensions/API/devtools/panels/ExtensionSidebarPane/setHeight
page-type: webextension-api-function
browser-compat: webextensions.api.devtools.panels.ExtensionSidebarPane.setHeight
---

{{AddonSidebar}}

Sets the height of the sidebar.

This is an asynchronous function that returns a [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
Copy link
Collaborator

Choose a reason for hiding this comment

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

According to mdn/browser-compat-data#22182 this method is only supported in Chrome. Chrome's implementation does return a promise or accept a callback. When called, it immediately returns undefined.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dotproto however, although this is an implemented in Firefox, currently the documentation is written from a Firefox perspective e.g. if this was implemented in Firefox, would it not be implemented as an asynchronous function that returns a promise?


## Syntax

```js-nolint
let setting = browser.devtools.panels.setHeight(
height, // string
)
Comment on lines +17 to +19
Copy link
Collaborator

Choose a reason for hiding this comment

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

The setHeight() method is exposed on the ExtensionSidebarPane interface, not on the panels namespace in devtools. To my knowledge the only way to get a reference to an instance of this this interface is to create a pane using the createSidebarPane() method on certain ExtensionPanel instances: elements, network, and sources. Chrome supports all 3 of these, but Firefox only supports elements.

Please adapt this code to the appropriate conventions.

Suggested change
let setting = browser.devtools.panels.setHeight(
height, // string
)
browser.devtools.panels.elements.createSidebarPane("My Pane", (pane) => {
pane.setPage("elements-pane.html");
pane.setHeight("200px");
});

```

### Parameters

- `height`
- : `String` A CSS-like size specification, such as '100px' or '12ex'.

### Return value

A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that is fulfilled with no arguments when the height has been set.

## Examples

Create a new pane, populate it with an HTML page, and set the pane's height. You could run this code in a script loaded by your extension's [devtools page](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/devtools_page).

```js
function onCreated(sidebarPane) {
sidebarPane.setPage("sidebar/sidebar.html");
sidebarPane.setHeight("100px");
}
```

{{WebExtExamples}}

## Browser compatibility

{{Compat}}

> **Note:** This API is based on Chromium's [`chrome.devtools.panels`](https://developer.chrome.com/docs/extensions/reference/devtools_panels/) API.
Copy link
Contributor

Choose a reason for hiding this comment

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

[markdownlint] reported by reviewdog 🐶
search-replace Custom rule [gfm-alert: Use the GFM syntax: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#notes_warnings_and_callouts] [Context: "column: 1 text:'> Note:'"]


<!--
// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
Loading