From 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Sun, 30 Dec 2012 14:43:00 +0200 Subject: Use sdoc to generate application code documentation --- doc/code/classes/TabHelper.html | 346 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 346 insertions(+) create mode 100644 doc/code/classes/TabHelper.html (limited to 'doc/code/classes/TabHelper.html') diff --git a/doc/code/classes/TabHelper.html b/doc/code/classes/TabHelper.html new file mode 100644 index 00000000000..c7b4c7908ab --- /dev/null +++ b/doc/code/classes/TabHelper.html @@ -0,0 +1,346 @@ + + + + + TabHelper + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
B
+
+ +
+ +
N
+
+ +
+ +
P
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + branches_tab_class() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tab_helper.rb, line 80
+def branches_tab_class
+  if current_page?(branches_project_repository_path(@project)) ||
+    current_controller?(:protected_branches) ||
+    current_page?(project_repository_path(@project))
+    'active'
+  end
+end
+
+
+ +
+ +
+ + + +
+

Navigation link helper

+ +

Returns an `li` element with an ‘active’ class if the supplied +controller(s) and/or action(s) are currently active. The content of the +element is the value passed to the block.

+ +

options - The options hash used to determine if the element is “active” +(default: {})

+ +
:controller   - One or more controller names to check (optional).
+:action       - One or more action names to check (optional).
+:path         - A shorthand path, such as 'dashboard#index', to check (optional).
+:html_options - Extra options to be passed to the list element (optional).
+ +

block - An optional block that will become the contents of the returned

+ +
`li` element.
+ +

When both :controller and :action are specified, BOTH must match in order +to be marked as active. When only one is given, either can match.

+ +

Examples

+ +
# Assuming we're on TreeController#show
+
+# Controller matches, but action doesn't
+nav_link(controller: [:tree, :refs], action: :edit) { "Hello" }
+# => '<li>Hello</li>'
+
+# Controller matches
+nav_link(controller: [:tree, :refs]) { "Hello" }
+# => '<li class="active">Hello</li>'
+
+# Shorthand path
+nav_link(path: 'tree#show') { "Hello" }
+# => '<li class="active">Hello</li>'
+
+# Supplying custom options for the list element
+nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" }
+# => '<li class="home active">Hello</li>'
+
+ +

Returns a list item element String

+
+ + + + + + +
+ +

+ Source: + show + +

+ +
+ +
+ +
+
+ + nav_tab(key, value, &block) + + +
+ + +
+

Use #nav_tab for save +controller/action but different params

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tab_helper.rb, line 89
+def nav_tab key, value, &block
+  o = {}
+  o[:class] = ""
+  o[:class] << " active" if params[key] == value
+
+  if block_given?
+    content_tag(:li, capture(&block), o)
+  else
+    content_tag(:li, nil, o)
+  end
+end
+
+
+ +
+ +
+
+ + project_tab_class() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tab_helper.rb, line 70
+def project_tab_class
+  [:show, :files, :edit, :update].each do |action|
+    return "active" if current_page?(controller: "projects", action: action, id: @project)
+  end
+
+  if ['snippets', 'services', 'hooks', 'deploy_keys', 'team_members'].include? controller.controller_name
+   "active"
+  end
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1