Add verifiedInnerHtml

[cornusandu]

Overview

Added verifiedInnerHtml, a safer way of using hardcoded innerHtml.

Simply add innerHTML values to public/Assets/data/innerHtmlList.toml, and you can then use them!

Writing innerHTML

There are four syntax features worth noting:

1. Referencing locales

Simply reference a locale by doing [[locale <localeKey>]].

Example: [[locale status.trusted.warning]]

2. Referencing other innerHTML keys

Reference another innerHTML key by doing [[innerhtml <key>]].

Example: [[innerhtml some.other.key]]

Note

If two innerHTML keys reference eachother, the parser will resolve this by replacing one with (unbounded reference loop).

3. Named Variables

Simple enough: {{namedVariable}}

Caution

Using a variable this way will not automatically sanitise it.

4. Untrusted Named Variables

Syntax: {{{namedVariable}}}

These variables get passed through safeHTML() before being used.

Using verifiedInnerHtml

For demonstration, I will be showing how to use verifiedInnerHtmlSync.

Assuming you have a key status.trusted.disclaimer that requires a variable with the user's description (completely hypothetical scenario), you would do:

verifiedInnerHtmlSync().status.trusted.disclaimer({description: someValue});

The innerhtml key can itself choose to sanitise description by using it as {{{description}}} instead of {{description}}.

If there are no variables, you can just do:

verifiedInnerHtmlSync().status.trusted.disclaimer();

For async, do:

(await verifiedInnerHtml).status.trusted.disclaimer();

About linter errors

The verifiedInnerHtml feature is ignored by the linter.

[rav4toy]

this would be great

[cornusandu]

this would be great

Hi, I can't tell if this is sarcasm or not (text tends to lack emotions), but this was proposed as means of replacing hardcoded innerHTML inside JavaScript files, while including QoL features such as easier sanitisation of variables, referencing locales easily, or referencing other innerHTML keys (if needed).

[rav4toy]

no sarcasm behind my comment, as i said it would be great