<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Ballast::Emoji::Character
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!Ballast/Emoji/Character.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> » <span class='title'><span class='object_link'><a href="../Emoji.html" title="Ballast::Emoji (module)">Emoji</a></span></span>
»
<span class="title">Character</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Ballast::Emoji::Character
</h1>
<dl class="box">
<dt class="r1">Includes:</dt>
<dd class="r1">ActionView::Helpers::TagHelper, ActiveSupport::Concern</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/ballast/emoji.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Extensions for a emoji character.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#image_tag-instance_method" title="#image_tag (instance method)">- (String) <strong>image_tag</strong>(options = {}) </a>
(also: #html)
</span>
<span class="summary_desc"><div class='inline'><p>Returns a image tag for the current character.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#markup-instance_method" title="#markup (instance method)">- (String) <strong>markup</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a markup for the current character.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url-instance_method" title="#url (instance method)">- (String) <strong>url</strong> </a>
(also: #image)
</span>
<span class="summary_desc"><div class='inline'><p>Returns a image URL for the current character.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="image_tag-instance_method">
- (<tt>String</tt>) <strong>image_tag</strong>(options = {})
<span class="aliases">Also known as:
<span class="names"><span id='html-instance_method'>html</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a image tag for the current character.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The options for the tag generation.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>ActionView::Helpers::TagHelper#tag</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99
100
101
102
103
104
105
106</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 97</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_image_tag identifier id'>image_tag</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='rubyid_options identifier id'>options</span><span class='dot token'>.</span><span class='rubyid_reverse_merge identifier id'>reverse_merge</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='label val'>alt:</span> <span class='rubyid_markup identifier id'>markup</span><span class='comma token'>,</span> <span class='label val'>title:</span> <span class='rubyid_markup identifier id'>markup</span><span class='comma token'>,</span> <span class='label val'>rel:</span> <span class='string val'>"tooltip"</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
<span class='rubyid_classes identifier id'>classes</span> <span class='assign token'>=</span> <span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:class</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_tokenize identifier id'>tokenize</span><span class='lparen token'>(</span><span class='label val'>pattern:</span> <span class='regexp val'>/[\s,]+/</span><span class='comma token'>,</span> <span class='label val'>no_duplicates:</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
<span class='rubyid_classes identifier id'>classes</span> <span class='lshft op'><<</span> <span class='string val'>"emoji"</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_classes identifier id'>classes</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='string val'>"emoji"</span><span class='rparen token'>)</span>
<span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:src</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_url identifier id'>url</span>
<span class='rubyid_options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:class</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_classes identifier id'>classes</span><span class='dot token'>.</span><span class='rubyid_uniq identifier id'>uniq</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>" "</span><span class='rparen token'>)</span>
<span class='rubyid_tag identifier id'>tag</span><span class='lparen token'>(</span><span class='symbol val'>:img</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="markup-instance_method">
- (<tt>String</tt>) <strong>markup</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a markup for the current character.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The markup for a character.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 82</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_markup identifier id'>markup</span>
<span class='dstring node'>":#{name}:"</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="url-instance_method">
- (<tt>String</tt>) <strong>url</strong>
<span class="aliases">Also known as:
<span class="names"><span id='image-instance_method'>image</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a image URL for the current character.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The image URL for the current character.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 89</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_url identifier id'>url</span>
<span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='dot token'>.</span><span class='rubyid_url_for identifier id'>url_for</span><span class='lparen token'>(</span><span class='rubyid_image_filename identifier id'>image_filename</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Jan 31 12:23:08 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.0).
</div>
</body>
</html>