AddonSidebar is renders as collapsed when viewing WebExtensions methods docs #11613
Open
3 tasks done
Labels
🐛 bug
Something isn't working, or isn't working as expected
idle
layout
Issues related to alignment, positioning and spacing/margin/padding
macros
tracking issues related to kumascript macros
on hold
Waiting on something else before this can be moved forward.
p2
We want to address this but may have other higher priority items.
sidebar/toc
Sidebar and table of contents
Summary
The
AddonsSidebar
macro does not behave as expected when viewing WebExtensions JavaScript API documentation. When visiting an API namespace page, the "JavaScript APIs" section in the left nav defaults to open, showing all of the available namespaces and highlighting the current page. But when viewing the documentation for a property of a namespace, the "JavaScript APIs" section is collapsed by default. This makes it difficult for users to orient themselves in the documentation or to find other related documentation.URL
Method: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/alarms/clear
Type: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/management/ExtensionInfo
Event: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webNavigation/onCommitted
Reproduction steps
Expected behavior
The left nav should still be expanded to the webNavigation namespace, providing easy access to other related methods, types, and events.
Actual behavior
The top level group named "JavaScript APIs" is collapsed.
Device
Desktop
Browser
Firefox
Browser version
Pre-release (e.g. Beta, Nightly or Canary)
Operating system
Mac OS
Screenshot
Anything else?
It appears that
AddonsSidebar
does not directly set theopen
property on the<details>
element used for "JavaScript APIs". Near as I can tell, the details element's open state is set bybuild/extract-sidebar.ts
. Unfortunately, I couldn't figure out how to debug this so I couldn't proactively fix it.Validations
The text was updated successfully, but these errors were encountered: