# Developer Toolbox

**URL:** https://meta.discourse.org/t/developer-toolbox/239148
**Category:** Theme component
**Tags:** official, development, developer-toolbox
**Created:** [September 16, 2022, 12:06am UTC](https://meta.discourse.org/t/developer-toolbox/239148 "2022-09-16T00:06:02Z")
**Posts on this page:** 13
**Page:** 1

<div class="post-metadata">

### Author: ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse)
#### Post date: [September 16, 2022, 12:06am UTC](https://meta.discourse.org/t/developer-toolbox/239148/1 "2022-09-16T00:06:02Z")

</div>

| | | |
| --- | --- | --- |
| :discourse2: | **Summary** | **Developer Toolbox** gives quick access to common links, actions, and settings often used when developing with Discourse. |
| 🛠 | **Repository Link** | [https://github.com/discourse/discourse-dev-utils](https://github.com/discourse/discourse-dev-utils) |
| 📖 | **New to Discourse Themes?** | [Beginner’s guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) |

> ℹ For local development use only. Not useful for production sites

> [@](#):
>
> :discourse2: As this is an #official theme component maintained by the Discourse team, #Support, #Contribute > Bug, #Contribute > UX, and #Contribute > Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate theme component tag. Click on a link below to get one started. 👍
> 
> [❓&nbsp; **Support**](https://meta.discourse.org/new-topic?category_id=6&tags=developer-toolbox "Ask for support on configuring and using Developer Toolbox") [🐛&nbsp; **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=developer-toolbox "A bug report means something is broken, preventing normal/typical use of the theme component") [👀&nbsp; **UX**](https://meta.discourse.org/new-topic?category_id=9&tags=developer-toolbox "Discussion about the user interface of Developer Toolbox, and how features are presented (including language and UI elements)") [💡&nbsp; **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=developer-toolbox "Discussion about how existing Developer Toolbox features can be improved or enhanced, and how proposed new features could work")

### Features

 ![developer toolbox example](https://global.discourse-cdn.com/meta/original/4X/c/b/0/cb0115eb0c542917fdbe228ff473b9d13da74894.png)

### How it works

The component is designed by default to be unobtrusive, so you trigger a modal by tapping the grave slash ` character on your keyboard. Alternatively, you can enable a trigger button in the UI by toggling a theme setting.

Once the modal appears you have access to some common actions, links and settings that you might typically need while developing with Discourse.

### Settings

| Name | Description |
| --- | --- |
| show header button | Show the trigger for the dev toolbox in the header panel |
| remove button from flow | Fixes the header button to bottom right. (Requires show\_header\_button to be enabled) |
| actions close modal | Triggering an action in the toolbox will also close the toolbox modal. |
| custom links | |

| Translation | Default |
| --- | --- |
| dev\_utils.toggle\_btn | Dev Toolbox |
| dev\_utils.modal.title | Developer Toolbox |
| dev\_utils.modal.cancel | Cancel |
| dev\_utils.actions.title | Quick Actions |
| dev\_utils.actions.toggle\_alerts | Toggle Alerts |
| dev\_utils.actions.toggle\_plugin\_outlets | Toggle Outlets |
| dev\_utils.links.title | Quick Links |
| dev\_utils.links.themes | Themes |
| dev\_utils.links.components | Theme Components |
| dev\_utils.links.colors | Colors |
| dev\_utils.links.settings | Settings |
| dev\_utils.links.plugins | Plugins |
| dev\_utils.links.user\_prefs | User Preferences |
| dev\_utils.links.text | Text |
| dev\_utils.links.plugin\_api | Plugin API |
| dev\_utils.links.docs | Discourse Docs |
| dev\_utils.common\_settings.title | Common Settings |
| dev\_utils.common\_settings.none | Select a setting |

> Last edited by @JammyDodger 2024-06-15T18:10:29Z
> 
> > **Check document**
> >
> > Perform check on document:

---

<div class="post-metadata">

### Author: ![manuel](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/manuel/32/468169_2.png) [@manuel](https://meta.discourse.org/u/manuel)
#### Post date: [October 11, 2022, 11:15am UTC](https://meta.discourse.org/t/developer-toolbox/239148/2 "2022-10-11T11:15:45Z")

</div>

Thank you for this great component, Keegan!

Right now the header icon always shows. A small improvement could be to only show it to admins. So when browsing the site as a regular user the look is not tweaked.

---

<div class="post-metadata">

### Author: ![Lilly](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lilly/32/575047_2.png) [@Lilly](https://meta.discourse.org/u/Lilly)
#### Post date: [June 8, 2023, 2:08pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/3 "2023-06-08T14:08:17Z")

</div>

i quite like this component. thank you! 🙂 👍

i just noticed that the Discourse Docs button goes to the Plugin API link instead of docs.

---

<div class="post-metadata">

### Author: ![keegan](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/keegan/32/383395_2.png) [@keegan](https://meta.discourse.org/u/keegan)
#### Post date: [June 14, 2023, 6:57pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/4 "2023-06-14T18:57:29Z")

</div>

> [@Lilly](#):
>
> Discourse Docs button goes to the Plugin API link instead of docs.

Thanks for identifying that @Lilly, I’ve pushed an update resolving this:

> <https://github.com/discourse/discourse-dev-utils/pull/2/files>
>
> This PR fixes an issue where the \<kbd\>Discourse Docs\</kbd\> button link was direc…ting to the \`plugin-api.js\` file instead of \[\`https://docs.discourse.org\`\](https://docs.discourse.org)

> [@manuel](#):
>
> small improvement could be to only show it to admins.

Thanks for the request @manuel, I’ve added this now:

> <https://github.com/discourse/discourse-dev-utils/commit/2fa8afd46fcf6e729d818cdae707339767a7e54f>

---

<div class="post-metadata">

### Author: ![denvergeeks](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/denvergeeks/32/327671_2.png) [@denvergeeks](https://meta.discourse.org/u/denvergeeks)
#### Post date: [July 13, 2023, 11:23pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/5 "2023-07-13T23:23:31Z")

</div>

This looks very good – I need to identify all of the outlets, but both Toggle Outlets and Toggle Alerts seem to do nothing except close the modal.

Are they supposed to display/show or highlight something on screen when toggled on?

---

<div class="post-metadata">

### Author: ![denvergeeks](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/denvergeeks/32/327671_2.png) [@denvergeeks](https://meta.discourse.org/u/denvergeeks)
#### Post date: [July 15, 2023, 12:05am UTC](https://meta.discourse.org/t/developer-toolbox/239148/6 "2023-07-15T00:05:45Z")

</div>

Adding/installing this theme component in addition to the Developer Toolbox makes the Toggle Outlets button work…

[https://github.com/communiteq/plugin-outlets-theme-component](https://github.com/communiteq/plugin-outlets-theme-component)

---

<div class="post-metadata">

### Author: ![Alteras](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/alteras/32/179824_2.png) [@Alteras](https://meta.discourse.org/u/Alteras)
#### Post date: [May 16, 2024, 8:39pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/7 "2024-05-16T20:39:42Z")

</div>

The Plugin API link is not opening the file. Seems like it needs to be updated to `app/assets/javascripts/discourse/app/lib/plugin-api.gjs`?

---

<div class="post-metadata">

### Author: ![Arkshine](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/arkshine/32/298682_2.png) [@Arkshine](https://meta.discourse.org/u/Arkshine)
#### Post date: [May 16, 2024, 9:45pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/8 "2024-05-16T21:45:12Z")

</div>

Thanks, I made the PR 👍

[https://github.com/discourse/discourse-dev-utils/pull/13](https://github.com/discourse/discourse-dev-utils/pull/13)

---

<div class="post-metadata">

### Author: ![keegan](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/keegan/32/383395_2.png) [@keegan](https://meta.discourse.org/u/keegan)
#### Post date: [May 17, 2024, 8:26pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/9 "2024-05-17T20:26:03Z")

</div>

Thanks @Arkshine for the fix, I’ve merged that in 🎉

I’ve also added a few [updates (fixes/modernizations)](https://github.com/discourse/discourse-dev-utils/pull/14) as well as a new feature where you can now add custom links by defining them in the theme setting:

 ![The image displays a dark-themed graphical user interface for editing custom links, with fields to input a name, icon, and link for a particular settings item titled "AI Settings." (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/8/9/8/89881db1a2d87f3ca7670e75f515206bb8fd3f44.png)

 ![The image displays a dark-themed "Developer Toolbox" menu with various options such as Quick Actions and Quick Links related to software development tasks and settings. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/6/d/4/6d411a105d13446ce6fcaae0e77c784dab5b9056.png)

---

<div class="post-metadata">

### Author: ![th21](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/th21/32/211915_2.png) [@th21](https://meta.discourse.org/u/th21)
#### Post date: [November 17, 2024, 7:30am UTC](https://meta.discourse.org/t/developer-toolbox/239148/10 "2024-11-17T07:30:09Z")

</div>

Can we submit translation for this component on crowdin? I didn’t find the entrance to it.

---

<div class="post-metadata">

### Author: ![Lilly](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/lilly/32/575047_2.png) [@Lilly](https://meta.discourse.org/u/Lilly)
#### Post date: [December 1, 2024, 6:16pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/13 "2024-12-01T18:16:00Z")

</div>

Hi @th21 thanks for letting us know. I have added it as a translation project in Crowdin.

---

<div class="post-metadata">

### Author: ![th21](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/th21/32/211915_2.png) [@th21](https://meta.discourse.org/u/th21)
#### Post date: [February 6, 2025, 12:13am UTC](https://meta.discourse.org/t/developer-toolbox/239148/17 "2025-02-06T00:13:00Z")

</div>

What is the expected result of “Toggle Alerts”? clicked and nothing happened

---

<div class="post-metadata">

### Author: ![keegan](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/keegan/32/383395_2.png) [@keegan](https://meta.discourse.org/u/keegan)
#### Post date: [February 6, 2025, 4:02pm UTC](https://meta.discourse.org/t/developer-toolbox/239148/18 "2025-02-06T16:02:15Z")

</div>

It is intended to hide any alerts you have on your Discourse instance. If you have any alerts on your forum like this:

 ![Screenshot 2025-02-06 at 08.01.06](https://global.discourse-cdn.com/meta/original/4X/9/a/5/9a5b66ca2bf83275b1a60c5d6a4f005da267a466.png)

It will hide it from the page. It’s quite useful for example, when theming and you want to temporarily see the page without any alerts.
