Jump to content
Macrura

InputfieldSimpleMDE

Recommended Posts

Basic implementation of the Simple MDE as an Inputfield.

https://simplemde.com/

Module developed in reply to request from @OrganizedFellow (https://processwire.com/talk/topic/13474-found-a-handy-js-based-markdown-editor/)

Modules Directory:

http://modules.processwire.com/modules/inputfield-simple-mde/

Github:

https://github.com/outflux3/InputfieldSimpleMDE

Editor example:

post-136-0-45492600-1465258417_thumb.png

Preview mode:

post-136-0-49079000-1465258416_thumb.png

Frontend output (using Markdown/Parsedown textformatter and Image Tags)

post-136-0-70950400-1465258415_thumb.png

Limitations etc:

This has been tested with multiple instances on 1 page and seems to work fine.

Toolbar is not configurable, but you can edit the JS file;

In the spirit of keeping this simple, there are no module settings.

If you want the spellchecker, you can enable it in the JS file.

If is seems that there is a need for configurable instances, it could be added, but so far this works fine and can't see any reason to complicate it further.

  • Like 20

Share this post


Link to post
Share on other sites

Well done. Thanks. I like the lines and words counter. :) But it shows up only if I start to edit. Same to the included spellcheck. Is there an option to disable spellcheck?

In generally I like Markdown much more than CKEditor, because its more save to prevent Layoutkilling by Customers. Great compromise between both!

Share this post


Link to post
Share on other sites

seems the init state does not show the lines/words counter - this is a documented issue with the plugin, see https://simplemde.com/

you can force it to update on load by enabling autosave;

(adding these to the init call)

autosave: {
	enabled: true,
	uniqueId: thisID,
	delay: 1000,
},
spellChecker: false

the plan is to make each instance individually configurable, but for now this is a very bare-bones implementation.

i'm going to add those options to the js init, but maybe leave them commented out, and let users uncomment to disable spellcheck, and enable autosave;

BTW - the autosave is interesting and works, not sure how useful it is or even if it makes sense in the context of a CMS.

if it were to be enabled, additional configuration would be required to change the way it works so as to have a unique id for the page and the field though.

  • Like 2

Share this post


Link to post
Share on other sites

Where do it autosave the data? I think, not into the DB-field, but into some local storage, or I'm wrong? ( Haven't looked into it, just want to ask a dump question ;-) )

Share this post


Link to post
Share on other sites

yes - it autosaves it in local storage, which is why the module init would need to ID each field with it's page id and instance id... so by default the autosave is off (and probably not necessary)...

  • Like 1

Share this post


Link to post
Share on other sites

The module should show up in the directory in a few days. In the meantime, some small fixes and optimizations were made, such as fixed height editor window, and testing on both admin themes. At this time, the fullscreen, side-by-side editing only seems to work on the default theme; in Reno the editor goes behind the left menubar. If anyone has a quick CSS fix for this feel free to post, else i'll have a look at some point when i need to use that mode on reno

Share this post


Link to post
Share on other sites

I tried out the module in a website I'm just getting ready locally. When editing a blog entry, I noticed that SimpleMDE would always truncate my text. 

The article had ~1400 words, with about 12000 characters. After saving I ended up with < 1200 words. 

 

Share this post


Link to post
Share on other sites

ok sorry about that limitation; so far i haven't noticed any limitations in terms of length of content, and i have some really long paginated articles. Will have to see if i do in fact have anything longer and 1200 words

Share this post


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

ok sorry about that limitation; so far i haven't noticed any limitations in terms of length of content, and i have some really long paginated articles. Will have to see if i do in fact have anything longer and 1200 words

Hi,

The issue has resolved itself by now. It is actually a limitation of the textarea field in PW 2.7.

Sorry for the hassle ^^°

Share this post


Link to post
Share on other sites

I just wrote this as a comment on the Module itself, but two issues I've found with this (otherwise perfect and awesome) Module:

 

1. SimpleMDE has been updated from 1.10.1 to 1.11.2

2. If a textarea field in the admin is using InputfieldSimpleMDE, but is closed upon load, or on a separate content tab created with `FieldsetTabOpen`, its value is blank. I've been trying to debug why all morning, but it's over my head.

Share this post


Link to post
Share on other sites

thanks @ethfun for the report, i will update the core SimpleMDE stuff to latest. In terms of the init for closed and tabs, i will check it out and post back here.

  • Like 1

Share this post


Link to post
Share on other sites

are you sure the value is blank? Mine works on the closed field, you just can't see the content until you click into the field; The field is still initialized when you open it; not sure if the fact that you can't see the content in the field is due to some initialization issue, or is something specific to how this component works.

I'm not sure this can be fixed, so for now i think your options are to either tell the editors to click into the field to see the content, or don't use collapsed fields.

In some future iteration of this module, the eventual aim is to have it operate more like CK editor, so that the config takes place from the admin, and each instance can be individually configured; also support for some sort of image input. But i think it will take a while till it reaches that stage, and also would depend on demand...

  • Like 3

Share this post


Link to post
Share on other sites

