Jump to content

Recommended Posts

Happy new year, everybody¬†ūü•¨

I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.

ProcessWire Dashboard

1577998373376.thumb.jpg.0d9081029323d8788ec2e8e84662ae7c.jpg

If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.

Download

You can find the latest release on Github.

Documentation

Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.

Custom Panels

My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.

 Disclaimer

This is a pre-release version. Please treat it as such ‚ÄĒ don't install it on production sites. Just making sure ūüćá

Roadmap

These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.

  • Improve documentation &¬†add examples¬†‚öôÔłŹ
  • Panel types
    • Google Analytics ‚öôÔłŹ
    • Add new page¬†¬†ūüĒ•
    • Drafts ūüĒ•
    • At a glance / Page counter
    • 404s
  • ¬†Layout options
    • Render multiple tabs per panel
    • panel groups with heading and spacing between ‚úÖ
    • panel wrappers as grid item (e.g. stacked notices) ‚úÖ
  • Admin themes
    • support AdminThemeReno and AdminThemeDefault ‚úÖ
  • Shortcuts panel
    • add a table layout with icon, title & summary ‚úÖ
  • Chart panel
    • add default styles for common chart types¬†‚úÖ
    • load chart data from JS file (currently passed as PHP array)
  • Collection panel
    • support image columns ‚úÖ
    • add buttons: view all¬†& add new ‚úÖ
  • Like 35
  • Thanks 10

Share this post


Link to post
Share on other sites

OH MY GOODNESS !! This thing is a beauty¬†ūüėć
Well done sir.

  • Like 3

Share this post


Link to post
Share on other sites

thanks @d'Hinnisda√ęl so i have this working on a site, but i have a question about the shortcuts, how do you make a shortcut to a custom URL, like say a module edit screen, or even an external URL?

Also, how did you get the icon for the Profile to not be a bookmark?

Lastly, I noticed that I had to put the hooks in ready.php, they weren't working in admin.php for some reason...

