From 9da9c9af2a882f91652c7a370285a3eef75e3dd8 Mon Sep 17 00:00:00 2001 From: Derek Gould Date: Tue, 15 Apr 2014 19:27:58 -0700 Subject: [PATCH] README update --- README.md | 29 +++++++++++++++++------------ bower.json | 2 +- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 62708d4..be5aa11 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # angular-slider [![Build Status](https://secure.travis-ci.org/Venturocket/angular-slider.png?branch=master)](http://travis-ci.org/Venturocket/angular-slider) -Slider directive for AngularJS. https://venturocket.github.io/angular-slider +Slider directive for AngularJS. https://venturocket.github.io/angular-slider License: MIT ## Features @@ -12,7 +12,7 @@ License: MIT - Full touch event support ## Known Issues -- When hidden during initialization (`display: none;`) the slider might not display correctly when shown. Issue a `$scope.$broadcast('refreshSlider');` in a parent scope to tell the slider to update the DOM. +- When hidden during initialization (`display: none;`) the slider might not display correctly when shown. Issue `$scope.$broadcast('refreshSlider');` in a parent scope to tell the slider to update the DOM. ## Installation @@ -85,9 +85,9 @@ As an attribute: |step |float |No |inf |The width between each tick. | |precision |integer|No |0 |The numerical precision to which to round the value. | |stretch |integer|No |3 |How sticky the knobs will act. 1 = no stickiness | -|translate-fn |string |No |none |A translation function to apply to all view values. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | -|scale-fn |string |No |none |A scaling function to apply to the value. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | -|inverse-scale-fn |string|No |none |The inverse of the scaling function. This is required if a scaling function is specified. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | +|translate-fn |string |No |none |A translation function to apply to all view values. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | +|scale-fn |string |No |none |A scaling function to apply to the value. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | +|inverse-scale-fn |string|No |none |The inverse of the scaling function. This is required if a scaling function is specified. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | -- ### Dual Knob #### Markup @@ -132,19 +132,19 @@ As an attribute: #### Parameters |Param |Type |Required |Default |Details | |-----------|-------|---------|--------|--------| -|ng-model|string|Yes |none |Assignable angular expression to which to data-bind the low value. | -|ng-model-range|string|Yes |none |Assignable angular expression to which to data-bind the high value. | +|ng-model |string |Yes |none |Assignable angular expression to which to data-bind the low value. | +|ng-model-range|string|Yes |none |Assignable angular expression to which to data-bind the high value. | |floor |float |Yes |none |The lowest value possible | |ceiling |float |Yes |none |The highest value possible | |buffer |float |No |0 |The minimum difference between the low and high values | |step |float |No |inf |The width between each tick. | |precision |integer|No |0 |The numerical precision to which to round the value. | |stretch |float |No |3 |How sticky the knobs will act. 1 = no stickiness | -|translate-fn |string |No |none |A translation function to apply to most of the view values. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | -|translate-range-fn|string|No |none |A translation function to apply to the range value. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | -|translate-combined-fn|string|No |none |A translation function to apply to the combined value (when the knobs are too close together). Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | -|scale-fn |string |No |none |A scaling function to apply to the value. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | -|inverse-scale-fn|string|No |none |The inverse of the scaling function. This is required if a scaling function is specified. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | +|translate-fn |string |No |none |A translation function to apply to most of the view values. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | +|translate-range-fn|string|No |none |A translation function to apply to the range value. Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | +|translate-combined-fn|string|No |none |A translation function to apply to the combined value (when the knobs are too close together). Be sure to omit the parentheses (e.g. "transFunc" instead of "transFunc()") | +|scale-fn |string |No |none |A scaling function to apply to the value. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | +|inverse-scale-fn|string|No |none |The inverse of the scaling function. This is required if a scaling function is specified. See the `Scaling` section below for more details. Be sure to omit the parentheses (e.g. "scaleFunc" instead of "scaleFunc()") | ## Scaling @@ -164,3 +164,8 @@ A few notes: - scaleFn(inverseScaleFn(x)) MUST produce x or you're gonna have a bad time - If your scale function returns the same y for multiple x's within the range of the slider you're gonna have a bad time - If the floor of your slider dips into negative numbers and you don't account for possible imaginary numbers you're gonna have a bad time + +## Additional Features +- `ngChange` support ([docs](http://docs.angularjs.org/api/ng/directive/ngChange)) +- `ngDisabled` support ([docs](http://docs.angularjs.org/api/ng/directive/ngDisabled)) +- implements `ngModelController` for form validation and dirty/pristine states ([docs](http://docs.angularjs.org/api/ng/type/ngModel.NgModelController)) diff --git a/bower.json b/bower.json index 8ce7f78..f4ba6d1 100755 --- a/bower.json +++ b/bower.json @@ -25,6 +25,6 @@ "angular-scenario": "*" }, "resolutions": { - "angular": "v1.2.14" + "angular": "v1.2.16" } }