Sorry - your explanation of the problem is more accurate. The value of the field definitely exists, it's just not visible until the field is given focus.

My idea for how to fix this was something like `imagesLoaded()` for Masonry layouts. I was going to see if there was a way to "retrigger" the SimpleMDE field after a tab was opened. I just didn't know if opening a tab triggers a Javascript event. If it does, I think that would fix this problem.

 

Share this post


Link to post
Share on other sites

@ethfun - cool yeah I tried to work on that yesterday, but didn't get far.

Though I did move the init function into a variable so it can be called from any event now;
also the new version updated the core css and js;

Share this post


Link to post
Share on other sites

@Macrura I fixed it!

See the code attached.

var initSimpleMDE = function() {
	var thisID = $(this).attr('id');
    var visible = $(this).is(":visible");

    if(visible) {
        var simplemde = new SimpleMDE({
            element: document.getElementById(thisID),
            toolbar: ["bold", "italic", "heading", "|",
                      "quote", "unordered-list", "ordered-list", "|",
                      "link", "image", "|",
                      "preview", "side-by-side", "fullscreen", "|",
                      "table", "horizontal-rule", "code", "|",
                      "guide"
                      ],
            spellChecker: false,
            promptURLs: true,
            // forceSync: true,
        });
    }
}

$(window).load(function(){
	$('.InputfieldSimpleMDEField').each(initSimpleMDE);
});

// Fix for things hidden on pageload, by @Ethan Beyer
$(document).on('wiretabclick', function() {
    $('.InputfieldSimpleMDEField').each(initSimpleMDE);
});

 

Share this post


Link to post
Share on other sites

"wiretabclick" fires on each tab click so I would suggest to add a data-attribute to the SimpeMDE field and check for its existence before calling initSimpleMDE (eg. add "data-loaded").

Share this post


Link to post
Share on other sites

The biggest reason I made sure to include "wiretabclick" was because I have multiple tabs with different SimpleMDE fields on them - they all showed up blank when clicking on their tab until you clicked in the SimpleMDE field itself. This was the only way I could get the values to show up on tabs.

Share this post


Link to post
Share on other sites

I see, but there's no sense initializing the same SimpleMDE field several times (clicking on tabs back and forth). I would add a "data-mce-loaded" attribute on first load and return from the initSimpleMDE() function on second (and consequent) runs if this tag exists on the field in question.

  • Like 2

Share this post


Link to post
Share on other sites

yep - ok thanks for checking that - will have this all in the module asap. @tpr thanks for the advice, yes, will add the the data attribute so it doesn't keep initing

  • Like 1

Share this post


Link to post
Share on other sites

actually looks like this is related to Codemirror refresh, so the fix is all about being able to call the refresh() method on the codemirror instance based on a js event, such as the wiretab click, or the inputfield collapsed. Other option which is out there is to have an interval refresh running on the page, which is an addon for codemirror which helps in situations where you have a lot of instances where the codemirror does not init; @ethfun your fix doesn't work actually because then any non-visible fields on the content tab (like if they are collapsed) don't get initialized till you click a tab... to be continued

Share this post


Link to post
Share on other sites

I've done some more digging. The field with SimpleMDE definitely needs to be refreshed, but it is possible to just "init" that field if we hook into the correct triggered events.

I've tested this with Textarea fields using SimpleMDE as their Inputfield:

  • If the field is closed;
  • or if the field is within a Fieldset that is closed;
  • or if the field is on a tab that is not visible on page load...

The following code fixes all of those cases:

/**
 * Init for Processwire
 * These items could be added if fullscreen or sidebyside would work on PW
 * Note that fullscreen mode is not working right on Reno theme
 */
var initSimpleMDE = function() {
    var thisID = $(this).attr('id');
    var visible = $(this).is(":visible");

    if(visible && $(this).data('simplemde-made') !== 'true') {
        $(this).attr('data-simpleMDE-made', 'true');
        // console.log($(this).data());
        var simplemde = new SimpleMDE({
            element: document.getElementById(thisID),
            toolbar: ["bold", "italic", "heading", "|",
                      "quote", "unordered-list", "ordered-list", "|",
                      "link", "image", "|",
                      "preview", "side-by-side", "fullscreen", "|",
                      "table", "horizontal-rule", "code", "|",
                      "guide"
                      ],
            spellChecker: false,
            promptURLs: true,
            // forceSync: true,
        });
    }
}

/**
 * Init the field on page load
 */
$(window).load(function(){
    $('.InputfieldSimpleMDEField').each(initSimpleMDE);
});

/**
 * Re-init for fields that are now visible due to:
 *     - opening a tab with a hidden field, making it visible
 *     - opening an accordion with a hidden field, making it visible
 *     - opening a field that was closed
 */
$(document).on('wiretabclick reloaded opened', function() {
    // console.log("got here");
    $('.InputfieldSimpleMDEField').each(initSimpleMDE);
});

 

  • Like 2

Share this post


Link to post
Share on other sites

wow super awesome, i will get this into the new version asap

  • Like 2

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 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/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...