La API de JavaScript de Discourse permite a los temas y complementos realizar amplias personalizaciones de la experiencia del usuario. La forma más sencilla de utilizarla es crear un nuevo tema desde el panel de administración, hacer clic en “Editar código” y luego ir a la pestaña JS.
Para los temas basados en archivos, la API se puede utilizar creando un archivo en el directorio api-initializers. Para los temas es {theme}/javascripts/api-initializers/init-theme.gjs, y para los complementos, es {plugin}/assets/javascripts/discourse/api-initializers/init-plugin.js. El contenido debe ser:
import { apiInitializer } from "discourse/lib/api";
export default apiInitializer((api) => {
// Tu código aquí
});
Todas las API disponibles se enumeran en el código fuente de plugin-api.gjs en el núcleo de Discourse, junto con una breve descripción y ejemplos.
Para un tutorial completo, que incluye ejemplos de uso de la API de JS, consulta:
Este documento está controlado por versiones: sugiere cambios en github.
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?
