class JsDuck::Categories::ClassName

Renders class names for class categories page.

Public Class Methods

new(doc_formatter, relations={}) click to toggle source
# File lib/jsduck/categories/class_name.rb, line 6
def initialize(doc_formatter, relations={})
  @doc_formatter = doc_formatter
  @relations = relations
end

Public Instance Methods

render(name) click to toggle source

Renders the class name as a link or plain text.

For new classes appends a star behind class name. For classes with new members appends list n small stars behind class name (reflecting the number of new members).

# File lib/jsduck/categories/class_name.rb, line 16
def render(name)
  cls = @relations[name]
  if cls
    @doc_formatter.link(name, nil, name) + render_new_label(cls)
  else
    name
  end
end

Private Instance Methods

render_new_label(cls) click to toggle source

Adds small star to new classes in the current version.

# File lib/jsduck/categories/class_name.rb, line 28
def render_new_label(cls)
  if cls[:new]
    "&nbsp;<span class='new-class' title='New class'>&#9733;</span>"
  else
    ""
  end
end