Skip to content

chore(docs): minor updates to modal props meta #5013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 25, 2020
Merged

chore(docs): minor updates to modal props meta #5013

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c8ea99d
chore(docs): minor updates to modal props meta
tmorehouse Mar 25, 2020
d177a3a
Update package.json
tmorehouse Mar 25, 2020
ae08e4c
Merge branch 'dev' into modal-docs
tmorehouse Mar 25, 2020
9322b83
Update package.json
jacobmllr95 Mar 25, 2020
1eb5369
Update package.json
jacobmllr95 Mar 25, 2020
0fc72fa
Merge branch 'dev' into modal-docs
jacobmllr95 Mar 25, 2020
decdb33
Merge branch 'dev' into modal-docs
jacobmllr95 Mar 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 48 additions & 48 deletions src/components/modal/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
},
Expand All @@ -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"
}
]
},
Expand All @@ -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"
}
]
},
Expand All @@ -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"
}
]
},
Expand All @@ -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"
}
]
},
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -338,26 +338,26 @@
"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",
"type": [
"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",
Expand All @@ -381,149 +381,149 @@
"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)"
}
]
}
],
"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)"
}
]
}
Expand Down