clear01/nette-widgets

Nette widgets extension. Based on clear01/widgets.

v0.2 2017-05-16 08:38 UTC

This package is auto-updated.

Last update: 2024-04-04 09:02:25 UTC


README

Briefing

This package brings support of widgets to your Nette projects. It's build upon the package clear01/widgets-core, the widgets model base.

It provides Nette specific implementation of abstract entities and introduces an extension for easy widget registration.

This documentation describes only the Nette-related implementation, the common widget model is described in clear01/widgets-core package as long as it can be used within a different framework (Symfony,..) or as it is.

Requirements

  • PHP >= 5.5

  • Nette >= 2.1

  • clear01/widgets-core package

Further packages

Because this package does not implement all the abstract entities of clear01/widgets-core, further packages can be used to reach the out-of-the-box solution (or to get a bit of inspiration for your own implementation).

Persistence layer implementations
Dashboard management components

Example usage

config.neon

widgets:
    available:
        - \App\Widgets\IUpcomingEventsComponentFactory
        - \Clear01\Widgets\Nette\TemplateWidgetDeclarationFactory(%appDir%/WidgetTemplates/Greeting.latte)
        - \App\Widgets\Clock
        - \App\Widgets\EmergencyButtonsFactory

YourOwnSuperCoolDashboardManagementComponent.php

class DashboardComponent {

    /** @var \Clear01\Widgets\IWidgetManager **/
    protected $widgetManager;

    ...
}

Installation

!!! This package is not a complete out-of-box solution (see the section "Further packages")

This package is available on packagist. Run the following command to add your dependency.

$ composer require clear01/nette-widgets

Documentation

Learn more in the documentation.