-
Notifications
You must be signed in to change notification settings - Fork 22
/
navigationbar-iphone-api.txt
59 lines (46 loc) · 1.41 KB
/
navigationbar-iphone-api.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# NavBar API
<span class="label label-important">RUBY</span> <span class="label label-inverse">RHOELEMENTS</span> <span class="label">RHODES</span>
The NavBar API supports a native navigation bar for the iPhone.
## create
Creates a navigation bar for the iPhone.
:::ruby
NavBar.create(navbar-elements)
The navbar-elements parameter is a list of name/value pairs from the following list of navbar elements.
<table border="1">
<tr>
<td><code>:title</code></td>
<td>String. Title of the navigation bar.</td>
</tr>
<tr>
<td><code>:left</code></td>
<td>Left button with :action and :label defined.</td>
</tr>
<tr>
<td><code>:right</code></td>
<td>(optional) Right button with :action and :label defined.</td>
</tr>
</table>
The :left and :right buttons use the following parameters:
<table border="1">
<tr>
<td><code>:action</code></td>
<td>action to perform (click here for the menu-toolbar-tabbar actions), or url to open, when the button is pressed.</td>
</tr>
<tr>
<td><code>:label</code></td>
<td>Label for the button.</code>.</td>
</tr>
</table>
### Example call
:::ruby
NavBar.create :title => "Navigation bar",
:left => {
:action => :back,
:label => "Back"},
:right => {
:action => url_for(:action => :help),
:label => "Help"}
## remove
Removes a navigation bar from the iPhone.
:::ruby
NavBar.remove