Skip to content

Commit 5ed2370

Browse files
committed
Added design goals section to readme.
1 parent 7c23a41 commit 5ed2370

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,36 @@ PowerTip features a very flexible design that is easy to customize, gives you a
2828

2929
* jQuery 1.7 or later
3030

31+
## Design Goals
32+
33+
* **Tooltips that behave like they would in desktop applications**
34+
35+
Tooltips should not flicker or be difficult to interact with. Only one tooltip should be visible on the screen at a time. When the cursor moves to another item with a tooltip then the last tooltip should close gracefully before the new one opens.
36+
37+
* **Fade-in and fade-out**
38+
39+
The tooltips will have smooth fade-in and out cycles instead of abruptly appearing a disappearing. The fade effects will not conflict with any other effects in the document.
40+
41+
* **Check for hover intent**
42+
43+
Tooltips should not suddenly appear as soon as your mouse happens to cross the object. They should only open when the cursor hovers over an element for a moment indicating that the user is actively focused on that element.
44+
45+
* **Support multiple instances**
46+
47+
Have various kinds of tooltips in one document, each with their own settings and content, even with different tooltip divs and styling. All while still preserving the one-tooltip rule and behaving like one instance.
48+
49+
* **Totally portable**
50+
51+
The plugin does not require any other plugins or extensions to function. There will be no dependencies other than the core jQuery library. The plugin does not require any images, all layout will be entirely CSS based.
52+
53+
* **Easy to use**
54+
55+
Despite all of the complexity involved (timers, animations, multiple instances) the plugin will be dead simple to use, requiring little to no configuration to get running.
56+
57+
* **Easy to customize**
58+
59+
Tooltip layout and functionality should be simple to modify for your own personal touch. Layout should be done entirely with CSS and the plugin will not attach any inline styles other than to control visibility and positioning.
60+
3161
## Usage
3262

3363
Running the plugin is about as standard as it gets.

0 commit comments

Comments
 (0)