downloads.setShelfEnabled()

The setShelfEnabled() function of the downloads API enables or disables the gray shelf at the bottom of every window associated with the current browser profile. The shelf will be disabled as long as at least one extension has disabled it.

If you try to enable the shelf when at least one other extension has already disabled it, the call will fail and runtime.lastError will be set with an appropriate error message.

Note: To use this function in your extension you must ask for the "downloads.shelf" manifest permission, as well as the "downloads" permission.

Syntax

chrome.downloads.setShelfEnabled(enabled);

This API is also available as browser.downloads.setShelfEnabled().

Parameters

enabled
A boolean representing the state that you want to set setShelfEnabled() to — true for enable, and false for disable.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge No support NoFirefox No support NoOpera Full support YesFirefox Android No support No

Legend

Full support  
Full support
No support  
No support

Acknowledgements

This API is based on Chromium's chrome.downloads API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

Contributors to this page: andrewtruongmoz, Makyen, wbamberg, chrisdavidmills
Last updated by: andrewtruongmoz,