Skip to content

Commit ae72fc3

Browse files
committed
Update - Readme
1 parent abed92c commit ae72fc3

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

README.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@
66
---
77
- [Getting started](#getting-started)
88
- [Usage](#usage)
9-
- [Options](#options)
10-
- [Handle Event](#handle-event)
11-
- [Custom Label](#custom-label)
12-
- [Default State](#default-state)
13-
- [Disable Button](#disable-button)
9+
- [Available Properties](#available-properties)
1410

1511
## Getting started
1612

@@ -42,9 +38,7 @@ export default {
4238
</script>
4339
```
4440

45-
## Options
46-
47-
### Handle Event
41+
### Get Toggle State with Custom Event Handler
4842
```js
4943
<template>
5044
<div>
@@ -72,27 +66,15 @@ export default {
7266
</script>
7367
```
7468

75-
### Custom Label
76-
```html
77-
<ToggleButton
78-
id="switch"
79-
labelEnableText="Live"
80-
labelDisableText="Draft"
81-
/>
82-
```
69+
### Available Properties
8370

84-
### Default State
85-
```html
86-
<ToggleButton
87-
id="switch"
88-
:defaultState="true"
89-
/>
90-
```
71+
List of available properties to use in this component:
72+
73+
Prop | Data Type | Default | Description
74+
--------------- |------------------ |------------------ |--------------
75+
`id` | `String` | primary | Element Id
76+
`default-state` | `Boolean` | `false` | Toggle State (true | false)
77+
`disabled` | `Boolean` | `false` | Disable the toggle button
78+
`label-enable-text` | `String` | On | Active Label
79+
`label-disable-text` | `String` | Off | In-Active Label
9180

92-
### Disable Button
93-
```html
94-
<ToggleButton
95-
id="switch"
96-
:disabled="true"
97-
/>
98-
```

0 commit comments

Comments
 (0)