diff options
| author | schneefux <schneefux+commit@schneefux.xyz> | 2017-03-25 13:13:57 +0100 |
|---|---|---|
| committer | schneefux <schneefux+commit@schneefux.xyz> | 2017-03-25 13:13:57 +0100 |
| commit | d25ff2bddd44b9dac1ceb248424109d1782dd211 (patch) | |
| tree | 34fcfd824a1a72e7b4d431b688adcea532b62180 /minionlivesmatter/templates/assets/tether/docs/3-Advanced | |
| parent | a2cbdd1b88ac723e5e441c0a3c22636f0a8c4dfd (diff) | |
| download | meta-d25ff2bddd44b9dac1ceb248424109d1782dd211.tar.gz meta-d25ff2bddd44b9dac1ceb248424109d1782dd211.zip | |
add minionlivesmatter as submodule
Diffstat (limited to 'minionlivesmatter/templates/assets/tether/docs/3-Advanced')
| -rw-r--r-- | minionlivesmatter/templates/assets/tether/docs/3-Advanced/1-embedding_tether.md | 9 | ||||
| -rw-r--r-- | minionlivesmatter/templates/assets/tether/docs/3-Advanced/2-extending_tether.md | 54 |
2 files changed, 0 insertions, 63 deletions
diff --git a/minionlivesmatter/templates/assets/tether/docs/3-Advanced/1-embedding_tether.md b/minionlivesmatter/templates/assets/tether/docs/3-Advanced/1-embedding_tether.md deleted file mode 100644 index f47be16..0000000 --- a/minionlivesmatter/templates/assets/tether/docs/3-Advanced/1-embedding_tether.md +++ /dev/null @@ -1,9 +0,0 @@ -## Embedding Tether - -Tether is designed to be embeddable in other libraries. - -There is one thing you should think about doing to create an embedded Tether: - -- Set the `classPrefix` of the tethers you create. That prefix will replace `'tether'` in -all of the classes. You can also disable classes you don't intend on using with the `classes` -option. diff --git a/minionlivesmatter/templates/assets/tether/docs/3-Advanced/2-extending_tether.md b/minionlivesmatter/templates/assets/tether/docs/3-Advanced/2-extending_tether.md deleted file mode 100644 index fa357b2..0000000 --- a/minionlivesmatter/templates/assets/tether/docs/3-Advanced/2-extending_tether.md +++ /dev/null @@ -1,54 +0,0 @@ -Extending Tether ------ - -Tether has a module system which can be used to modify Tether's positioning, or just do something each time the Tether is moved. - -Tether has an array called `Tether.modules`, push onto it to add a module: - -```coffeescript -Tether.modules.push - position: ({top, left}) -> - top += 10 - - {top, left} -``` - -#### Position - -Your position function can either return a new object with `top` and `left`, `null`/`undefined` to leave the coordinates unchanged, or -`false` to cancel the positioning. - -The position function is passed an object with the following elements: - -```javascript -{ - left, // The element's new position, from the top left corner of the page - top, - targetAttachment, // The targetAttachment, with 'auto' resolved to an actual attachment - targetPos, // The coordinates of the target - attachment, // The attachment, as passed in the option - elementPos, // The coordinates of the element - offset, // The offset, after it's converted into pixels and the manual offset is added - targetOffset, // The attachment is converted into an offset and is included in these values - manualOffset, // The manual offset, in pixels - manualTargetOffset -} -``` - -It is called with the Tether instance as its context (`this`). - -#### Initialize - -Modules can also have an `initialize` function which will be called when a new tether is created. The initialize function -is also called with the Tether instance as its context. - -```coffeescript -Tether.modules.push - initialize: -> - console.log "New Tether Created!", @ -``` - -#### Examples - -[Constraints](https://github.com/HubSpot/tether/blob/master/src/js/constraint.js) and [shift](https://github.com/HubSpot/tether/blob/master/src/js/shift.js) are both implemented as modules. -[Mark Attachment](https://github.com/HubSpot/tether/blob/master/src/js/markAttachment.js) is used by the docs. |
