aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/javascript/formatters.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/javascript/formatters.texi')
-rw-r--r--doc/ref/javascript/formatters.texi16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/ref/javascript/formatters.texi b/doc/ref/javascript/formatters.texi
new file mode 100644
index 00000000..16a988c4
--- /dev/null
+++ b/doc/ref/javascript/formatters.texi
@@ -0,0 +1,16 @@
+@node formatters
+@subsection formatters
+
+Formatting procedures used by some components.
+@c TODO can we have a backref of every node containing @ref{formatters-proc}?
+
+@deftypevar {Map<string, (e:HTMLElement, s:any) => void>} formatters
+@anchor{formatters-proc}
+
+Each procedure takes two arguments. The HTML-element which contents
+should be replaced, along with the target value, as returned by @ref{VEvent.getProperty}.
+@end deftypevar
+
+@deftypevr {Window Value} {Map<string, (e:HTMLElement, s:string) => void>} formatters
+Same object as @xref{formatters-proc}. Provided for @xref{user-additions.js}.
+@end deftypevr