Skip to content

Commit

Permalink
modified: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzos committed Jan 30, 2011
1 parent 5a0dbdf commit d9c1d54
Showing 1 changed file with 19 additions and 29 deletions.
48 changes: 19 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,38 +56,28 @@ CSS rules:
Docs
----------

Implements:
**Implements:** `Options, Events`

Options, Events
**Syntax:**

Syntax and options:

var myImageTip = new MooImageTip(options);
#JS

options (object, optional):
Initial options for the class. Options are:
offset: An object like {x: 16, y: 16} (default), that specify
the distance of the tip from the mouse cursor.
className: Class name of the links to parse (default "imagetip").
tipId: ID for the tip element, for styling (default "mooimagetip").
follow: If TRUE (default) tip will follow mouse cursor movements.
fx: An object for additional Fx options (tip fade in/out).

Events:

shown(me, tip):
Fires when the tip is shown. Me is the MooImageTip object,
Tip is the created element.

hide(me):
Fires when the tip is completely faded out.
Me is the MooImageTip object.
var myImageTip = new MooImageTip(options);

hiding(me, tip):
Fires when tip is starting to hide. Me is the MooImageTip object,
Tip is the tip element.
**Options** (*object*, optional): Initial options for the class. Options are:

- **`offset`**: An object like `{x: 16, y: 16}` (default), that specify the distance of the tip from the mouse cursor.
- **`className`**: Class name of the links to parse (default `"imagetip"`).
- **`tipId`**: ID for the tip element, for styling (default `"mooimagetip"`).
- **`follow`**: If `TRUE` (default) tip will follow mouse cursor movements.
- **`fx`**: An object for additional `Fx` options (tip fade in/out).

**Events:**

- **`shown(me, tip)`**: Fires when the tip is shown. `Me` is the `MooImageTip` object, `Tip` is the created element.
- **`hide(me)`**: Fires when the tip is completely faded out. `Me` is the `MooImageTip` object.
- **`hiding(me, tip)`**: Fires when tip is starting to hide. `Me` is the `MooImageTip` object, `Tip` is the tip element.

Methods:
**Methods:**

getTipId():
Gets the tip element ID.
- **`getTipId()`**: Gets the tip element ID.

0 comments on commit d9c1d54

Please sign in to comment.