[ADF-1769] Added JSDocs and prop tables (#2898)

This commit is contained in:
Andy Stark
2018-01-31 17:40:28 +00:00
committed by Eugenio Romano
parent 0d93c65fd7
commit dd7afc65db
11 changed files with 99 additions and 54 deletions
+7 -7
View File
@@ -1,4 +1,4 @@
# ADF Rating component
# Rating component
Allows a user to add ratings to an item.
@@ -14,15 +14,15 @@ Allows a user to add ratings to an item.
### Properties
| Attribute | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| nodeId | string | | The identifier of a node |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | | Identifier of the node to apply the rating to. |
### Events
| Name | Description |
| ---- | ----------- |
| changeVote | Raised when vote gets changed |
| Name | Type | Description |
| ---- | ---- | ----------- |
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
## See also