Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
akosarch authored Feb 14, 2020
1 parent a8ae489 commit 92a8a25
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Here is a basic component API.
| `json` | `JSON` | Accepts JSON object with props and texts in a format of `{"default": [...], "active": [...], "hover": [...]}` where "active" and "hover" are optional. See the *How to use section* for an example |
| `jsonPath` | `String` | Accepts a URL to fetch a JSON object in a format described above. Make sure you're passing a valid JSON (keys and values should be wrapped in quotes) or it will throw an error |
| `activeIds` | `Number[]` | Use to only pass the *initial properties* to the component. Will cause the component's reset. To change the active items dynamically use `activeItems` instead |
| `onMount` | `function(active, options)` | This callback provides you with the `options` and `active` items when component 'mounts'. It means not the actual component lifecycle 'mount', but rather the state when the first options and active items are obtained and rendered. This is a good way of grabbing the options to modify them later |
| `onMount` | `function(options, active)` | This callback provides you with the `options` and `active` items when component 'mounts'. It means not the actual component lifecycle 'mount', but rather the state when the first options and active items are obtained and rendered. This is a good way of grabbing the options to modify them later |
| `onActiveChange` | `function(active)` | This callback provides you with the `active` items when they change. For example when a user taps on some item |
| `onHoverChange` | `function(hover)` | This callback provides you with the `hover` item when it changes. For example when a user hovers over some item |
| `itemTapped` | `function(lastTapped`) | This callback provides you with the `lastTapped` item when it changes. For example when a user hovers over some item |
Expand Down

0 comments on commit 92a8a25

Please sign in to comment.