Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owowagency/bootstrap-vue
A component library for Vue 3 and Bootstrap 5
https://github.com/owowagency/bootstrap-vue
bootstrap bootstrap5 typescript vue
Last synced: 3 days ago
JSON representation
A component library for Vue 3 and Bootstrap 5
- Host: GitHub
- URL: https://github.com/owowagency/bootstrap-vue
- Owner: owowagency
- License: mit
- Created: 2021-11-04T16:08:16.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-01T15:27:26.000Z (10 months ago)
- Last Synced: 2024-09-24T11:32:57.417Z (3 days ago)
- Topics: bootstrap, bootstrap5, typescript, vue
- Language: TypeScript
- Homepage: https://owowagency.github.io/bootstrap-vue
- Size: 9.57 MB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
A component library for Vue 3 and Bootstrap 5 + a few extra's just for you 😉.
```html
Login
```
# 📖 Table of contents
1. [Demo](#-demo)
1. [Installation](#%EF%B8%8F-installation)
1. [Usage](#-usage)
1. [Contributing](#-contributing)
1. [License](#-license)
1. [OWOW](#owow)
# 🚀 Demo
All components can be found on the [Storybook page](https://owowagency.github.io/bootstrap-vue) of this package.
# ⚙️ Installation
Installing this package can be done by using `npm` or `yarn`.
```bash
# npm
npm install @owowagency/bootstrap-vue
# yarn
yarn add @owowagency/bootstrap-vue
```
This package also requires [Bootstrap](https://getbootstrap.com/docs/5.2/getting-started/download/#package-managers) for its styling and Javascript.
```bash
# npm
npm install bootstrap
# yarn
yarn add bootstrap
```
# 🛠 Usage
Here is a simple example on how to use a component in your Vue application:
```html
Please don't click me!
import {Button} from '@owowagency/bootstrap-vue';
```
This package provides the following features:
### Components
- [Accordion](./src/components/Accordion)
- [AccordionItem](./src/components/AccordionItem)
- [Alert](./src/components/Alert)
- [Badge](./src/components/Badge)
- [Breadcrumb](./src/components/Breadcrumb)
- [BreadcrumbItem](./src/components/BreadcrumbItem)
- [Button](./src/components/Button)
- [ButtonClose](./src/components/ButtonClose)
- [ButtonGroup](./src/components/ButtonGroup)
- [ButtonState](./src/components/ButtonState)
- [Card](./src/components/Card)
- [Carousel](./src/components/Carousel)
- [Col](./src/components/Col)
- [Collapse](./src/components/Collapse)
- [Confirm](./src/components/Confirm)
- [Container](./src/components/Container)
- [Dropdown](./src/components/Dropdown)
- [DropdownMenu](./src/components/DropdownMenu)
- [DropdownMenuItem](./src/components/DropdownMenuItem)
- [FormCheck](./src/components/FormCheck)
- [FormCheckGroup](./src/components/FormCheckGroup)
- [FormControl](./src/components/FormControl)
- [FormDropdown](./src/components/FormDropdown)
- [FormDropdownSearch](./src/components/FormDropdownSearch)
- [FormGroup](./src/components/FormGroup)
- [FormImage](./src/components/FormImage)
- [FormPills](./src/components/FormPills)
- [FormSelect](./src/components/FormSelect)
- [InputGroup](./src/components/InputGroup)
- [ListGroup](./src/components/ListGroup)
- [ListGroupItem](./src/components/ListGroupItem)
- [Modal](./src/components/Modal)
- [Nav](./src/components/Nav)
- [NavItem](./src/components/NavItem)
- [NavLink](./src/components/NavLink)
- [Offcanvas](./src/components/Offcanvas)
- [Row](./src/components/Row)
- [Spinner](./src/components/Spinner)
- [Table](./src/components/Table)
- [Tooltip](./src/components/Tooltip)
### Composables
- [useActive](./src/composables/useActive)
- [useBootstrap](./src/composables/useBootstrap)
- [useBootstrapEmits](./src/composables/useBootstrapEmits)
- [useBootstrapInstance](./src/composables/useBootstrapInstance)
- [useBreakpoints](./src/composables/useBreakpoints)
- [useClasses](./src/composables/useClasses)
- [useCol](./src/composables/useCol)
- [useDisabled](./src/composables/useDisabled)
- [useDropdown](./src/composables/useDropdown)
- [useDropdownItems](./src/composables/useDropdownItems)
- [useFlush](./src/composables/useFlush)
- [useFormControl](./src/composables/useFormControl)
- [useFormSelect](./src/composables/useFormSelect)
- [useId](./src/composables/useId)
- [usePlacement](./src/composables/usePlacement)
- [useSize](./src/composables/useSize)
- [useStringTemplate](./src/composables/useStringTemplate)
- [useTag](./src/composables/useTag)
- [useTooltipPlacement](./src/composables/useTooltipPlacement)
- [useTrigger](./src/composables/useTrigger)
- [useVariant](./src/composables/useVariant)
## Documentation
The documentation for this package is auto-generated by [vue-docgen-cli](https://vue-styleguidist.github.io/docs/docgen-cli.html).
To generate the documentation yourself, run `yarn generate-docs`.
# 🫶 Contributing
Please see [CONTRIBUTING](./CONTRIBUTING.md) for details.
# 📜 License
The MIT License (MIT). Please see [License File](./LICENSE) for more information.
This package has been brought to you with much love by the wizkids of [OWOW](https://owow.io/). Do you like this package? We’re still looking for new talent and Wizkids. So do you want to contribute to open source, while getting paid? [Apply now](https://owow.io/careers).