@decidables/discountable-elements 0.3.9 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.0](https://github.com/decidables/decidables/compare/@decidables/discountable-elements@0.3.9...@decidables/discountable-elements@0.4.0) (2025-05-20)
+
+
+### Features
+
+* **discountable-elements:** add larger touch targets to htd-curves ([0f57a3a](https://github.com/decidables/decidables/commit/0f57a3a1cc09bf63ee8cc4c50d08159c06daaad8))
+* **discountable-elements:** add parameter value controls as htd-parameters ([0b50fbf](https://github.com/decidables/decidables/commit/0b50fbf6bd5f76b11fdea7d01f8826f99d6184f9))
+* **discountable-elements:** colored nonlinear slider for k in htd-parameters ([59c670b](https://github.com/decidables/decidables/commit/59c670b8911ca7dd80a46c4f1a7b74681eb62ca1))
+* **discountable-elements:** controls/parameters must be explicitly included to be shown in examples ([3e41072](https://github.com/decidables/decidables/commit/3e41072b1934b33f5a1af849388c144a86372daf))
+* **discountable-elements:** htd-fit: tips and highlighting in fit plots ([a399e5f](https://github.com/decidables/decidables/commit/a399e5f877c22ca2ede74f28ef7b77025047b15f))
+* **discountable-elements:** key responses for discountable-response ([850dbf2](https://github.com/decidables/decidables/commit/850dbf2e61372ca5f2c2bd7c8f6bd89275cda7b2))
+* **discountable-elements:** use parameter settings throughout ([cc4c307](https://github.com/decidables/decidables/commit/cc4c307a618c8d65d8e317787c930145b0fb8a18))
+
+
+### Bug Fixes
+
+* **discountable-elements:** fix htd-curves touch drag ([cfc516f](https://github.com/decidables/decidables/commit/cfc516f1ae581c5001e8998a20ff7d6fccc92182))
+* **discountable-elements:** fix touch targets for htd-curves ([6b79be9](https://github.com/decidables/decidables/commit/6b79be97a782653bb2cc712005cdbe9efe0e6b94))
+* **discountable-elements:** htd curve - remove redundant SVG element ([002a529](https://github.com/decidables/decidables/commit/002a52921fabc3bc279922fd5ff8e173e12a727b))
+
+
+
 ## [0.3.9](https://github.com/decidables/decidables/compare/@decidables/discountable-elements@0.3.8...@decidables/discountable-elements@0.3.9) (2025-02-06)
 
 **Note:** Version bump only for package @decidables/discountable-elements

package/README.md

@@ -96,6 +96,9 @@ Response buttons and feedback for inter-temporal choice tasks
 This element provides 'first' and 'second' response buttons. It can also display a running count
 of the trials and display response feedback.
 
+Also accepts keyboard responses: <kbd>ArrowLeft</kbd> for 'first' button and <kbd>ArrowRight</kbd> for
+'second' button.
+
 ##### Attributes
 
 - `interactive: boolean = false`
@@ -396,6 +399,36 @@ be directly manipulated.
 <htd-curves interactive amount="60" delay="30" k="0.05" label="1"></htd-curves>
 ```
 
+#### `HTDParameters` / `<htd-parameters>`
+
+Control panel for HTD model parameters
+
+A configurable set of controls for user manipulation of HTD model parameters. Controls can be
+provided for the discounting factor.
+
+##### Attributes
+
+- `k: number = undefined`
+  - Show a slider for setting the discounting factor, initialized to the value provided
+  - Options
+    - `0` to `100` in steps of `0.001`
+
+##### Methods
+
+##### Custom Events
+
+- `ddm-parameters-k`
+  - Indicates an update to the discounting factor
+  - `detail`
+    - `k: number`
+      - New value for the discounting factor
+
+##### Example
+
+```html
+<htd-parameters interactive k="1.6"></htd-parameters>
+```
+
 #### `ITCChoice` / `<itc-choice>`
 
 A choice between two options at different times
@@ -632,6 +665,19 @@ controls, the task itself, response buttons with feedback, HTD curves, and trace
 histograms for the parameters in the model fit. The HTD curves should not be interactive, because
 their rendering is determined by the user's task performance.
 
+##### Attributes
+
+**Note:** Since model parameter attributes are set on the example, they don't need to be set on the
+individual components, as they will be propagated and kept in sync.
+
+- `trials: number = 10`
+  - Number of trials to run
+- `duration: number = 2000`
+  - The duration of the stimulus, wait, and inter-trial interval on each trial, initialized to the
+    value provided in milliseconds
+- `k: number = 0.05`
+  - Parameter k (discounting factor)
+
 ##### Slots
 
 - *unnamed*
@@ -692,6 +738,10 @@ components, as they will be propagated and kept in sync.
   - Wired elements
     - `<htd-calculation>`
       - Display and change the value calculations
+    - `<htd-parameters>`
+      - Allows user to adjust model parameters with sliders
+    - `<htd-parameters>`
+      - Displays the model parameters for current fit
     - `<htd-curves>`
       - Displays the options as amounts with delays with discounting curves based on the current
         model parameters
@@ -701,8 +751,9 @@ components, as they will be propagated and kept in sync.
 ##### Example
 
 ```html
-<htd-example-interactive a1="5" d1="20" a2="30" d2="350" k="0.01">
+<htd-example-interactive amount-ss="5" delay-ss="1" amount-ll="30" delay-ll="50" k="0.01">
   <itc-choice interactive></itc-choice>
+  <htd-parameters interactive></htd-parameters>
   <htd-curves interactive></htd-curves>
   <htd-calculation numeric interactive></htd-calculation>
 </htd-example-interactive>
@@ -722,7 +773,12 @@ not be interactive, because their values are received from the model's task perf
 **Note:** Since model parameter attributes are set on the example, they don't need to be set on the
 individual components, as they will be propagated and kept in sync.
 
-- `k: number = 0.2`
+- `trials: number = 10`
+  - Number of trials to run
+- `duration: number = 2000`
+  - The duration of the stimulus, wait, and inter-trial interval on each trial, initialized to the
+    value provided in milliseconds
+- `k: number = 0.05`
   - Parameter k (discounting factor)
 
 ##### Slots
@@ -745,9 +801,10 @@ individual components, as they will be propagated and kept in sync.
 ##### Example
 
 ```html
-<htd-example-model k="0.2" >
-  <discountable-control trials="10" run pause reset></discountable-control>
-  <itc-task trials="10"></itc-task>
+<htd-example-model trials="10" duration="2000" k="0.05">
+  <discountable-control run pause reset></discountable-control>
+  <itc-task></itc-task>
+  <htd-parameters interactive></htd-parameters>
   <htd-curves interactive></htd-curves>
   <discountable-response trial feedback></discountable-response>
 </htd-example-model>