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 34
  • Thanks 7

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 2

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 joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="optin" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="optin" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback ūüôā
      CHANGELOG
      0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By MoritzLost
      This is a new module that provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Beta release
      Note that I consider this a Beta release. Since the module is relatively aggressive in deleting some caches, I would advise you to install in on a test environment before using it on a live site.
      Let me know if you're getting any errors, have trouble using the module or if you have suggestions for improvement!
      In particular, can someone let me know if this module causes any problems with the ProCache module? I don't own or use it, so I can't check. As far as I can tell, ProCache uses a folder inside the cache directory to cache static pages, so my module should be able to clear the ProCache site cache as well, I'd appreciate it if someone can test that for me.
      Future plans
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory

    • By David Karich
      Admin Page Tree Multiple Sorting
      ClassName: ProcessPageListMultipleSorting
      Extend the ordinary sort of children of a template in the admin page tree with multiple properties. For each template, you can define your own rule. Write each template (template-name) in a row, followed by a colon and then the additional field names for sorting.
      Example: All children of the template "blog" to be sorted in descending order according to the date of creation, then descending by modification date, and then by title. Type:
      blog: -created, -modified, title  Installation
      Copy the files for this module to /site/modules/ProcessPageListMultipleSorting/ In admin: Modules > Check for new modules. Install Module "Admin Page Tree Multible Sorting". Alternative in ProcessWire 2.4+
      Login to ProcessWire backend and go to Modules Click tab "New" and enter Module Class Name: "ProcessPageListMultipleSorting" Click "Download and Install"   Compatibility   I have currently tested the module only under PW 2.6+, but think that it works on older versions too. Maybe someone can give a feedback.     Download   PW-Repo: http://modules.processwire.com/modules/process-page-list-multiple-sorting/ GitHub: https://github.com/FlipZoomMedia/Processwire-ProcessPageListMultipleSorting     I hope someone can use the module. Have fun and best regards, David
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "https://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


√ó
√ó
  • Create New...