Skip to content

Commit

Permalink
Merge pull request #137 from djibe/patch-1
Browse files Browse the repository at this point in the history
Enhenced documentation
  • Loading branch information
mimo84 committed Feb 15, 2018
2 parents 6eb24e5 + b66a33e commit f26f758
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -26,7 +26,7 @@ The indicator badge shows up on focusing on the element, and disappears when the
* **customMaxAttribute**: String -- allows a custom attribute to display indicator without triggering native maxlength behaviour. Ignored if value greater than a native maxlength attribute. 'overmax' class gets added when exceeded to allow user to implement form validation.
* **allowOverMax**: Will allow the input to be over the customMaxLength. Useful in soft max situations.
* **placement**: is a string, object, or function, to define where to output the counter.
* Possible string values are: **bottom** ( *default option* ), **left**, **top**, **right**, **bottom-right**, **top-right**, **top-left**, **bottom-left** and **centered-right**.
* Possible string values are: **bottom** ( *default option* ), **left**, **top**, **right**, **bottom-right**, **top-right**, **top-left**, **bottom-left** and **centered-right**. Are also available : **bottom-right-inside** (like in Google's material design, **top-right-inside**, **top-left-inside** and **bottom-left-inside**.
* Custom placements can be passed as an object, with keys **top**, **right**, **bottom**, **left**, and **position**. These are passed to $.fn.css.
* A custom function may also be passed. This method is invoked with the {$element} Current Input, the {$element} MaxLength Indicator, and the Current Input's Position {bottom height left right top width}.

Expand Down

0 comments on commit f26f758

Please sign in to comment.