Skip to content

Commit

Permalink
update documentation, see #698
Browse files Browse the repository at this point in the history
  • Loading branch information
jessegreenberg committed Jun 10, 2021
1 parent 9a0d915 commit 05c6c03
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions js/accessibility/AccessibleValueHandler.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ const AccessibleValueHandler = {
// hold". This function will still be called once per input in those cases.
onChange: _.noop,

// {function(number):number} - It should return the constrained value, called before valueProperty is set
// {function(number):number} - Constrains the value, returning a new value for the valueProperty instead.
// Called before the valueProperty is set. This is only called when the shift key is NOT down because
// it is often that shiftKeyboardStep is a smaller step size then what is allowed by constrainValue.
constrainValue: _.identity,

// {number} - delta for the valueProperty for each press of the arrow keys
Expand Down Expand Up @@ -228,10 +230,10 @@ const AccessibleValueHandler = {
// @private {function} - called when value change input ends
this._endChange = options.endChange;

// @private {function(number):number} - called before valueProperty is set
// @private {function(number):number} - see options for documentation
this._constrainValue = options.constrainValue;

// @private {function(number,number):number} - called before constrainValue called and valueProperty is set
// @private {function(number,number):number} - see options for documentation
this._a11yMapValue = options.a11yMapValue;

// @private {null|Node}
Expand Down

0 comments on commit 05c6c03

Please sign in to comment.