Sha256: 1e28890044c4707ff5f010326c7286dedf3396416bdd728649c7531691ad5849
Contents?: true
Size: 1.95 KB
Versions: 27
Compression:
Stored size: 1.95 KB
Contents
module Pageflow
class WidgetType
class NotFoundError < RuntimeError
end
# Name to display in editor.
def translation_key
"pageflow.#{name}.widget_type_name"
end
# Override to return a string in snake_case.
def name
raise(NotImplementedError, 'WidgetType subclass needs to define name method.')
end
# Override to return array of role names.
def roles
raise(NotImplementedError, 'WidgetType subclass needs to define roles method.')
end
# Override to return false to hide widget in editor.
def enabled_in_editor?
true
end
# Override to return false to hide widget in entry preview.
def enabled_in_preview?
true
end
# Point in DOM where widget should be inserted. Possible values
# are `:bottom_of_entry` (default) or `:before_entry`.
#
# @since 13.0
def insert_point
:bottom_of_entry
end
# Override instead of render to use the widget
# configuration. Return html as string.
def render_with_configuration(template, entry, _configuration)
render(template, entry)
end
# Override to return html as string.
def render(template, entry)
template.render(File.join('pageflow', name, 'widget'), entry: entry)
end
# Override instead of render_head_fragment to use the widget
# configuration. Return html as string that should be placed in
# the head element of the page.
def render_head_fragment_with_configuration(template, entry, _configuration)
render_head_fragment(template, entry)
end
# Override to return html that should be placed in the head
# element of the page. Not supported inside the editor.
def render_head_fragment(template, entry)
''
end
class Null < WidgetType
def initialize(role)
@role = role
end
def name
'null'
end
def roles
[@role]
end
def render(*)
''
end
end
end
end
Version data entries
27 entries across 27 versions & 1 rubygems