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: README.md
+39-3Lines changed: 39 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,15 @@ Common examples of poppers are tooltips and popovers.
13
13
Well, basically, **no**.
14
14
Popper.js is built from the ground up to being modular and fully ~~hackable~~**customizable**.
15
15
It supports a **plugin system** you can use to add particular behaviors to your poppers.
16
-
It's **AMD** and **CommonJS** compatible and it's well documented thanks to our JSDoc page.
16
+
It's **AMD** and **CommonJS** compatible and it's well documented thanks to our [JSDoc page](https://fezvrasta.github.io/popper.js/documentation.html).
17
+
18
+
<br>
19
+
--------------
20
+
<br>
21
+
22
+
# Popper.js Libraries
23
+
24
+
Popper.js is a set of libraries, but right now the only released one is Near.js.
17
25
18
26
## Near.js
19
27
@@ -29,10 +37,38 @@ var options = { /* more later... */ }
29
37
var thePopper =newNear(reference, popper, options); // that's all
30
38
```
31
39
40
+
It's the real badass of the family, all the hard work is on its shoulders and we'll never thank it enough for all its work!
41
+
32
42
## Popper.js
33
43
34
-
This one is used to style your Popper, add the nice arrow to it, in and out animations and so on.
44
+
This library is still work in progress, basically will allow you to automatically create tooltips and popovers just defining their reference element.
45
+
All the hard work is done by **Near.js** under the hood, but we want to make even easier to create poppers and Popper.js will make this possible.
46
+
47
+
Here is an example of how the API will look like:
48
+
49
+
```js
50
+
var reference =document.querySelector('.my-button');
51
+
var options = { /* more later... */ };
52
+
53
+
var thePopper =newPopper(reference, options);
54
+
```
55
+
56
+
These few lines will create a new element and will initialize it using Near.js.
57
+
As you see, it's just a shorthand for what you can already do with **Near.js** right now.
58
+
Visit our [GitHub Page](https://fezvrasta.github.io/popper.js) to see a lot of examples of what you can already do right now!
59
+
60
+
61
+
# Notes
62
+
63
+
## Credits
64
+
65
+
I want to thank some friends and projects for the work they did:
66
+
67
+
-[@AndreaScn](https://github.com/AndreaScn) for its work on the GitHub Page and the manual testing he did during the development;
68
+
-[Sysdig](https://github.com/Draios) for all the awesome things I learned during these years that made possible for me to write this library;
69
+
-[Tether.js](http://github.hubspot.com/tether/) for having inspired me in writing a positioning library ready for the real world;
70
+
-**you** for the star you'll give to this project and for beeing so awesome to give this project a try :)
35
71
36
72
## Copyright and license
37
73
38
-
Code and documentation copyright 2016 Federico Zivolo. Code released under the MIT license. Docs released under Creative Commons.
74
+
Code and documentation copyright 2016 **Federico Zivolo**. Code released under the [MIT license](LICENSE.md). Docs released under Creative Commons.
0 commit comments