Shannon Booth 0a8ff78675 Documentation: Update AddNewIDLFile for current IDL workflow

Remove stale #import guidance and clarify when to use
libweb_js_bindings() versus libweb_support_idl() when adding new IDL
files.

2026-05-03 10:56:45 +02:00

Adding a new IDL file

Ladybird's build system does a lot of work of turning the IDL from a Web spec into code, but there are a few things you'll need to do yourself.

For the sake of example, let's say you're wanting to add the HTMLDetailsElement.

Create LibWeb/HTML/HTMLDetailsElement.idl with the contents of the IDL section of the spec. In this case, that would be:

[Exposed=Window]
interface HTMLDetailsElement : HTMLElement {
    [HTMLConstructor] constructor();

    [CEReactions] attribute boolean open;
};

Add the IDL file to LibWeb/idl_files.cmake:
- Use libweb_js_bindings(HTML/HTMLDetailsElement) for top-level interfaces.
- Use libweb_support_idl(...) for support IDL files that do not generate a top-level bindings class.
Forward declare the generated class in LibWeb/Forward.h:
- HTMLDetailsElement in its namespace.