Class: Blacklight::Document::BookmarkComponent

Inherits:

ActionComponent

• Object
• ViewComponent::Base
• Component
• ActionComponent
• Blacklight::Document::BookmarkComponent

Defined in:

app/components/blacklight/document/bookmark_component.rb

Overview

Render a bookmark widget to bookmark / unbookmark a document

Constant Summary

Constants inherited from Component

Component::EXCLUDE_VARIABLES

Instance Method Summary

• #bookmark_path ⇒ Object
• #bookmarked? ⇒ Boolean
• #initialize(document:, action: nil, checked: nil, bookmark_path: nil, **kwargs) ⇒ BookmarkComponent constructor

  A new instance of BookmarkComponent.

Methods inherited from ActionComponent

#key, #label, #link_to_modal_control, #render_control, #render_partial, #url, #using_default_document_action?

Methods inherited from Component

compiler, config, #inspect

Constructor Details

#initialize(document:, action: nil, checked: nil, bookmark_path: nil, **kwargs) ⇒ BookmarkComponent

Returns a new instance of BookmarkComponent.

Parameters:

• document (Blacklight::Document)
• action (Blacklight::Configuration::ToolConfig) (defaults to: nil)
• checked (Boolean) (defaults to: nil)
• bookmark_path (Object) (defaults to: nil) —

  the rails route to use for bookmarks

# File 'app/components/blacklight/document/bookmark_component.rb', line 11

def initialize(document:, action: nil, checked: nil, bookmark_path: nil, **kwargs)
  @document = document
  @checked = checked
  @bookmark_path = bookmark_path
  super(document: document, action: action, **kwargs)
end

Instance Method Details

#bookmark_path ⇒ Object

# File 'app/components/blacklight/document/bookmark_component.rb', line 24

def bookmark_path
  @bookmark_path || helpers.bookmark_path(@document)
end

#bookmarked? ⇒ Boolean

Returns:

• (Boolean)

# File 'app/components/blacklight/document/bookmark_component.rb', line 18

def bookmarked?
  return @checked unless @checked.nil?

  helpers.bookmarked? @document
end