diff --git a/src/components/modal/package.json b/src/components/modal/package.json index 483d8fd8dd4..367d77f2d74 100644 --- a/src/components/modal/package.json +++ b/src/components/modal/package.json @@ -189,7 +189,7 @@ { "arg": "isVisible", "type": "Boolean", - "description": "true if modal is visible, false otherwise" + "description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible" } ] }, @@ -200,7 +200,7 @@ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel show" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel show" } ] }, @@ -222,7 +222,7 @@ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide" + "description": "BvModalEvent object. Inspect `bvModalEvt.trigger` to find out what action triggered the hide. Call `bvModalEvt.preventDefault()` to cancel hide" } ] }, @@ -244,7 +244,7 @@ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel hide" } ] }, @@ -255,7 +255,7 @@ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel hide" } ] }, @@ -266,29 +266,29 @@ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel hide" } ] }, { "event": "bv::modal::show", - "description": "Emitted on $root when modal is about to be shown. Cancelable", + "description": "Emitted on `$root` when modal is about to be shown. Cancelable", "args": [ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvEvt.preventDefault() to cancel show" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel show" }, { "arg": "modalId", "type": "String", - "description": "modal ID" + "description": "Modal ID" } ] }, { "event": "bv::modal::shown", - "description": "Emitted on $root when modal is shown", + "description": "Emitted on `$root` when modal is shown", "args": [ { "arg": "bvModalEvt", @@ -298,29 +298,29 @@ { "arg": "modalId", "type": "String", - "description": "modal ID" + "description": "Modal ID" } ] }, { "event": "bv::modal::hide", - "description": "Emitted on $root when modal is about to be hidden. Cancelable (as long as modal wasn't forcibly hidden)", + "description": "Emitted on `$root` when modal is about to be hidden. Cancelable (as long as modal wasn't forcibly hidden)", "args": [ { "arg": "bvModalEvt", "type": "BvModalEvent", - "description": "BvModalEvent object. Call bvEvt.preventDefault() to cancel hide" + "description": "BvModalEvent object. Call `bvModalEvt.preventDefault()` to cancel hide" }, { "arg": "modalId", "type": "String", - "description": "modal ID" + "description": "Modal ID" } ] }, { "event": "bv::modal::hidden", - "description": "Emitted on $root when modal is hidden", + "description": "Emitted on `$root` when modal is hidden", "args": [ { "arg": "bvModalEvt", @@ -338,12 +338,12 @@ "rootEventListeners": [ { "event": "bv::show::modal", - "description": "Show modal with specified ID when this event is emitted on $root", + "description": "Show modal with specified ID when this event is emitted on `$root`", "args": [ { "arg": "modalId", "type": "String", - "description": "modal ID to show" + "description": "Modal ID to show" }, { "arg": "elIDtoFocusOnClose", @@ -351,13 +351,13 @@ "String", "HTMLElement" ], - "description": "(optional), specify the element reference, or CSS selector, to return focus to once the modal is closed" + "description": "Specify the element reference, or CSS selector, to return focus to once the modal is closed (optional)" } ] }, { "event": "bv::hide::modal", - "description": "Hide modal with specified ID when this event is emitted on $root", + "description": "Hide modal with specified ID when this event is emitted on `root`", "args": [ { "arg": "modalId", @@ -381,7 +381,7 @@ "String", "HTMLElement" ], - "description": "(optional), specify the element reference, or CSS selector, to return focus to once the modal is closed" + "description": "Specify the element reference, or CSS selector, to return focus to once the modal is closed (optional)" } ] } @@ -389,141 +389,141 @@ "slots": [ { "name": "modal-header", - "description": "Entire modal header container contents. Also removes the top right X close button. Optionally scoped.", + "description": "Entire modal header container contents. Also removes the top right X close button. Optionally scoped", "scope": [ { "prop": "visible", "type": "Boolean", - "description": "The visibility state of the modal. true if the modal is visible and false if not visible" + "description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible" }, { "prop": "ok", "type": "Function", - "description": "Closes the modal and fires the 'ok' and 'hide' events, with bvModalEvent.trigger = 'ok'" + "description": "Closes the modal and fires the 'ok' and 'hide' events, with `bvModalEvent.trigger = 'ok'`" }, { "prop": "cancel", "type": "Function", - "description": "Closes the modal and fires the 'cancel' and 'hide' events, with bvModalEvent.trigger = 'cancel'" + "description": "Closes the modal and fires the 'cancel' and 'hide' events, with `bvModalEvent.trigger = 'cancel'`" }, { "prop": "close", "type": "Function", - "description": "Closes the modal and fires the close and hide events, with bvModalEvent.trigger = 'headerclose'" + "description": "Closes the modal and fires the close and hide events, with `bvModalEvent.trigger = 'headerclose'`" }, { "prop": "hide", "type": "Function", - "description": "Accepts one argument 'trigger'. Closes the modal and fires the 'hide' event, with the bvModalEvent.trigger = trigger (trigger is optional)" + "description": "Accepts one argument `trigger`. Closes the modal and fires the 'hide' event, with the `bvModalEvent.trigger = trigger` (`trigger` is optional)" } ] }, { "name": "modal-title", - "description": "Modal title. If modal-header slot is used, this slot will not be shown. Optionally scoped.", + "description": "Modal title. If `modal-header` slot is used, this slot will not be shown. Optionally scoped", "scope": [ { "prop": "visible", "type": "Boolean", - "description": "The visibility state of the modal. true if the modal is visible and false if not visible" + "description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible" }, { "prop": "ok", "type": "Function", - "description": "Closes the modal and fires the 'ok' and 'hide' events, with bvModalEvent.trigger = 'ok'" + "description": "Closes the modal and fires the 'ok' and 'hide' events, with `bvModalEvent.trigger = 'ok'`" }, { "prop": "cancel", "type": "Function", - "description": "Closes the modal and fires the 'cancel' and 'hide' events, with bvModalEvent.trigger = 'cancel'" + "description": "Closes the modal and fires the 'cancel' and 'hide' events, with `vModalEvent.trigger = 'cancel'`" }, { "prop": "close", "type": "Function", - "description": "Closes the modal and fires the close and hide events, with bvModalEvent.trigger = 'headerclose'" + "description": "Closes the modal and fires the close and hide events, with `vModalEvent.trigger = 'headerclose'`" }, { "prop": "hide", "type": "Function", - "description": "Accepts one argument 'trigger'. Closes the modal and fires the 'hide' event, with the bvModalEvent.trigger = trigger (trigger is optional)" + "description": "Accepts one argument `trigger`. Closes the modal and fires the 'hide' event, with the `bvModalEvent.trigger = trigger` (`trigger` is optional)" } ] }, { "name": "modal-footer", - "description": "Modal footer content. Also removes default OK and CANCEL buttons. Optionally scoped.", + "description": "Modal footer content. Also removes default OK and Cancel buttons. Optionally scoped", "scope": [ { "prop": "visible", "type": "Boolean", - "description": "The visibility state of the modal. true if the modal is visible and false if not visible" + "description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible" }, { "prop": "ok", "type": "Function", - "description": "Closes the modal and fires the 'ok' and 'hide' events, with bvModalEvent.trigger = 'ok'" + "description": "Closes the modal and fires the 'ok' and 'hide' events, with `bvModalEvent.trigger = 'ok'`" }, { "prop": "cancel", "type": "Function", - "description": "Closes the modal and fires the 'cancel' and 'hide' events, with bvModalEvent.trigger = 'cancel'" + "description": "Closes the modal and fires the 'cancel' and 'hide' events, with `vModalEvent.trigger = 'cancel'`" }, { "prop": "close", "type": "Function", - "description": "Closes the modal and fires the close and hide events, with bvModalEvent.trigger = 'headerclose'" + "description": "Closes the modal and fires the close and hide events, with `vModalEvent.trigger = 'headerclose'`" }, { "prop": "hide", "type": "Function", - "description": "Accepts one argument 'trigger'. Closes the modal and fires the 'hide' event, with the bvModalEvent.trigger = trigger (trigger is optional)" + "description": "Accepts one argument `trigger`. Closes the modal and fires the 'hide' event, with the `bvModalEvent.trigger = trigger` (`trigger` is optional)" } ] }, { "name": "modal-header-close", - "description": "Content of Modal header close button. If modal-header slot is used, this slot will not be shown." + "description": "Content of Modal header close button. If `modal-header` slot is used, this slot will not be shown" }, { "name": "modal-ok", - "description": "Modal OK button content." + "description": "Modal OK button content" }, { "name": "modal-cancel", - "description": "Modal CANCEL button content." + "description": "Modal CANCEL button content" }, { "name": "modal-backdrop", - "description": "Modal Backdrop content." + "description": "Modal Backdrop content" }, { "name": "default", - "description": "Content of modal body. Optionally scoped.", + "description": "Content of modal body. Optionally scoped", "scope": [ { "prop": "visible", "type": "Boolean", - "description": "The visibility state of the modal. true if the modal is visible and false if not visible" + "description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible" }, { "prop": "ok", "type": "Function", - "description": "Closes the modal and fires the 'ok' and 'hide' events, with bvModalEvent.trigger = 'ok'" + "description": "Closes the modal and fires the 'ok' and 'hide' events, with `bvModalEvent.trigger = 'ok'`" }, { "prop": "cancel", "type": "Function", - "description": "Closes the modal and fires the 'cancel' and 'hide' events, with bvModalEvent.trigger = 'cancel'" + "description": "Closes the modal and fires the 'cancel' and 'hide' events, with `bvModalEvent.trigger = 'cancel'`" }, { "prop": "close", "type": "Function", - "description": "Closes the modal and fires the close and hide events, with bvModalEvent.trigger = 'headerclose'" + "description": "Closes the modal and fires the close and hide events, with `bvModalEvent.trigger = 'headerclose'`" }, { "prop": "hide", "type": "Function", - "description": "Accepts one argument 'trigger'. Closes the modal and fires the 'hide' event, with the bvModalEvent.trigger = trigger (trigger is optional)" + "description": "Accepts one argument `trigger`. Closes the modal and fires the 'hide' event, with the `bvModalEvent.trigger = trigger` (`trigger` is optional)" } ] }