Die JavaScript-API von Discourse ermöglicht es Themes und Plugins, umfassende Anpassungen am Nutzererlebnis vorzunehmen. Der einfachste Weg, sie zu nutzen, besteht darin, im Admin-Bereich ein neues Theme zu erstellen, auf „Code bearbeiten“ zu klicken und dann zum JS-Tab zu wechseln.
Bei dateibasierten Themes kann die API genutzt werden, indem eine Datei im Verzeichnis api-initializers erstellt wird. Für Themes lautet der Pfad {theme}/javascripts/api-initializers/init-theme.gjs, für Plugins {plugin}/assets/javascripts/discourse/api-initializers/init-plugin.js. Der Inhalt sollte wie folgt aussehen:
import { apiInitializer } from "discourse/lib/api";
export default apiInitializer((api) => {
// Dein Code hier
});
Alle verfügbaren APIs sind im Quellcode von plugin-api.gjs im Discourse-Kernel aufgeführt, jeweils mit einer kurzen Beschreibung und Beispielen.
Für ein vollständiges Tutorial, einschließlich von Beispielen zur Nutzung der JS-API, schau hier:
Dieses Dokument wird versioniert – Änderungen können auf GitHub vorgeschlagen werden.
What’s the best way to “import” as a Site Customisation? - is it just to use require?
Whilst this works:
<script type="text/discourse-plugin" version="0.1">
var HamburgerMenuComponent = require('discourse/components/hamburger-menu').default;
</script>
This does not:
<script type="text/discourse-plugin" version="0.1">
import {default as HamburgerMenuComponent2 } from 'discourse/components/hamburger-menu';
</script>
Where I get this error:
<script type="text/discourse-js-error">unknown: 'import' and 'export' may only appear at the top level (3:0)
1 | Discourse._registerPluginCode('0.1', api => {
2 |
> 3 | import {default as HamburgerMenuComponent2 } from 'discourse/components/hamburger-menu';
| ^
4 |
5 |
6 | }); at <eval>:8695:14</script>
Is there a way to get access to the h helper from virtual-dom in a site customization? I’m trying to add a simple dropdown widget to use in our header, and I can’t get that darned h, even though I can get createWidget
I wouldn’t recommend doing it that way as it would likely break future compatibility. You can use this for now but I’ll try to introduce a workaround shortly that will be safer long term.
Makes sense, it’s kinda circumventing the whole Plugin API thing and relying on implementation details of the ES6 compilation output, both things that are Dangerous™
Anyways, I’ll definitely keep an eye out for a better solution
Actually thinking about it, the decorateWidget helper gets called with an object that has the h method. How are you inserting your widget if not via a decorator?
