Skip to content

Commit dfc3425

Browse files
authored
show options as table
1 parent 7fb3402 commit dfc3425

File tree

1 file changed

+9
-34
lines changed

1 file changed

+9
-34
lines changed

README.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -108,40 +108,15 @@ Add `vue-wait/nuxt` to modules section of `nuxt.config.js`
108108

109109
You can use this options for customize VueWait behavior.
110110

111-
#### `accessorName`
112-
113-
`String` value, `$wait` by default, you can change this value to rename the accessor.
114-
115-
E.g. if you rename this to `$w`, your `VueWait` methods will be accessible by `$w.isWaiting(..)` etc.
116-
117-
#### `useVuex`
118-
119-
`Boolean` value, `false` by default, use this value for enabling
120-
integration with `Vuex` store
121-
122-
When this value is true `VueWait` will store data in `Vuex` store
123-
and all changes to this data will be made by dispatching actions to store
124-
125-
#### `vuexModuleName`
126-
127-
`String` value, `loading` by default.
128-
Name for `Vuex` store if `useVuex` set to true, otherwise not used.
129-
130-
#### `registerComponent`
131-
132-
`Boolean` value, `true` by default, registers `v-wait` component.
133-
134-
#### `componentName`
135-
136-
`String` value, `v-wait` by default, changes `v-wait` component name.
137-
138-
#### `registerDirective`
139-
140-
`Boolean` value, `true` by default, registers `v-wait` directive.
141-
142-
#### `directiveName`
143-
144-
`String` value, `wait` by default, changes `v-wait` directive name.
111+
| Option Name | Type | Default | Description |
112+
| ----------- | ---- | ------- | ----------- |
113+
| `accessorName` | `String` | `"$wait"` | You can change this value to rename the accessor. E.g. if you rename this to `$w`, your `VueWait` methods will be accessible by `$w.isWaiting(..)` etc. |
114+
| `useVuex` | `Boolean` | `false` | Use this value for enabling integration with `Vuex` store. When this value is true `VueWait` will store data in `Vuex` store and all changes to this data will be made by dispatching actions to store |
115+
| `vuexModuleName` | `String` | `"wait"` | Name for `Vuex` store if `useVuex` set to true, otherwise not used. |
116+
| `registerComponent` | `Boolean` | `true` | Registers `v-wait` component. |
117+
| `componentName` | `String` | `"v-wait"` | Changes `v-wait` component name. |
118+
| `registerDirective` | `Boolean` | `true` | Registers `v-wait` directive. |
119+
| `directiveName` | `String` | `"v-wait"` | Changes `v-wait` directive name. |
145120

146121
## 🌈 Global Template Helpers
147122

0 commit comments

Comments
 (0)