bootstrap-vue
Version:
BootstrapVue, with over 40 plugins and more than 80 custom components, custom directives, and over 300 icons, provides one of the most comprehensive implementations of Bootstrap v4 components and grid system for Vue.js. With extensive and automated WAI-AR
210 lines (209 loc) • 6.82 kB
JSON
{
"name": "@bootstrap-vue/nav",
"version": "1.0.0",
"meta": {
"title": "Nav",
"description": "Navigation components that share general markup and styles, from the base <b-nav> class to the active and disabled states. Swap modifier props to switch between each style.",
"plugins": [
"DropdownPlugin"
],
"components": [
{
"component": "BNav",
"props": [
{
"prop": "tabs",
"description": "Renders the nav items with the appearance of tabs"
},
{
"prop": "pills",
"description": "Renders the nav items with the appearance of pill buttons"
},
{
"prop": "small",
"description": "Makes the nav smaller"
},
{
"prop": "align",
"description": "Align the nav items in the nav: 'start' (or 'left'), 'center', 'end' (or 'right')"
},
{
"prop": "fill",
"description": "Proportionately fills all horizontal space with nav items. All horizontal space is occupied, but not every nav item has the same width"
},
{
"prop": "justified",
"description": "Fills all horizontal space with nav items, but unlike 'fill', every nav item will be the same width"
},
{
"prop": "vertical",
"description": "Renders the nav vertically"
},
{
"prop": "cardHeader",
"version": "2.0.0",
"description": "Set this prop when the nav is placed inside a card header"
}
]
},
{
"component": "BNavItem",
"props": [
{
"prop": "linkAttrs",
"description": "Additional attributes to place on the nested link element"
},
{
"prop": "linkClasses",
"description": "CSS class (or classes) to place on the nested link element"
}
]
},
{
"component": "BNavText"
},
{
"component": "BNavForm",
"props": [
{
"prop": "novalidate",
"description": "When set, disables browser native HTML5 validation on controls in the form"
},
{
"prop": "validated",
"description": "When set, adds the Bootstrap class 'was-validated' on the form, triggering the native browser validation states"
}
],
"events": [
{
"event": "submit",
"description": "Emitted when the form is being submitted",
"args": [
{
"arg": "event",
"type": "Event",
"description": "Native submit event."
}
]
}
]
},
{
"component": "BNavItemDropdown",
"aliases": [
"BNavItemDd",
"BNavDropdown",
"BNavDd"
],
"props": [
{
"prop": "text",
"description": "Text to place in the toggle button, or in the split button is split mode"
},
{
"prop": "html",
"description": "HTML string to place in the toggle button, or in the split button is split mode. Use with caution"
},
{
"prop": "dropup",
"description": "When set, positions the menu on the top of the button"
},
{
"prop": "dropright",
"description": "When set, positions the menu to the right of the button"
},
{
"prop": "dropleft",
"description": "When set, positions the menu to the left of the button"
},
{
"prop": "right",
"description": "Align the right edge of the menu with the right of the button"
},
{
"prop": "noFlip",
"description": "Prevent the menu from auto flipping positions"
},
{
"prop": "lazy",
"description": "When set, will only mount the menu content into the DOM when the menu is open"
},
{
"prop": "popperOpts",
"description": "Additional configuration to pass to Popper.js"
},
{
"prop": "menuClass",
"description": "CSS class (or classes) to add to the menu container"
},
{
"prop": "toggleClass",
"description": "CSS class (or classes) to add to the toggle button"
},
{
"prop": "noCaret",
"description": "Hide the caret indicator on the toggle button"
},
{
"prop": "boundary",
"version": "2.4.0",
"description": "The boundary constraint of the menu: 'scrollParent', 'window', 'viewport', or a reference to an HTMLElement. Has no effect when dropdown is inside a b-navbar"
}
],
"slots": [
{
"name": "button-content",
"description": "Can be used to implement custom text with icons and more styling."
},
{
"name": "default",
"description": "Optionally scoped default slot for dropdown menu content.",
"scope": [
{
"prop": "hide",
"type": "Function",
"description": "Can be used to close the dropdown menu. Accepts an optional boolean argument, which if true returns focus to the toggle button."
}
]
}
],
"events": [
{
"event": "show",
"description": "Emitted just before dropdown is shown. Cancelable.",
"args": [
{
"arg": "bvEvt",
"type": "BvEvent",
"description": "BvEvent object. Call bvEvt.preventDefault() to cancel show."
}
]
},
{
"event": "shown",
"description": "Emitted when dropdown is shown."
},
{
"event": "hide",
"description": "Emitted just before dropdown is hidden. Cancelable.",
"args": [
{
"arg": "bvEvt",
"type": "BvEvent",
"description": "BvEvent object. Call bvEvt.preventDefault() to cancel hide."
}
]
},
{
"event": "hidden",
"description": "Emitted when dropdown is hidden."
},
{
"event": "toggle",
"description": "Emitted when toggle button is clicked."
}
]
}
]
}
}