1
1
<a href =" http://valor-software.com/ngx-bootstrap/#/ " >
2
2
<div align =" center " >
3
- <img class =" mx-auto center-block d-block " src =" https://valor-software.com/ngx-bootstrap/assets/images/logos/ngx-bootstrap-logo.svg " alt =" ngx-bootstrap " width =" 200 " height =" 200 " >
3
+ <img class="mx-auto center-block d-block" src="https://valor-software.com/ngx-bootstrap/assets/images/logos/ngx-bootstrap-logo.svg" alt="ngx-bootstrap" width="200" height="200" / >
4
4
<h1>ngx-bootstrap</h1>
5
5
</div >
6
6
</a >
@@ -39,6 +39,7 @@ development
39
39
-->
40
40
41
41
## Table of contents
42
+
42
43
1 . [ Getting Started] ( #getting-started )
43
44
2 . [ Usage & Demo] ( #usage--demo )
44
45
3 . [ Supporting] ( #supporting-ngx-bootstrap )
@@ -54,45 +55,52 @@ development
54
55
55
56
ngx-bootstrap provides Bootstrap components powered by Angular, so you don't need to include original JS components.
56
57
57
- Check our [ Getting started guide] ( https://valor-software.com/ngx-bootstrap/#/documentation#getting-started ) if it's your
58
+ Check our [ Getting started guide] ( https://valor-software.com/ngx-bootstrap/#/documentation#getting-started ) if it's your
58
59
first project with Angular Bootstrap.
59
60
60
61
## Usage & Demo
61
62
62
63
Bootstrap components for Angular applications, dozens of demos and API documentation could be found here:
63
64
[ https://valor-software.com/ngx-bootstrap/ ] ( https://valor-software.com/ngx-bootstrap/ ) .
64
65
65
- <!-- Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a>
66
+ <!-- Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a>
66
67
served with Angular universal and [nest.js](https://nestjs.com/). -->
67
68
68
69
## Supporting ngx-bootstrap
69
- ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible
70
+
71
+ ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible
70
72
thanks to the support of our awesome backers.
71
- If you also would like to show support or simply give back to Open Source community, please consider becoming a backing
73
+ If you also would like to show support or simply give back to Open Source community, please consider becoming a backing
72
74
sponsor of [ ngx-bootstrap on OpenCollective] ( https://opencollective.com/ngx-bootstrap ) .
73
75
74
- All donated funds are managed transparently on OpenCollective and will be used solely for compensating work and expenses
76
+ All donated funds are managed transparently on OpenCollective and will be used solely for compensating work and expenses
75
77
for contributors. Valor Software employees and contractors are not eligible for use of these funds.
76
78
77
79
What's in it for you? Proper recognition and exposure of your name/logo/website on our page.
78
80
Our main sponsors will be presented under this section! Be the first!
79
81
80
82
## Installation
83
+
81
84
You can see the below simple example working on [ StackBlitz] ( https://stackblitz.com/edit/vs-ngx-bootstrap-tooltip?file=src%2Findex.html )
82
85
83
86
##### Angular CLI way
87
+
84
88
Use the Angular CLI ng add command for updating your Angular project.
89
+
85
90
``` bash
86
91
ng add ngx-bootstrap
87
92
```
88
93
89
94
##### Manual way
95
+
90
96
Install ` ngx-bootstrap ` from ` npm ` :
97
+
91
98
``` bash
92
99
npm install ngx-bootstrap --save
93
100
```
94
101
95
102
Add wanted package to NgModule imports:
103
+
96
104
```
97
105
import { TooltipModule } from 'ngx-bootstrap/tooltip';
98
106
@@ -104,6 +112,7 @@ import { TooltipModule } from 'ngx-bootstrap/tooltip';
104
112
```
105
113
106
114
Add component to your page:
115
+
107
116
```
108
117
<button type="button" class="btn btn-primary"
109
118
tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
@@ -112,29 +121,33 @@ Add component to your page:
112
121
```
113
122
114
123
You will need to add bootstrap css:
115
- This can be done with the css file directly in the index.html, or alternatively through a styles import in the
124
+ This can be done with the css file directly in the index.html, or alternatively through a styles import in the
116
125
` angular.json ` file or via ` styles.scss ` import. However the latter two options require additionally installing bootstrap via npm.
126
+
117
127
- ` Bootstrap 5 `
128
+
118
129
```
119
130
<!--- index.html -->
120
131
<link href="https://cdn.jsdelivr.net/npm/[email protected] /dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
121
132
```
122
133
123
134
- ` Bootstrap 4 `
135
+
124
136
```
125
137
<!--- index.html -->
126
138
<link href="https://cdn.jsdelivr.net/npm/[email protected] /dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2">
127
139
```
128
140
129
141
### Setting up the bootstrap version manually
130
142
131
- As you may know ` ngx-bootstrap ` supports several ` bootstrap.css ` versions at the same time and has automatic tool
132
- to guess current used version of library, but if this guess fails you can specify version of ` bootstrap.css ` manually.
143
+ As you may know ` ngx-bootstrap ` supports several ` bootstrap.css ` versions at the same time and has automatic tool
144
+ to guess current used version of library, but if this guess fails you can specify version of ` bootstrap.css ` manually.
133
145
134
146
Sometimes, your project might contain some library that could interfere with the bootstrap framework, or you might
135
- have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might
136
- be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the bootstrapping
147
+ have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might
148
+ be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the bootstrapping
137
149
component (i.e. ` AppComponent ` ):
150
+
138
151
```
139
152
import { setTheme } from 'ngx-bootstrap/utils';
140
153
@@ -164,29 +177,30 @@ npm start
164
177
The only two dependencies are [ Angular] ( https://angular.io ) and [ Bootstrap] ( https://getbootstrap.com ) CSS.
165
178
Here is the version compatibility list:
166
179
167
- | ngx-bootstrap | Angular | Bootstrap CSS |
168
- | ---------------| -----------------| ----------------|
169
- | 11.x.x | 16.x.x | 5.x.x or 4.x.x |
170
- | 10.x.x | 15.x.x | 5.x.x or 4.x.x |
180
+ | ngx-bootstrap | Angular | Bootstrap CSS |
181
+ | ---------------| --------------- | ----------------------- |
182
+ | 18.x.x | 18.x.x | 5.x.x or 4.x.x |
183
+ | 12.x.x | 17.x.x | 5.x.x or 4.x.x |
184
+ | 11.x.x | 16.x.x | 5.x.x or 4.x.x |
185
+ | 10.x.x | 15.x.x | 5.x.x or 4.x.x |
171
186
| 9.0.0 | 14.x.x | 5.x.x or 4.x.x or 3.x.x |
172
187
| 8.0.0 | 12.x.x - 13.x.x | 5.x.x or 4.x.x or 3.x.x |
173
188
| 7.1.0 | 11.x.x - 12.x.x | 5.x.x or 4.x.x or 3.x.x |
174
- | 7.0.0 | 11.x.x - 12.x.x | 3.x.x or 4.x.x |
175
- | 6.0.0 | 9.x.x - 10.x.x | 3.x.x or 4.x.x |
176
- | 5.6.x | 7.x.x - 9.1.0 | 3.x.x or 4.x.x |
177
- | 5.0.0 - 5.6.0 | 7.x.x - 8.x.x | 3.x.x or 4.x.x |
178
- | 4.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x |
179
- | 3.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x |
180
- | 2.x.x | 2.x.x - 4.x.x | 3.x.x or 4.x.x |
181
- | 1.x.x | 2.x.x | 3.x.x or 4.x.x |
182
-
189
+ | 7.0.0 | 11.x.x - 12.x.x | 3.x.x or 4.x.x |
190
+ | 6.0.0 | 9.x.x - 10.x.x | 3.x.x or 4.x.x |
191
+ | 5.6.x | 7.x.x - 9.1.0 | 3.x.x or 4.x.x |
192
+ | 5.0.0 - 5.6.0 | 7.x.x - 8.x.x | 3.x.x or 4.x.x |
193
+ | 4.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x |
194
+ | 3.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x |
195
+ | 2.x.x | 2.x.x - 4.x.x | 3.x.x or 4.x.x |
196
+ | 1.x.x | 2.x.x | 3.x.x or 4.x.x |
183
197
184
198
## Troubleshooting
185
199
186
200
So if you are in trouble, here's where you can look for help.
187
201
188
- The best place to ask questions is on [ StackOverflow (under the ` ngx-bootstrap ` tag)] ( https://stackoverflow.com/questions/tagged/ngx-bootstrap )
189
- where there is a strong community of individuals asking and answering questions.
202
+ The best place to ask questions is on [ StackOverflow (under the ` ngx-bootstrap ` tag)] ( https://stackoverflow.com/questions/tagged/ngx-bootstrap )
203
+ where there is a strong community of individuals asking and answering questions.
190
204
191
205
You can also join [ our Slack channel] ( https://join.slack.com/t/ngx-home/shared_invite/enQtNTExMTY5MzcwMTM0LWVjZGU2MjI4MTVhMGVlMTc2OWRiMzA0NzBhNDU5YzQ0MDM3MWI5NzJjZTUzNzIxZmNjYmFlMjU2MzE0YmY0NWY ) and link your stackoverflow question there. But try to avoid asking generic help questions directly on Slack since they can easily get lost in the chat. You can also [ search among the existing GitHub issues] ( https://github.com/valor-software/ngx-bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue ) .
192
206
@@ -199,6 +213,7 @@ All contributions very welcome! And remember, contribution is not only PRs and c
199
213
Please read our [ contribution guidelines] ( https://github.com/valor-software/ngx-bootstrap/blob/development/CONTRIBUTING.md ) .
200
214
201
215
### Credits
216
+
202
217
Crossbrowser testing sponsored by [ Saucelabs] ( https://saucelabs.com/ )
203
218
[ <img src =" https://avatars2.githubusercontent.com/u/88837?s=200&v=4 " alt =" Saucelabs " width =" 31 " height =" 31 " align =" middle " >] ( https://saucelabs.com/ )
204
219
@@ -208,6 +223,6 @@ Crossbrowser testing sponsored by [Saucelabs](https://saucelabs.com/)
208
223
209
224
### Valor Software Can Help
210
225
211
- At [ Valor Software] ( https://valor-software.com/ ) our people are not resources, our people are human beings, helping to create a better world through our efforts and knowledge.
212
- We are here to assist you with your project. We have a wonderful, ever-growing team that is ready and able. If you're looking for someone to guide you and your team
226
+ At [ Valor Software] ( https://valor-software.com/ ) our people are not resources, our people are human beings, helping to create a better world through our efforts and knowledge.
227
+ We are here to assist you with your project. We have a wonderful, ever-growing team that is ready and able. If you're looking for someone to guide you and your team
213
228
please feel free to reach out to us on our site or at
[email protected] , we would love to chat.
0 commit comments