2
2
3
3
<!-- Badges section here. -->
4
4
[ ![ CircleCI Status] [ circle-ci-badge ]] [ circle-ci-badge-url ]
5
+ [ ![ Maintainability] [ codeclimate-maintainability-badge ]] [ codeclimate-maintainability-badge-url ]
6
+ [ ![ Test Coverage] [ codeclimate-coverage-badge ]] [ codeclimate-coverage-badge-url ]
7
+ [ ![ codebeat badge] [ codebeat-badge ]] [ codebeat-badge-url ]
8
+ [ ![ Greenkeeper badge] [ greenkeeper-badge ]] [ greenkeeper-badge-url ]
9
+
5
10
[ ![ Dependency Status] [ david-badge ]] [ david-badge-url ]
6
11
[ ![ peerDependency Status] [ david-peer-badge ]] [ david-peer-badge-url ]
7
12
[ ![ devDependency Status] [ david-dev-badge ]] [ david-dev-badge-url ]
12
17
13
18
Allows us to check if an element is within the browsers visual viewport
14
19
15
- ## Install
16
-
17
- Install with yarn:
18
-
19
- ``` sh
20
- yarn add ng-in-viewport intersection-observer
21
- ```
22
-
23
- I'm using yarn but you can use npm if you like:
24
-
25
- ``` sh
26
- npm install --save ng-in-viewport intersection-observer
27
- ```
28
-
29
- ## Demo
30
- [ Here] [ example-app ] you can look at our example application
31
-
32
- ## Simple usage example
33
-
34
- ToDo: Fill this with some example
20
+ - 🤓 Learn about it on the [ DOCS Site] [ lib-docs ]
21
+ - 🚀 See it in action on [ Stackblitz] [ example-app ]
22
+ - 🎮 Play with it on [ Stackblitz] [ example-app-embed ]
35
23
36
24
## License
37
25
@@ -40,18 +28,34 @@ ToDo: Fill this with some example
40
28
[ circle-ci-badge ] : https://circleci.com/gh/k3nsei/ng-in-viewport/tree/master.svg?style=shield&circle-token=1c961beeff7d2e03a4203efd1858081b9901caac
41
29
[ circle-ci-badge-url ] : https://circleci.com/gh/k3nsei/ng-in-viewport/tree/master
42
30
43
- [ david-badge ] : https://david-dm.org/k3nsei/ng-in-viewport.svg
44
- [ david-badge-url ] : https://david-dm.org/k3nsei/ng-in-viewport
31
+ [ codeclimate-maintainability-badge ] : https://api.codeclimate.com/v1/badges/a9c4480075e536498c72/maintainability
32
+ [ codeclimate-maintainability-badge-url ] : https://codeclimate.com/github/k3nsei/ng-in-viewport/maintainability
33
+
34
+ [ codeclimate-coverage-badge ] : https://api.codeclimate.com/v1/badges/a9c4480075e536498c72/test_coverage
35
+ [ codeclimate-coverage-badge-url ] : https://codeclimate.com/github/k3nsei/ng-in-viewport/test_coverage
36
+
37
+ [ codebeat-badge ] : https://codebeat.co/badges/73e483ff-fb24-4ad1-9878-89aa1ed55192
38
+ [ codebeat-badge-url ] : https://codebeat.co/projects/github-com-k3nsei-ng-in-viewport-develop
45
39
46
- [ david-peer- badge] : https://david-dm.org /k3nsei/ng-in-viewport/peer-status .svg
47
- [ david-peer- badge-url] : https://david-dm.org/k3nsei/ng-in-viewport?type=peer
40
+ [ greenkeeper- badge] : https://badges.greenkeeper.io /k3nsei/ng-in-viewport.svg
41
+ [ greenkeeper- badge-url] : https://greenkeeper.io/
48
42
49
- [ david-dev-badge ] : https://david-dm.org/k3nsei/ng-in-viewport/dev-status.svg
50
- [ david-dev-badge-url ] : https://david-dm.org/k3nsei/ng-in-viewport?type=dev
43
+ [ david-badge ] : https://david-dm.org/k3nsei/ng-in-viewport/develop.svg?path=projects/ng-in-viewport
44
+ [ david-badge-url ] : https://david-dm.org/k3nsei/ng-in-viewport/develop?path=projects/ng-in-viewport
45
+
46
+ [ david-peer-badge ] : https://david-dm.org/k3nsei/ng-in-viewport/develop/peer-status.svg?path=projects/ng-in-viewport
47
+ [ david-peer-badge-url ] : https://david-dm.org/k3nsei/ng-in-viewport/develop?type=peer&path=projects/ng-in-viewport
48
+
49
+ [ david-dev-badge ] : https://david-dm.org/k3nsei/ng-in-viewport/develop/dev-status.svg?path=projects/ng-in-viewport
50
+ [ david-dev-badge-url ] : https://david-dm.org/k3nsei/ng-in-viewport/develop?type=dev&path=projects/ng-in-viewport
51
51
52
52
[ npm-badge-version ] : https://img.shields.io/npm/v/ng-in-viewport.svg
53
53
[ npm-badge-license ] : https://img.shields.io/npm/l/ng-in-viewport.svg
54
54
[ npm-badge-downloads ] : https://img.shields.io/npm/dm/ng-in-viewport.svg
55
55
[ npm-badge-url ] : https://www.npmjs.com/package/ng-in-viewport
56
56
57
+ [ lib-docs ] : https://k3nsei.gitbook.io/ng-in-viewport/
58
+ [ api-docs ] : https://k3nsei.github.io/ng-in-viewport/
59
+
57
60
[ example-app ] : https://ng-in-viewport-example.stackblitz.io/
61
+ [ example-app-embed ] : https://stackblitz.com/edit/ng-in-viewport-example?embed=1&file=src/main.ts
0 commit comments