aboutsummaryrefslogtreecommitdiff
path: root/lib/factories/ui.js
diff options
context:
space:
mode:
authorRuben Beltran del Rio <git@r.bdr.sh>2024-05-08 18:37:48 +0200
committerRuben Beltran del Rio <git@r.bdr.sh>2024-05-08 18:37:48 +0200
commit32e2eed2a003c9be98f344ae70248139162b6969 (patch)
tree7883586f5b106a569c58bc74c3fa17f780176f27 /lib/factories/ui.js
parent2b9badac1345c865c34097bc5d1699329b53fdc8 (diff)
Add a few commentsHEADmain
Diffstat (limited to 'lib/factories/ui.js')
-rw-r--r--lib/factories/ui.js12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/factories/ui.js b/lib/factories/ui.js
index cc34579..167c618 100644
--- a/lib/factories/ui.js
+++ b/lib/factories/ui.js
@@ -1,3 +1,10 @@
+/**
+ * This file is a factory for DOM UI elements.
+ */
+
+/**
+ * Returns a settings container that includes a section and a heading.
+ */
export function settingsContainer({id, label, level=2}) {
const container = document.createElement('section');
@@ -6,6 +13,11 @@ export function settingsContainer({id, label, level=2}) {
return container;
};
+/**
+ * Returns a slider that includes a label, and can optionally be set to
+ * "shift" to a different step. (eg. we use this for π mode, where frequency
+ * and amplitude are mapped to π/8 increments.
+ */
export function slider({
id,
min,