/ 
Dancer2-Plugin-LiteBlog-0.02
River stage zero No dependents
/ Dancer2::Plugin::LiteBlog::Widget

NAME

Dancer2::Plugin::LiteBlog::Widget - Base class for LiteBlog widgets

SYNOPSIS

This is an abstract class and should be subclassed.

USAGE

package MyWidget;
use Moo;
extends 'Dancer2::Plugin::LiteBlog::Widget';

sub elements {
    # Implement the elements method
    # $element = []; ...
    return $elements;
}

DESCRIPTION

This is a base class (interface) for widgets used in LiteBlog, a Dancer2 plugin. Widgets that extends that interface are expected to implement certain methods to be functional.

Widgets in LiteBlog are used to render some UI elements in the site and can provide their own views and CSS.

ATTRIBUTES

root

The `root` attribute specifies the root directory for the widget. It's a required attribute and must be a valid directory, or an error will be thrown.

This directory is the base directory of the widget, where resources will be looked for such as YAML or Markdown files, depending on the implementation of the widget.

METHODS

elements

This method must be implemented by any class inheriting from this module. It must return a list of objects that will be iterated over in the widget's template for rendering. The objects themselves depend on the widget and should be coherent with the associated view.

See Dancer2::LiteBlog::Widget::Activities for a simple example.

has_routes

If the widget adds route to the Dancer2 application, it should override this method to return a true value.

declare_routes($self, $plugin, $config)

Any widget intending to declare its own routes should implement this method. The method is passed the Dancer2::Plugin $plugin object associated with LiteBlog (which provides handlers to the DSL and other Dancer2's internal APIs, and the Widget's config section.

sub declare_routes {
    my ($self, $plugin, $config) = @_;
    $plugin->app->add_route(
        ...
    );
}

SEE ALSO

Dancer2::Plugin::LiteBlog, Dancer2, Moo

AUTHOR

Alexis Sukrieh, sukria@gmail.com

COPYRIGHT AND LICENSE

Copyright 2023 by Alexis Sukrieh.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.