Skip to content

Commit

Permalink
Update tip docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@hlfcoding
hlfcoding committed May 29, 2012
1 parent 4aaf38d commit 6b3d1e2
Show file tree
Hide file tree
Showing 5 changed files with 278 additions and 177 deletions.
12 changes: 9 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# HLF jQuery Plugins

Gourmet jQuery plugins.
jQuery plugins for quality UI. All plugins have test pages and sample styles.

## HLF Tip
- In progress

- Uses custom hover intent events that allow for custom delays.
- Re-use the same tip for a group of triggers.
- Has a snapping extension that allows snapping to the trigger or tracking in either direction.
- Sample styling that draws tip stems with CSS borders.
- Detailed API.
- More coming...

## HLF Gallery
- Coming soon
- Coming soon...
27 changes: 14 additions & 13 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,27 @@
Released under the MIT License <br />
Written with jQuery 1.7.2 </p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">$ = </span><span class="nx">jQuery</span>

<span class="k">if</span> <span class="o">not</span> <span class="nx">_</span><span class="o">?</span> <span class="k">then</span> <span class="k">throw</span> <span class="s2">&quot;UnderscoreJS required.&quot;</span>
<span class="k">if</span> <span class="o">not</span> <span class="nx">_</span><span class="o">?</span> <span class="k">then</span> <span class="k">throw</span> <span class="s">&quot;UnderscoreJS required.&quot;</span>

<span class="nv">_.templateSettings = interpolate: </span><span class="sr">/\{\{(.+?)\}\}/g</span>

<span class="nv">$.hlf =</span>
<span class="nv">createPlugin: </span><span class="nf">(ns, apiClass, asSingleton=no) -&gt;</span>
<span class="nv">ns.apiClass = </span><span class="nx">apiClass</span>
<span class="nv">nsEvt = </span><span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s1">&#39;event&#39;</span>
<span class="nv">nsDat = </span><span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s1">&#39;data&#39;</span>
<span class="nv">nsEvt = </span><span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s">&#39;event&#39;</span>
<span class="nv">nsDat = </span><span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s">&#39;data&#39;</span>
<span class="k">return</span> <span class="nf">(opt, $ctx) -&gt;</span>
<span class="nv">$el = </span><span class="kc">null</span>
<span class="nv">$el = </span><span class="kc">null</span> <span class="c1"># Set to right scope.</span>
<span class="nv">boilerplate = </span><span class="o">-&gt;</span>
<span class="p">(</span><span class="k">if</span> <span class="nx">asSingleton</span> <span class="o">is</span> <span class="kc">no</span> <span class="k">then</span> <span class="nx">$el</span> <span class="k">else</span> <span class="nx">$ctx</span><span class="p">).</span><span class="nx">addClass</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s1">&#39;class&#39;</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_evt</span> <span class="o">?=</span> <span class="nf">(name) -&gt;</span> <span class="s2">&quot;#{name}#{nsEvt}&quot;</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_dat</span> <span class="o">?=</span> <span class="nf">(name) -&gt;</span> <span class="s2">&quot;#{nsDat}#{name}&quot;</span>
<span class="nv">$root = </span><span class="k">if</span> <span class="nx">asSingleton</span> <span class="o">is</span> <span class="kc">no</span> <span class="k">then</span> <span class="nx">$el</span> <span class="k">else</span> <span class="nx">$ctx</span>
<span class="nx">$root</span><span class="p">.</span><span class="nx">addClass</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s">&#39;class&#39;</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_evt</span> <span class="o">?=</span> <span class="nf">(name) -&gt;</span> <span class="s">&quot;</span><span class="si">#{</span><span class="nx">name</span><span class="si">}#{</span><span class="nx">nsEvt</span><span class="si">}</span><span class="s">&quot;</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_dat</span> <span class="o">?=</span> <span class="nf">(name) -&gt;</span> <span class="s">&quot;</span><span class="si">#{</span><span class="nx">nsDat</span><span class="si">}#{</span><span class="nx">name</span><span class="si">}</span><span class="s">&quot;</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_log</span> <span class="o">?=</span> <span class="k">if</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">debug</span> <span class="o">is</span> <span class="kc">on</span> <span class="k">then</span> <span class="nx">$</span><span class="p">.</span><span class="nx">hlf</span><span class="p">.</span><span class="nx">log</span> <span class="k">else</span> <span class="nx">$</span><span class="p">.</span><span class="nx">noop</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_nsLog</span> <span class="o">?=</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s1">&#39;log&#39;</span>
<span class="nx">$el</span><span class="p">.</span><span class="nx">data</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span><span class="p">(),</span> <span class="k">new</span> <span class="nx">apiClass</span> <span class="nx">$el</span><span class="p">,</span> <span class="nx">opt</span><span class="p">,</span> <span class="nx">$ctx</span>
<span class="nx">apiClass</span><span class="o">::</span><span class="nx">_nsLog</span> <span class="o">?=</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span> <span class="s">&#39;log&#39;</span>
<span class="nx">$root</span><span class="p">.</span><span class="nx">data</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span><span class="p">(),</span> <span class="k">new</span> <span class="nx">apiClass</span> <span class="nx">$el</span><span class="p">,</span> <span class="nx">opt</span><span class="p">,</span> <span class="nx">$ctx</span>

