You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/docs/getting-started/README.md
+91-15Lines changed: 91 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,19 +12,19 @@ This project is still in **alpha version**. There is a lot of work to do, if you
12
12
13
13
## Why BootstrapVue3?
14
14
15
-
BootstrapVue3 is an attempt to have the [BootstrapVue](https://bootstrap-vue.org/) components in Vue3, Bootstrap 5, and typescript. Another goal is to have components written in a simple and readable way.
15
+
BootstrapVue3 is an attempt to have the [BootstrapVue](https://bootstrap-vue.org/) components in Vue3, Bootstrap 5, and typescript. Another goal is to have the components written in a simple and readable way.
16
16
17
-
As you may suppose, this library is heavily inspired by [BootstrapVue](https://bootstrap-vue.org/), as well as the components properties, events, slots, directives, etc. We want to make it that way because we want to have compatibility with BootstrapVue, so it will be easy to switch between libraries.
17
+
As you may suppose, this library is heavily inspired by [BootstrapVue](https://bootstrap-vue.org/), as well as the component properties, events, slots, directives, etc. We want to make it that way because we want to have compatibility with BootstrapVue, so it will be easy to switch between libraries.
18
18
19
-
## Contribute & support 🙌
19
+
## Contribute and Support 🙌
20
20
21
-
This project is still in **alpha version** so there is a lot of work to do. If you want to contribute you can:
21
+
This project is still in **alpha version** so there is much work to do. If you want to contribute you can:
22
22
23
23
- submit an [issue](https://github.com/cdmoro/bootstrap-vue-3/issues/new)
24
24
- or better, a [pull request](https://github.com/cdmoro/bootstrap-vue-3/pulls)
25
-
- or even better, visit [my patreon page](https://patreon.com/cdmoro) and support me 😄
25
+
- or even better, visit [my Patreon page](https://patreon.com/cdmoro) and support me 😄
26
26
27
-
### One-time donations
27
+
### One-time Donations
28
28
29
29
Or if you prefer you can make a one-time donation through these channels:
30
30
@@ -33,7 +33,7 @@ Or if you prefer you can make a one-time donation through these channels:
33
33
34
34
## Requisites
35
35
36
-
In order to use this library you have to install these packages:
36
+
To use this library you have to install these packages:
@@ -42,7 +42,83 @@ In order to use this library you have to install these packages:
42
42
43
43
### Installation - Vue.js
44
44
45
-
To install this library you can use Yarn, NPM, or PNPM:
45
+
#### Preferred Installation
46
+
47
+
- Bootstrap-vue-3 recommends using [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) for automatic tree-shaking. The following installation method is recommended
48
+
-`unplugin-vue-components` may have the side effect feature of also automatically importing _your_ components for ease of use. If you are uncomfortable with this, you may prefer the [**legacy**](#legacy-installation) installation without automatic tree-shaking
49
+
50
+
Install the necessary packages for `bootstrap-vue-3`:
The following is an example of a basic `vite.config.js/ts`. All you need to do is add **Components** to the Vite **plugins** option, with the additional imports:
If using TypeScript you will want to add `components.d.ts` to the `include` array in your tsconfig.json:
112
+
113
+
```json
114
+
"include": ["components.d.ts", ...],
115
+
```
116
+
117
+
#### Legacy Installation
118
+
119
+
- This is the old installation method. It is recommended to use the preferred installation as it will automatically remove unused components, resulting in a lower bundle size. You can, however, still use this installation method
120
+
121
+
Install the necessary packages for `bootstrap-vue-3`:
// Optional, since every component import their Bootstrap functionality
155
+
// Optional, since every component imports their Bootstrap functionality
80
156
// the following line is not necessary
81
157
// import 'bootstrap'
82
158
@@ -90,9 +166,9 @@ app.mount('#app')
90
166
91
167
### Installation - Nuxt.js 3
92
168
93
-
**Nuxt is not officially supported**. Various Bootstrap JavaScript elements contain references to 'Document' and 'Window', which will cause breaking issues during server-side rendering. Until Bootstrap v5 implements fixes for these, Bootstrap-vue-3 cannot officially support Nuxt3 and SSR applications
169
+
**Nuxt is not officially supported**. Various Bootstrap JavaScript elements contain references to 'Document' and 'Window', which will cause breaking issues during server-side rendering. Bootstrap-vue-3 is currently working on a fix for this
94
170
95
-
As with the Vue.js installation.
171
+
As with the Vue.js installation
96
172
97
173
In your Nuxt3 application, install the necessary packages for `bootstrap-vue-3`
Open your `nuxt.config.ts`or `nuxt.config.js`file and configure your application to use `bootstrap-vue-3`. The components will be imported automatically as needed.
201
+
Open your `nuxt.config.js/ts` file and configure your application to use `bootstrap-vue-3`. The components will be imported automatically as needed
126
202
127
203
```javascript
128
204
import {defineNuxtConfig} from'nuxt3'
@@ -145,8 +221,8 @@ Enjoy it in your app without import.
145
221
146
222
## Comparison with BoostrapVue
147
223
148
-
As we said, we based this project in[BootstrapVue](https://bootstrap-vue.org/). We consider BootstrapVue as the best implementation of Bootstrap `v4`, so a good approach is to replicate every BootstrapVue component, as well their props, events, etc. and add the new features of Bootstrap `v5`.
224
+
As we said, we based this project on[BootstrapVue](https://bootstrap-vue.org/). We consider BootstrapVue as the best implementation of Bootstrap `v4`, so a good approach is to replicate every BootstrapVue component, as well as their props, events, etc., and add the new features of Bootstrap `v5`.
149
225
150
226
<!-- To follow this, we'll implement a parity list where you can view the progress of covered components. This section is not ready yet. -->
151
227
152
-
You can view the full list in the following [section](../reference/parityList.md).
228
+
You can view the planned compatibility list in the following [section](../reference/parityList.md). It is _not_ a migration guide, which will be finalized upon v1.0.0
0 commit comments