Skip to content

Commit ccf77d3

Browse files
committed
Update README
1 parent fe1d1cd commit ccf77d3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The directive can work on both element and attribute levels. The following examp
1818

1919
```html
2020
<input bs-switch ng-model="isSelected"
21-
switch-type="{{type}}" switch-active="{{active}}"
21+
switch-type="checkbox" switch-active="{{active}}"
2222
switch-size="{{size}}" switch-animate="{{animate}}"
2323
switch-label={{text}} switch-icon="{{icon}}"
2424
switch-on-label="{{onLabel}}" switch-off-label="{{offLabel}}"
@@ -28,7 +28,7 @@ The directive can work on both element and attribute levels. The following examp
2828
Short doc for all of the attributes:
2929

3030
* `ng-model`, the value to bind the switch to
31-
* `switch-type`, can be `chechbox` (default) or `radio`
31+
* `switch-type`, can be `chechbox` (default) or `radio`. This value must be a string, as it cannot be changed once set (see [this answer on StackOverflow](http://stackoverflow.com/a/15155407/801065)).
3232
* `switch-active`, determines if the switch is enabled or not
3333
* `switch-size`, can be the empty string as default, `mini`, `small`, `large`
3434
* `switch-animate`, determines if the switch animates when toggled
@@ -40,7 +40,7 @@ Short doc for all of the attributes:
4040
* `switch-off`, sets the positive (checked) class, can be `default` (as default), `primary`, `info`, `success`, `warning`, `danger`
4141

4242
###Examples
43-
TODO
43+
The `example` folder shows a simple working demo of the switch.
4444

4545
## Building
4646

0 commit comments

Comments
 (0)