bootstrap-vue
Version:
With more than 85 components, over 45 available plugins, several directives, and 1000+ icons, BootstrapVue provides one of the most comprehensive implementations of the Bootstrap v4 component and grid system available for Vue.js v2.6, complete with extens
135 lines (134 loc) • 4.37 kB
JSON
{
"name": "@bootstrap-vue/navbar",
"version": "1.0.0",
"meta": {
"title": "Navbar",
"description": "The component <b-navbar> is a responsive wrapper that positions branding, navigation, and other elements into a concise header. It's easily extensible and thanks to the <b-collapse> component.",
"plugins": [
"NavPlugin",
"DropdownPlugin",
"CollapsePlugin"
],
"components": [
{
"component": "BNavbar",
"props": [
{
"prop": "fixed",
"description": "Set to 'top' for fixed to the top of the viewport, or 'bottom' for fixed to the bottom of the viewport"
},
{
"prop": "print",
"description": "Navbars are hidden by default when printing. When this prop is set it will be printed"
},
{
"prop": "sticky",
"description": "Set to true to make the navbar stick to the top of the viewport (or parent container that has 'position: relative' set) when scrolled"
},
{
"prop": "toggleable",
"description": "Set to 'true' for an always collapsed navbar, or to a specific breakpoint at which point the navbar will be expanded: 'sm', 'md', 'lg' or 'xl'"
},
{
"prop": "type",
"description": "Control the text color by setting to 'light' for use with light background color variants, or 'dark' for dark background color variants"
},
{
"prop": "variant",
"description": "Applies one of the Bootstrap theme color variants to the component"
}
],
"slots": [
{
"name": "default",
"description": "Content to place in the navbar"
}
]
},
{
"component": "BNavbarNav",
"props": [
{
"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": "small",
"description": "Makes the nav smaller"
}
],
"slots": [
{
"name": "default",
"description": "Content to place in the navbar nav"
}
]
},
{
"component": "BNavbarBrand",
"slots": [
{
"name": "default",
"description": "Content to place in the navbar brand"
}
]
},
{
"component": "BNavbarToggle",
"aliases": [
"BNavToggle"
],
"props": [
{
"prop": "disabled",
"version": "2.15.0",
"description": "When `true`, disables the navbar toggle button, and adds class `disabled` to the button"
},
{
"prop": "label",
"description": "String to place in the toggle's 'aria-label' attribute"
},
{
"prop": "target",
"description": "ID (or array of IDs) of the collapse/sidebar components that should be toggled"
}
],
"events": [
{
"event": "click",
"description": "Emitted when the toggle is clicked",
"args": [
{
"name": "event",
"type": "MouseEvent",
"description": "Native click event object"
}
]
}
],
"slots": [
{
"name": "default",
"description": "Alternate content to replace the default Bootstrap hamburger",
"scope": [
{
"prop": "expanded",
"version": "2.9.0",
"type": "Boolean",
"description": "`true` if the collapse is expanded, `false` otherwise"
}
]
}
]
}
]
}
}