<span class="nx">$ctx</span> <span class="o">?=</span> <span class="nx">$</span> <span class="s1">&#39;body&#39;</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <ul>
<span class="nx">$ctx</span> <span class="o">?=</span> <span class="nx">$</span> <span class="s">&#39;body&#39;</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <ul>
<li>Try returning existing plugin api if no options are passed in.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">api = </span><span class="nx">@first</span><span class="p">().</span><span class="nx">data</span> <span class="nx">ns</span><span class="p">.</span><span class="nx">toString</span><span class="p">()</span>
<span class="k">return</span> <span class="nx">api</span> <span class="k">if</span> <span class="nx">api</span><span class="o">?</span> <span class="o">and</span> <span class="o">not</span> <span class="nx">opt</span><span class="o">?</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <ul>
Expand All @@ -30,17 +31,17 @@

<span class="k">if</span> <span class="nx">asSingleton</span> <span class="o">is</span> <span class="kc">no</span>
<span class="k">return</span> <span class="nx">@each</span> <span class="o">-&gt;</span>
<span class="nv">$el = </span><span class="nx">$</span><span class="p">(</span><span class="err">@</span><span class="p">)</span>
<span class="nv">$el = </span><span class="nx">$</span><span class="p">(</span><span class="nx">@</span><span class="p">)</span>
<span class="nx">boilerplate</span><span class="p">()</span>

<span class="k">else</span>
<span class="nv">$el = </span><span class="err">@</span>
<span class="nv">$el = </span><span class="nx">@</span>
<span class="nx">boilerplate</span><span class="p">()</span>



<span class="nv">debug: </span><span class="kc">on</span> <span class="c1"># Turn this off when going to production.</span>
<span class="nv">toString: </span><span class="o">-&gt;</span> <span class="s1">&#39;hlf&#39;</span>
<span class="nv">toString: </span><span class="o">-&gt;</span> <span class="s">&#39;hlf&#39;</span>

<span class="nv">$.hlf.log = </span><span class="k">if</span> <span class="nx">$</span><span class="p">.</span><span class="nx">hlf</span><span class="p">.</span><span class="nx">debug</span> <span class="o">is</span> <span class="kc">off</span> <span class="k">then</span> <span class="nx">$</span><span class="p">.</span><span class="nx">noop</span> <span class="k">else</span>
<span class="p">(</span><span class="k">if</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">.</span><span class="nx">bind</span> <span class="k">then</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">console</span><span class="p">)</span> <span class="k">else</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit 6b3d1e2

Please sign in to comment.