Also, i think there needs to be a fix for the loading of the module only in admin, may be loading stuff in $config without checking if admin and frontend that use $config->styles might be picking those up (i'm getting errors as i have modules that put css/js into $config only for front end)...

Share this post


Link to post
Share on other sites

@Macrura

1 hour ago, Macrura said:

how do you make a shortcut to a custom URL, like say a module edit screen, or even an external URL?

Also, how did you get the icon for the Profile to not be a bookmark?

Lastly, I noticed that I had to put the hooks in ready.php, they weren't working in admin.php for some reason...

Also, i think there needs to be a fix for the loading of the module only in admin, may be loading stuff in $config without checking if admin and frontend

Shortcut URLs

I have pushed a release that treats strings as URLs so that any of the following options should work:

[
  'shortcuts' => [

    // Page
    $this->pages->get(1132),

    // Page ID
    1020,

    // Overwrite page title
    'New things' => 1020,

    // Set custom URL
    'Backups' => "{$config->urls->admin}setup/db-backups/backup/",

  ],
]

Profile page icon

Check out the PageIcon module which lets you set custom icons for every page.

Hooks in admin.php

That's strange. Do you have any other hooks in admin.php that work? I have tons of hooks there and never had a problem.

$config->styles

True, I don't use the styles array myself so I haven't run into this. Will research a fix.

  • Like 3

Share this post


Link to post
Share on other sites

thanks for the fixes/new stuff!

only issue -  seems with latest version, it loads Dashboard.css into the whole admin, not just the process...

Share this post


Link to post
Share on other sites

thanks - and i guess the version file needs to be updated (?)..

this is working well for me; I have my own dashboard module, but it uses templates, pages and fields, and is thus cumbersome for smaller/low budget sites. My dashboard module uses AdminLTE, so it has stuff like collapsible panels with state recall; For some of the more complex panels like Formbuilder entries, etc, i'll just build custom panels and hook into this module.

Thanks again for building this! This is very extensible, looks and works great, and seems like it will be a very popular module! Here's the dashboard i just threw together...

Dashboard_ibtc.thumb.jpg.92f7b9d64667983954227234848e5448.jpg

  • Like 8

Share this post


Link to post
Share on other sites

@Macrura¬†ūüĎĆ Looks great! I do have a FormBuilder module on the longer wishlist, but can't see myself implementing that too soon. If you ever feel like creating one, I'd be more than happy to merge it into the main module.

Share this post


Link to post
Share on other sites

@d'Hinnisda√ęl¬†thanks for this module! haven't tested it properly, just quick observation: user label (title|name) is not displayed in headline in AdminThemeDefault. Also pagelist could use same margins.

image.png.933daf8a52464ca4083971ce99f924df.png

Share this post


Link to post
Share on other sites

@matjazp I added a release that adds the margins back in for the default admin theme.

Concerning the user name display: I can't reproduce that on the current master version (3.0.148) with AdminThemeDefault. However, the latest release only displays 'Welcome' without a comma if the user name comes out empty. Why it would be empty, I don't know, since it's working fine here.

  • Like 1

Share this post


Link to post
Share on other sites

Title is not displayed even if I use AdminThemeUikit. Problematic is this line:

$userLabel = $this->modules->getConfig('AdminThemeUikit', 'userLabel') ?: 'title|name'; // return "{Name}"

Note that $userLabel is always {Name}, regardless of what theme is used. What happens if AdminThemeUikit is not installed? If I set $userLabel to 'title|name' then the title is displayed. Perhaps you should specify in module settings the minimum PW version (guess its 3.0.66 - when getConfig() is introduced) and minimum PHP version (at least 7.0?).

Share this post


Link to post
Share on other sites

@matjazp I think I found a fix for the issue you're describing. Please check out the latest release from GitHub and let me know if the problem persist.

I also added version constraints (PHP 7 and the previous stable ProcessWire release 3.0.123).

Share this post


Link to post
Share on other sites

Yep, working, even with {title} set for userLabel. Thank you.

Share this post


Link to post
Share on other sites

Perhaps actions col in collections (DashboardTableColumn__actions__) don't need to be sortable? Would be nice if we could set the icon for every shortcut in Shortcuts panel, regradless if page has the icon set. On the other hand, I can create my own panel :-) Is support for IE11 planned?

Share this post


Link to post
Share on other sites
14 hours ago, matjazp said:

Perhaps actions col in collections (DashboardTableColumn__actions__) don't need to be sortable? Would be nice if we could set the icon for every shortcut in Shortcuts¬†panel, regradless if page has the icon¬†set. On the other hand, I can create my own panel ūüôā Is support for IE11 planned?

You're right about the actions column ‚ÄĒ I pushed a release that hides the table sort arrows. Also, I added a readme section on how to set custom icons per shortcut:

  'shortcuts' => [
    'Updates' => 1020,           // Override title
    'Updates' => [1020, 'gear'], // Override title + icon
  ],

Support for IE is definitely not planned. I'm happy to take pull requests, though, if you find a way to pull it off ūü¶ú

  • Like 4

Share this post


Link to post
Share on other sites

Thanks for this nice Module... 

Unfortunately I have a problem, I can't open the admin area any more, only the following error occurs:

Fatal error: Class 'ProcessWire\DashboardPanel' not found in /var/www/vhosts/**MYHOSTING**/site/modules/Dashboard/DashboardPanelNumber.module on line 5

ūüė쬆¬†ProcessWire 3.0.148

 

/edit:¬†I could fix the error, I did not upload the module via the ZIP file, but directly via the FTP ūüėȬ†

Are there any problems here if you install the module directly via Processwire?

 

And one question:

How to configure the "collection", that a edit modal is used, and not target=_blank?

 

 

Found¬†a little bug ūüôā¬†

1643964198_2020-01-1409_29_31-Window.png.6fa1ffef5abf840b378e29ed9dead9e4.png

Share this post


Link to post
Share on other sites

@zoeck That error means one of the panel modules is loaded before the base class. This shouldn't be an issue anymore since I raised the main module's autoload priority. I made a note try out the web installer soon.

The empty dashboard message looks fine here, rendered as a link. Does the dashboard itself render correctly once you configure the panels? The template file doesn't escape any of the output values, so I'm a bit confused as to why this could be. Do you have any modules installed that might overwrite or change the _() function of ProcessWire in any way?

Share this post


Link to post
Share on other sites
1 hour ago, d'Hinnisda√ęl said:

The empty dashboard message looks fine here, rendered as a link. Does the dashboard itself render correctly once you configure the panels? The template file doesn't escape any of the output values, so I'm a bit confused as to why this could be. Do you have any modules installed that might overwrite or change the _() function of ProcessWire in any way?

Hm, thats strange...

The following modules are used:
ListerPro, ProcessWireUpgrade, Pages Sum, LoginPersist, Inputfield Decimal, Front-End Edit Lightbox

I don't think that anything here changes the _() function

 

Is it possible to configure the "collection", that a edit modal is used, and not target=_blank?

 

/edit: ok i found it... when the LanguageSupport module is activated, the problem occurs. even if only one language is active

Share this post


Link to post
Share on other sites

@zoeck Ok, thanks, in that case I'll need to test the module in multi-language environments.

The modal editing of collection links is work in progress, but it's not as straight-forward as I hoped it would be ‚öôÔłŹ

Share this post


Link to post
Share on other sites
22 minutes ago, d'Hinnisda√ęl said:

The modal editing of collection links is work in progress, but it's not as straight-forward as I hoped it would be ‚öôÔłŹ

What's the problem? ūüôā¬†

Just tested it with a quick and dirty edit of "DashboarPanelCollection.module". I just added the "pw-modal" class to the link, and removed the target...

And the Jquery UI is needed:

wire('modules')->get('JqueryUI')->use('modal');

It is not so easy if the modal should be closed automatically when you save ūüė쬆

 

/BTW: i love your dashboard ūüĎć

Share this post


Link to post
Share on other sites
50 minutes ago, zoeck said:

What's the problem? ūüôā¬†

What you said: closing the modal on save is a requirement for me. I'll have to have a look at how the core does it in the template field editor, for example.

I was looking into having the PageList links open in a modal as well, but that can be a later release as well.

  • Like 1

Share this post


Link to post
Share on other sites

Haven't tried out the module **yet**, but I love the look of these dashboards.

One panel that could be useful is a content overview panel like in Wordpress.  It would show the amount of pages for each type of page with a link to the built in pages lister that shows all pages filter for that page type.

image.png.7c68dfab0cdd0cdd580de7566bc41b9a.png

Another feature that might be useful would be the ability to create multiple dashboard pages, or tabs within dashboards like what is shown in the Drupal Workbench module?  This could be a dashboard for the user?

image.thumb.png.db81048cb564a504d9e8389f4bd41abc.png

Maybe you could have a site dashboard(displayed when clicking on the main logo or the Processwire logo or visiting the main processwire admin page at /processwire) and a user dashboard(displayed when a user first logs into the Processwire Admin)?

Here is what a "My dashboard"(from drupal.org) for users could look like

138499719_HomeboxDrupal.org2020-01-1409-42-23.jpg.cfb534b2212dbe70060c434d8698f30d.jpg

If we had the ability to create multiple dashboard pages then while creating/editing each dashboard page, you can choose which roles are allowed to view the page. If you do not choose any roles, then only admins can view the dashboard page.  For obvious reasons, anonymous users will not be able to save pages or add custom items.

All of this might be too complex, but I thought would just get these thoughts out of my head in case anybody liked them.

Here is another dashboard I found just to give others some ideas of what could probably be created with this module.

varbase-total-control-admin-dashboard_0.jpg.ee8aae33e674f8224b4e96bbc59bc4b1.jpg

Anyways, thanks for making this module.  Look forward to trying it soon.

  • Like 2

Share this post


Link to post
Share on other sites

Wow! Have just gone through the docs and this looks spectacular, congrats on the awesome work!

  • Like 1

Share this post


Link to post
Share on other sites

I just installed the latest release from github and get the same "Your dashboard is empty" error as zoeck

I have not installed multilanguage and it is a fresh install of the latest ProcessWire 1.0.148

To site/template/admin.php I added after the 

require $config->paths->adminTemplates . 'controller.php';
wire()->addHookAfter('Dashboard::getPanels', function ($event) {
    /* Get list of panels */
    $panels = $event->return;

    /* Add panels */
    $panels->add([
        'panel' => 'collection',
        'title' => 'News items',
        'data' => [
            'collection' => 'template=basic-page, limit=10',
            'sortable' => true,
        ],
    ]);
});

but the "Your dashboard is empty" message still appears.

I did not set the dashboard as the entry point. 

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
√ó
√ó
  • Create New...