diff --git a/README.html b/README.html new file mode 100644 index 0000000..cda5ac7 --- /dev/null +++ b/README.html @@ -0,0 +1,66 @@ +

angular-checkbox-set

+ +

Angular directive, with recursive support for multiple layers of checkboxes.

+ +
    +
  1. The checked status would be stored in a unique object for each checkbox. This attribute is mandatory.
  2. +
  3. The hook and hooked-to attributes are optional. hook act as a hook, hooked-to hook the checkbox to the filled-in hook.
  4. +
  5. A checkbox could have both hook and hooked-to attributes, which means:
  6. +
  7. You could have as many levels of checkboxes as you like.
  8. +
  9. No need to initialise all the checkboxes at the same time: you could put children checkboxes inside ng-ifs and when they come into existence, they’ll automatically follow the status of their parent.
  10. +
+ + +

Install

+ +

command +$ bower install angular-checkbox-set +

+ +

Directive Attributes

+ +
    +
  1. hook, string. Notice the single quote within double quote!
  2. +
  3. hooked-to, string. Same as above.
  4. +
  5. status-stored-in, scope object.
  6. +
+ + +

Code Example

+ +

```html

+ + + + + + + +

+ + + + + + + + + + + + + + + + +

+

+ + + + +

+ +```

+ +

See it in action here.

diff --git a/README.md b/README.md index 05bacfc..200f893 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ Angular directive, with recursive support for multiple layers of checkboxes. 2. The `hook` and `hooked-to` attributes are optional. `hook` act as a hook, `hooked-to` hook the checkbox to the filled-in hook. 3. A checkbox could have both `hook` and `hooked-to` attributes, which means: 4. You could have as many levels of checkboxes as you like. +5. No need to initialise all the checkboxes at the same time: you could put children checkboxes inside `ng-if`s and when they come into existence, they'll automatically follow the status of their parent. ### Install ```command @@ -32,8 +33,6 @@ $ bower install angular-checkbox-set - - ```