Skip to content

Commit

Permalink
fix(docs): fix various typos (valor-software#5467)
Browse files Browse the repository at this point in the history
  • Loading branch information
daniloff200 authored and IraErshova committed Jan 20, 2020
1 parent a7fc5c2 commit c5c3226
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Best way to quickly integrate <a href="https://getbootstrap.com/">Bootstrap 3</a

## Getting Started

ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and css provided by Bootstrap.
ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and CSS provided by Bootstrap.

## Supporting NGX-Bootstrap
ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible thanks to the support of our awesome backers.
Expand Down Expand Up @@ -95,7 +95,7 @@ Use the Angular CLI ng add command for updating your Angular project
```bash
ng add ngx-bootstrap
```
OR use `ng add` to add needed component (for example tooltip)
Or use `ng add` to add needed component (for example tooltip)
```bash
ng add ngx-bootstrap --component tooltip
```
Expand All @@ -107,7 +107,7 @@ Add component to your page:
</button>
```
### Setting up the bootstrap version manually
Sometimes, your project might contain some library that could interfear with the bootstrap framework, or you might have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the boostraping component (i.e. `AppComonent`):
Sometimes, your project might contain some library that could interfere with the bootstrap framework, or you might have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the bootstrapping component (i.e. `AppComponent`):
```
import { setTheme } from 'ngx-bootstrap/utils';
Expand All @@ -128,7 +128,7 @@ Main source of API documentation and usage scenarios available here:
Additionally you can find demos and docs deployed from latest code with <a href="https://ngx-bootstrap.surge.sh/">angular@latest</a> and <a
href="https://ngx-bootstrap-latest.surge.sh/">angular@next</a>

Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a> served with Anguar universal and [nest.js](https://nestjs.com/)
Server side rendered version of this documentation available <a href="https://ngx-universal.herokuapp.com/">here</a> served with Angular universal and [nest.js](https://nestjs.com/)

## API
Check demo page for API [reference](https://valor-software.com/ngx-bootstrap/)
Expand Down Expand Up @@ -189,11 +189,11 @@ If, **and only if**, none of the above helped, please open a [new issue](https:/

## Contribution

Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!
All contributions very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!

Please read our [contribution guidelines](https://github.com/valor-software/ngx-bootstrap/blob/development/CONTRIBUTING.md).

### If you need more modules check [here](https://github.com/valor-software/ng2-plans)
### If you need more modules, check [here](https://github.com/valor-software/ng2-plans)

Please read central `ngx` modules [readme](https://github.com/valor-software/ng2-plans) for details, plans and approach

Expand All @@ -206,4 +206,4 @@ End-to-end testing sponsored by [Cypress](https://www.cypress.io/)

### License

MIT
[MIT](https://github.com/valor-software/ngx-bootstrap/blob/development/LICENSE)
4 changes: 2 additions & 2 deletions docs/getting-started/bootstrap.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Using with Bootstrap and angular-cli

This is extracted from the [angular-cli include bootstrap story](https://github.com/angular/angular-cli/wiki/stories-include-bootstrap) and demonstates one way to accomplish using Bootstrap 3 or 4 with ngx-bootstrap. The `Bootstrap's` version is defined automatically by the `ngx-bootstrap`.
This is extracted from the [angular-cli include bootstrap story](https://github.com/angular/angular-cli/wiki/stories-include-bootstrap) and demonstrates one way to accomplish using Bootstrap 3 or 4 with ngx-bootstrap. The `Bootstrap's` version is defined automatically by the `ngx-bootstrap`.

## Installing angular-cli

*Recommended*: to use latest stable `angular-cli` version.
*Recommended*: to use the latest stable `angular-cli` version.

*Note*: You can skip this part if you already have application generated by `ng-cli` and webpack.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Main success scenario:
6. When user click on 2d item, it opened and 1st is closed
7. When user click on 3d item, it opened and 2d is closed
8. When user uncheck the check-box "Open only one at a time"
9. Then after click on each item, it stay opened.
9. Then after click on each item, it stays opened.

Variations:
-----------
Expand Down
12 changes: 6 additions & 6 deletions docs/spec/carousel/carousel.examples.basic.use-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@

Main success scenario:
----------------------
1. User open Carousel demo page
2. User click on Basic sub-menu
3. User see carousel component with 3 slides and 2 arrows: left, right
4. When user click on left arrow - previous slide shown
5. When user click on right arrow - next slide shown
6. When user do nothing more than 5 sec - next slide automatically shown
1. User opens Carousel demo page
2. User clicks on Basic sub-menu
3. User sees carousel component with 3 slides and 2 arrows: left, right
4. When user clicks on left arrow - previous slide is shown
5. When user clicks on right arrow - next slide is shown
6. When user doed nothing more than 5 sec - next slide automatically is shown

Variations:
-----------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
5. When user clicks on 5th page, then active page - 5 and it centered, maximum count of pages - 5
6. After click on "Next" button, then active page - 6 and it centered, maximum count of pages - 5
7. After click on "Previous" button, then active page - 5 and it centered , maximum count of pages should 5
8. When user clicks on "Toggle centering current page link", then "last" and "first" buttons are appeared, should marked like "..."
8. When user clicks on "Toggle centering current page link", then "last" and "first" buttons are appeared, and should be marked like "..."
9. When user clicks on 5th page, then active page - 5 and it located by right side, maximum count of pages - 5
10.After click on "Next" button, then active page - 6 and it located by left side, maximum count page - 5
10. After click on "Next" button, then active page - 6 and it located by left side, maximum count page - 5
11. After click on "Previous" button, then active page - 5 and it located by left side, maximum count of pages - 5
12. After click on "Last" button, next 5 pages are appeared, maximum count of pages - 5
13. After click on "Previous" button, Previous 5 pages are appeared, maximum count of pages - 5
Expand Down

0 comments on commit c5c3226

Please sign in to comment.