Skip to content

Commit 3fbaa5b

Browse files
dydy
committed
Deprecate
1 parent f74de2d commit 3fbaa5b

7 files changed

Lines changed: 2476 additions & 4559 deletions

File tree

‎.travis.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
language: node_js
2+
node_js:
3+
- "0.10"
4+
- "0.11"

‎README.md‎

Lines changed: 2 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,5 @@
11
# Poppy
22

3-
Popups constructor and provider: tooltips, dropdowns, overlays, notifiers, etc. [Demo](http://dfcreative.github.io/poppy), [tests](https://rawgit.com/dfcreative/poppy/master/test/index.html).
3+
[![deprecated](http://badges.github.io/stability-badges/dist/deprecated.svg)](http://github.com/badges/stability-badges)
44

5-
[![NPM](https://nodei.co/npm/poppy.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/poppy/)
6-
7-
8-
## Getting started
9-
10-
### Install
11-
12-
Grab the [latest version](todo) or [CDN](todo). Insert it in the page:
13-
14-
```html
15-
<script src="cdn_url/poppy.js"></script>
16-
```
17-
18-
Poppy is also available as a component for browserify, component or duo:
19-
20-
`$ npm install poppy`
21-
22-
```js
23-
var Poppy = require('poppy');
24-
var Dropdown = require('poppy/dropdown');
25-
var Tooltip = require('poppy/tooltip');
26-
```
27-
28-
### Use
29-
30-
#### In document:
31-
32-
```html
33-
<div data-poppy="dropdown" data-content="#menu">Dropdown</div>
34-
35-
<ul id="menu" hidden>
36-
<li>Item 1</li>
37-
<li>Item 2</li>
38-
<li>Item 3</li>
39-
</ul>
40-
```
41-
42-
#### In code:
43-
44-
```js
45-
var dropdown = new Dropdown({
46-
target: document.querySelector('#menu'),
47-
content: '<ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul>',
48-
contentType: 'html'
49-
});
50-
```
51-
52-
53-
## Options
54-
55-
| Parameter | Type | Default | Description |
56-
|----|----|----|----|
57-
| `target` | _selector_, _element_, _element list_ (optional) | `undefined` | A target or list of targets which by click show the popup container. Can vary depending on poppy type. |
58-
| `content` | _string_, _element_, _function_ | `undefined` | Content to show in the container. If a function defined—it’s result will be taken as content. |
59-
| `contentType` | _string_ | `'element'` | `'element'`—show other element in the container.<br/>`'text'`—show content as plain text.<br/>`'html'`—show content as inner html. |
60-
| `containerClass` | _string_ | `undefined` | A class to add to the popup container |
61-
| `holder` | _selector_, _element_ | `<body>` | A holder of container |
62-
| `tip` | _string_ (optional) | `false` | A little triangle on the edge of the container. Possible values: `'top'`, `'left'`, `'bottom'`, `'right'`, `undefined`. |
63-
| `tipAlign` | _string_, _number_ | `'center'` | Tip alignment relative to the container. |
64-
| `single` | _boolean_ | `false` | Hide other containers when this one becomes visible |
65-
66-
67-
## API
68-
69-
| Property/method | Description |
70-
|----|----|
71-
| `show(target)` | Make the container visible. |
72-
| `hide()` | Make container disappear. |
73-
| `enable()` | Make container active. |
74-
| `disable()` | Disable any interactions. |
75-
| `container` | Visible poppy container. |
76-
| `state` | Current state of poppy: `closed`, `opened`, `opening`, `closing`, `disabled`. |
77-
78-
79-
## Events
80-
81-
| Name | Called when |
82-
|----|----|----|----|
83-
| `beforeShow` | Container is going to show |
84-
| `show` | Container became visible |
85-
| `beforeHide` | Container is going to hide |
86-
| `hide` | Container became invisible |
87-
| `enable` | Entered active state |
88-
| `disable` | Became inactive |
89-
90-
91-
## License
92-
93-
<a href="http://unlicense.org/UNLICENSE"><img src="http://upload.wikimedia.org/wikipedia/commons/6/62/PD-icon.svg" width="40"/></a>
5+
Poppy is no more going to be supported, use [tip](https://github.com/component/tip) or [popover](https://github.com/component/popover) components instead. They’re well supported and better structured.

‎UNLICENSE‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <http://unlicense.org/>

0 commit comments

Comments
 (0)