Jump to content
regesh

Tabs in module config page

Recommended Posts

Is it possible to create tabs for settings in module?

Share this post


Link to post
Share on other sites

Out of the box it is not possible. You might want to check out the settings page of AdminOnSteroids from @tpr to see a well organized page with loads of options.

Share this post


Link to post
Share on other sites

You could group some config fields inside a fieldset and set it to collapsed.

$fieldset = $this->modules->get("InputfieldFieldset");
$fieldset->collapsed = Inputfield::collapsedYes;
// add some fields to $fieldset

 

  • Like 1

Share this post


Link to post
Share on other sites
12 hours ago, Robin S said:

You could group some config fields inside a fieldset and set it to collapsed.


$fieldset = $this->modules->get("InputfieldFieldset");
$fieldset->collapsed = Inputfield::collapsedYes;
// add some fields to $fieldset

 

And how to add them via api in module.config file?

Share this post


Link to post
Share on other sites
On 10.12.2016 at 10:39 AM, regesh said:

Is it possible to create tabs for settings in module?

With a little experience in PW: Yes it is. :rolleyes:

Have a look at 'JqueryWireTabs' module. There is a small readme file. Check out this.
Furthermore you need to instantiate 'WireTabs' via JavaScript.

 

  • Like 1

Share this post


Link to post
Share on other sites

Yesterday I tested what @kixe said and it worked...to some extent. I could get the tabs but their content (i.e. all but the first tab's) were not getting loaded until one reloaded the page. I didn't have time to investigate further so left it at that. Basically, you would need to do three things:

1. In your module's getModuleConfigInputfields method, initialise WireTabs module. It is a static method so you would need:

wire('modules')->get('JqueryWireTabs');

2. Include the JavaScript that initiates WireTabs client-side: For instance, if you had that code in your NameOfYourModule.js, you could do this in your getModuleConfigInputfields :

$dir = wire('config')->urls->ProcessModuleName;// whatever your module is called. Here we assume a process module
wire('config')->scripts->add($dir . 'ProcessModuleName.js');// or whatever file you have your JS in, e.g. config.js

The code in your .js file for your Tabs:

$(document).ready(function(){
	var $form = $("#IdOfYourForm"); 
	// remove scripts, because they've already been executed since we are manipulating the DOM below (WireTabs)
	// which would cause any scripts to get executed twice
	$form.find("script").remove();
	$form.WireTabs({
		items: $(".WireTab"),
		skipRememberTabIDs: ['ProcessModuleNameTabID'],// if you need this option
		rememberTabs: true// if you need it
	});
});

The ID of the form is the tricky bit. I am not sure if you can use your own form ID in  getModuleConfigInputfields. I tried but it was not getting recognised. If not, try using the existing form's ID which would be:  ModuleEditForm.

3. Still in getModuleConfigInputfields, build your inputs, add them to your tabs which you then add to the form. I am too lazy to type now, so please have a look at modules that use tabs...Hanna Code, Menu Builder, Batcher, etc on how to do this.

  • Like 1

Share this post


Link to post
Share on other sites

Merry Christmas to everybody. (Missing Christmas Emoticon)

The JavaScript File:

$(document).ready(function() {
    // instantiate WireTabs if defined
    $('body.hasWireTabs #ModuleEditForm').WireTabs({
        items: $("#ModuleEditForm > .Inputfields > .InputfieldWrapper"),
    });
});

The Module:

<?php
class ModuleSettingsTab extends Process implements ConfigurableModule {

    /**
     *
     * @return array
     *
     */
    public static function getModuleInfo() {

        return array(
			'title' => 'Module Settings Tabs', 
			'version' => 000, 
			'summary' => 'Provide Tabs for module settings screen'
            );
    }

     public function __construct() {
        $this->wire('config')->scripts->add(wire('config')->urls->ModuleSettingsTab.'ModuleSettingsTab.js');
     }

    /**
     * Initialize the module
     *
     */
    public function init() {
    }

    /**
     * Module configuration
     *
     */
    public function getModuleConfigInputfields(array $data) {
    
        wire('modules')->get('JqueryWireTabs');

        $inputfields = new InputfieldWrapper();    
        
        $tab = new InputfieldWrapper();
        $tab->attr('title', 'Settings');
        $tab->attr('class', 'WireTab');

        $markup = $this->modules->get('InputfieldMarkup');
        $markup->label = 'Settings';
        $markup->value = '<p>Just a placeholder for some inputfields.</p>';
        $tab->add($markup);

        $inputfields->add($tab);

        $tab = new InputfieldWrapper();
        // $tab->attr('id', 'ext_settings');
        $tab->attr('title', 'Extended Settings');
        $tab->attr('class', 'WireTab');

        $markup = $this->modules->get('InputfieldMarkup');
        $markup->label = 'Extended Settings';
        $markup->value = '<p>For very experienced developers only.</p>';
        $tab->add($markup);

        $inputfields->add($tab);

        return $inputfields;
    }
}

 

Edited by kixe
removed autoload; moved inclusion of JavaScript in constructor; modified script
  • Like 4

Share this post


Link to post
Share on other sites

Great concept - but the implementation seems to appear to mess with settings on other module's pages. When visiting the config page for any other module, I'm now getting an error in the JS console about WireTabs being undefined. 

Share this post


Link to post
Share on other sites

So maybe a setting in its own module settings to only autoload for specified/named modules? Is that even possible?

Share this post


Link to post
Share on other sites
16 minutes ago, netcarver said:

Great concept - but the implementation seems to appear to mess with settings on other module's pages. When visiting the config page for any other module, I'm now getting an error in the JS console about WireTabs being undefined. 

In some modules I am conditionally loading JS to the module config page like this:

if($this->input->get->name == $this->className) { 
    // load script 
}

 

  • Like 2

Share this post


Link to post
Share on other sites

The body class 'hasWireTabs' will only be set after a call of JqueryWireTabs. We can use it in the selector of the JavaScript. This should help.

$(document).ready(function() {
    // instantiate WireTabs if defined
    $('body.hasWireTabs #ModuleEditForm').WireTabs({
        items: $("#ModuleEditForm > .Inputfields > .InputfieldWrapper"),
    });
});

Furthermore the module should call the JavaScript and instantiate WireTabs without autoload set to true like ProcessPageEdit do or simply include the script via constructor instead of init().
I edited my post above.

  • Like 1

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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module 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) Clear the ProCache page render cache (if your site is using ProCache) 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.
      Plans for improvements
      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 CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • 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-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 ----
       
×
×
  • Create New...