ladybird/Documentation/AddNewIDLFile.md

# 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`.

1. Create `LibWeb/HTML/HTMLDetailsElement.idl` with the contents of the IDL section of the spec. In this case, that would be:
```webidl
[Exposed=Window]
interface HTMLDetailsElement : HTMLElement {
    [HTMLConstructor] constructor();

    [CEReactions] attribute boolean open;
};
```

2. Add the IDL file to [`LibWeb/idl_files.cmake`](../Libraries/LibWeb/idl_files.cmake).

3. Forward declare the generated class in [`LibWeb/Forward.h`](../Libraries/LibWeb/Forward.h):
    - `HTMLDetailsElement` in its namespace.
Documentation: Add documentation for adding IDL files There are several steps involved, which are not at all obvious unless you already know them. So now they're written down. :^) 2021-10-03 17:32:01 -03:00			`# Adding a new IDL file`

Documentation: Remove SerenityOS references where appropriate 2024-11-22 12:33:33 -03:00			`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.`
Documentation: Add documentation for adding IDL files There are several steps involved, which are not at all obvious unless you already know them. So now they're written down. :^) 2021-10-03 17:32:01 -03:00
			For the sake of example, let's say you're wanting to add the `HTMLDetailsElement`.

			1. Create `LibWeb/HTML/HTMLDetailsElement.idl` with the contents of the IDL section of the spec. In this case, that would be:
			```webidl
			`[Exposed=Window]`
			`interface HTMLDetailsElement : HTMLElement {`
			`[HTMLConstructor] constructor();`

			`[CEReactions] attribute boolean open;`
			`};`
			```

LibWeb: Treat support IDLs like normal bindings inputs Allow the WebIDL parser to accept files without a top-level interface, and have the exposed-interface generator skip those modules. With that in place, register support IDLs through libweb_js_bindings() as well, including generated CSS IDLs from the build directory, and remove the separate support-idl plumbing. This is enabled now that the IDL generator rules have been simplified so that every IDL file produces a corresponding header and cpp file. 2026-05-09 11:32:33 -03:00			2. Add the IDL file to [`LibWeb/idl_files.cmake`](../Libraries/LibWeb/idl_files.cmake).
Documentation: Add documentation for adding IDL files There are several steps involved, which are not at all obvious unless you already know them. So now they're written down. :^) 2021-10-03 17:32:01 -03:00
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-01 11:12:15 -03:00			3. Forward declare the generated class in [`LibWeb/Forward.h`](../Libraries/LibWeb/Forward.h):
Documentation: Add documentation for adding IDL files There are several steps involved, which are not at all obvious unless you already know them. So now they're written down. :^) 2021-10-03 17:32:01 -03:00			- `HTMLDetailsElement` in its namespace.