Skip to content

Commit d7b1d63

Browse files
committed
docs: fix prop typo in kebab-case
1 parent 53957be commit d7b1d63

File tree

2 files changed

+60
-60
lines changed

2 files changed

+60
-60
lines changed

docs/content/en/guide/properties.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ Enabled Server-Side Rendering.
7272

7373
Custom class names for the modal container.
7474

75-
## `contentClass`
75+
## `content-class`
7676

7777
- Type: `[String, Object, Array]`
7878
- Default: `''`
7979

8080
Custom class names for the modal content.
8181

82-
## `overlayClass`
82+
## `overlay-class`
8383

8484
- Type: `[String, Object, Array]`
8585
- Default: `''`
@@ -93,14 +93,14 @@ Custom class names for the modal overlay.
9393

9494
Style that will be applied to the modal container.
9595

96-
## `contentStyle`
96+
## `content-style`
9797

9898
- Type: `[Object, Array]`
9999
- Default: `{}`
100100

101101
Style that will be applied to the modal content.
102102

103-
## `overlayStyle`
103+
## `overlay-style`
104104

105105
- Type: `[Object, Array]`
106106
- Default: `{}`
@@ -150,7 +150,7 @@ CSS transition applied to the modal container.
150150

151151
</show-code>
152152

153-
## `overlayTransition`
153+
## `overlay-transition`
154154

155155
- Type: `[String, Object]`
156156
- Default: `'vfm'`
@@ -193,7 +193,7 @@ CSS transition applied to the modal overlay.
193193

194194
</show-code>
195195

196-
## `lockScroll`
196+
## `lock-scroll`
197197

198198
- Type: `Boolean`
199199
- Default: `true`
@@ -202,28 +202,28 @@ Disabled the scrolling of body while the modal is displayed.
202202

203203
<alert>Using [`body-scroll-lock`](https://github.com/willmcpo/body-scroll-lock) to implement the feature. </alert>
204204

205-
## `hideOverlay`
205+
## `hide-overlay`
206206

207207
- Type: `Boolean`
208208
- Default: `false`
209209

210210
Hiding the display of the overlay.
211211

212-
## `clickToClose`
212+
## `click-to-close`
213213

214214
- Type: `Boolean`
215215
- Default: `true`
216216

217217
Enabled closing the modal by clicking overlay of the modal.
218218

219-
## `escToClose`
219+
## `esc-to-close`
220220

221221
- Type: `Boolean`
222222
- Default: `false`
223223

224224
Press `esc` to close the modal.
225225

226-
## `preventClick`
226+
## `prevent-click`
227227

228228
- Type: `Boolean`
229229
- Default: `false`
@@ -242,35 +242,35 @@ Specifies which DOM element that this component should detach to.
242242
2. String can be any valid `querySelector`, e.g. `'body'`, `'#app'`.
243243
3. Object can be any valid `Node`, e.g. `this.$refs.container`.
244244

245-
## `zIndexAuto`
245+
## `z-index-auto`
246246

247247
- Type: `Boolean`
248248
- Default: `true`
249249

250-
Auto binding `z-index` base on the prop `zIndexBase` and adding `2` by each stackable modal. If zIndex is set, `zIndexAuto`, `zIndexBase` will be ignored.
250+
Auto binding `z-index` base on the prop `z-index-base` and adding `2` by each stackable modal. If zIndex is set, `z-index-auto`, `z-index-base` will be ignored.
251251

252-
## `zIndexBase`
252+
## `z-index-base`
253253

254254
- Type: `[String, Number]`
255255
- Default: `1000`
256256

257-
Calculate `z-index` automatically with zIndexBase. If zIndex is set, `zIndexAuto`, `zIndexBase` will be ignored.
257+
Calculate `z-index` automatically with z-index-base. If zIndex is set, `z-index-auto`, `z-index-base` will be ignored.
258258

259-
## `zIndex`
259+
## `z-index`
260260

261261
- Type: `[String, Number]`
262262
- Default: `false`
263263

264-
Set specific `z-index` to root of the modal element. If zIndex is set, `zIndexAuto`, `zIndexBase` will be ignored.
264+
Set specific `z-index` to root of the modal element. If zIndex is set, `z-index-auto`, `z-index-base` will be ignored.
265265

266-
## `focusRetain`
266+
## `focus-retain`
267267

268268
- Type: `Boolean`
269269
- Default: `true`
270270

271271
Focus the modal `vfm__container` after the modal enter.
272272

273-
## `focusTrap`
273+
## `focus-trap`
274274

275275
- Type: `Boolean`
276276
- Default: `false`
@@ -284,14 +284,14 @@ Enables focus trap meaning that only inputs/buttons that are withing the modal w
284284

285285
Enables draggable modal.
286286

287-
## `fitParent`
287+
## `fit-parent`
288288

289289
- Type: `Boolean`
290290
- Default: `false`
291291

292292
Limit the x-axis, y-axis, width and height of the `.vfm__content` to not exceed the `.vfm__container`.
293293

294-
## `dragSelector`
294+
## `drag-selector`
295295

296296
- Type: `String`
297297
- Default: `''`
@@ -307,7 +307,7 @@ Limit the x-axis, y-axis, width and height of the `.vfm__content` to not exceed
307307

308308
Only the element that was selected by `querySelectorAll(string)` can trigger drag modal.
309309

310-
## `keepChangedStyle`
310+
## `keep-changed-style`
311311

312312
- Type: `Boolean`
313313
- Default: `false`
@@ -321,35 +321,35 @@ Keep the style that was changed by `drag` and `resize` after modal closed.
321321

322322
Enables resizable modal.
323323

324-
## `resizeDirections`
324+
## `resize-directions`
325325

326326
- Type: `Array`
327327
- Default: `[]`
328328
- Valid value: `['t', 'tr', 'r', 'br', 'b', 'bl', 'l', 'tl']`
329329

330330
Active directions for resizable modal.
331331

332-
## `minWidth`
332+
## `min-width`
333333

334334
- Type: `Number`
335335
- Default: `0`
336336

337-
Limit `minWidth` for resizable modal.
338-
## `minHeight`
337+
Limit `min-width` for resizable modal.
338+
## `min-height`
339339

340340
- Type: `Number`
341341
- Default: `0`
342342

343-
Limit `minHeight` for resizable modal.
344-
## `maxWidth`
343+
Limit `min-height` for resizable modal.
344+
## `max-width`
345345

346346
- Type: `Number`
347347
- Default: `Infinity`
348348

349-
Limit `maxWidth` for resizable modal.
350-
## `maxHeight`
349+
Limit `max-width` for resizable modal.
350+
## `max-height`
351351

352352
- Type: `Number`
353353
- Default: `Infinity`
354354

355-
Limit `maxHeight` for resizable modal.
355+
Limit `max-height` for resizable modal.

0 commit comments

Comments
 (0)