Jump to content

Fredi - friendly frontend editing


Recommended Posts

@apeisa This module is fantastic!!  It makes editing so much easier.  Thank you.

I've been playing around with the various configuration options and have come across a problem, possibly because of the way my site is built.  I can get fredi working on pages that call in a header and footer but can't get it to work on my content blocks.  

For setup I have a page with header and footer that pulls in children as content blocks like so:

<?php foreach($page->children as $child) echo $child->render(); ?> 

I tried targeting the child pages using $pages->get in the template file but it doesn't seem to work.  I'm not sure if this is because the blocks have no header and footer or if it's because fredi can't find them.  

Is it possible to use fredi in this way or maybe to target the block template itself?

Link to comment
Share on other sites

@photoman I'm not sure if this is what you want, but here goes:


foreach($page->children as $child) {
    echo $fredi->render("all|the|fields|you|want", $child);
    echo $child->render();

  • Like 1
Link to comment
Share on other sites

Thanks diogo.  I tried your solution but I still can't get it to work.  When I add your code to the parent template file and view the result the page renders fine but there are no fredi links.  Here's the code I entered.

foreach($page->children as $child) {
    echo $fredi->render("body", $child);
    echo $child->render();

What I'd expect to happen is all the children that have a body field would be rendered with an edit link.  I tried various multiple field combinations but no joy.  I'm not quite sure why it's not working.  

For simplicity sake let's say one of the child templates was just this:

<div class="span4">

What's the best way to work with fredi using the example above.  Does it need to be called from the parent page template or can it be initialised in the child template itself?

Link to comment
Share on other sites

$fredi should work from both, but it might be you need to load $fredi again ($fredi = $modules->get("Fredi")) in your child template.

$fredi = $modules->get("Fredi");
foreach($page->children as $child) {
    echo $fredi->render("body", $child);
    echo $child->render();

Code snippet above doesn't show edit links even for superuser? How about changing it to $fredi->body($child)?

  • Like 1
Link to comment
Share on other sites

Aha! That did it.  In the end I didn't need to write the code as above, all that's required is $fredi at the head of the child template like so:

<?php $fredi = $modules->get("Fredi");?>

Then just call as normal using 


Many thanks for your help apesia and for writing such a cool module  :)  

Link to comment
Share on other sites

@apesia I've been happily playing around with Fredi and have a small suggestion.  The echo $fredi->renderScript(); call is only required when the user is logged in but at the moment it's printed in the header regardless of whether the user is logged in or not.  

I know this won't have a massive impact on page load speed but it adds another 2 http requests which aren't really necessary.  Just a thought.

On a slightly different note I noticed that the admin field column widths are not reflected on the front end.  I'm not sure if this was on purpose to keep things responsive?

Here's what's missing:

class="InputfieldColumnWidth InputfieldColumnWidthFirst"   (These styles are in UI.css)

and also the inline style that defines the width in the backend eg "width:20%".    

Link to comment
Share on other sites

You can add some checking whether to load script & css yourself. I don't want to add that check there since that method is just a shortcut anyway.

There is some discussion about column widths earlier in this topic. In short: yes, they are intentionally left out just because ideally just few fields are used and original widths probably don't work in that case.

Oh, and thanks trying Fredi and thanks for your feedback! Highly appreciated.

Link to comment
Share on other sites

Thanks apeisa I didn't think of that.  For anyone else who's interested just add this to your header instead of the usual call.  Nice and simple. 

<?php $fredi = $modules->get("Fredi");
   if ($user->isLoggedin()) {
   echo $fredi->renderScript();

Totally understand your reasons for making the column widths 100% as the original concept was about editing on a field by field basis.  My sites are built in blocks and I find myself grouping fields on a block by block basis as it's quicker for the client to edit and means I can output less edit links.  

It would be great to have the markup available to target with css even if it's not used in your default css file but either way I'm very happy.  So good to have fredi.

  • Like 1
Link to comment
Share on other sites

  • 2 weeks later...

I found pretty rare bug from Fredi and I couldn't think of clear fix for it: https://github.com/apeisa/Fredi/issues/4


Page fields doesn't work, if custom php code used to find selectable pages

Problem seems to be with $page variable - it somehow doesn't respect it, it believes the $page is the modal Fredi Edit Process page instead of the context page.

How to replicate: edit page field and open "input" tab. Open "Custom PHP code to find selectable pages" and add something that uses $page. Like "return $page->parent->children;"

Now when you edit that field through Fredi you get totally different results than you would expect.

To be honest I don't have a clue why $page works when using normal ProcessPageEdit but not when using FrediProcess. Any help?

Link to comment
Share on other sites

Ah, I finally found it. This is why custom selector stuff fails on FrediProcess: https://github.com/ryancramerdesign/ProcessWire/blob/master/wire/modules/Inputfield/InputfieldPage/InputfieldPage.module#L141

I think cleanest option would be if getSelectablePages() method would be hookable. Any hopes to get three underscores there Ryan?

  • Like 2
Link to comment
Share on other sites

I have new version coming that introduces ability to create new pages. I would be extremely happy to get some feedback about the methods and arguments I am planning. Currently it works like this:

$fredi->newPage("templatename", "title|summary|body");


$fredi->newPage("templatename", "title|summary|body", $parentPage);

That would open new modal with title, summary and body fields. By default it creates new pages under the current page, but you can define alternative parent page there also.

I have also created ability to set fieldWidths, just add =XX to fieldname and it gives the width. Those can be used both in edit and new page modals. Like this:


I want to take this further: defining required fields and also for new pages prevalues and possible hidden fields. This means that simple string based fields definition doesn't fly that far, or it needs some super nice syntax. Ideas?

  • Like 6
Link to comment
Share on other sites

Hi apeisa,

Fredi is fantastic! Thanks for sharing this. I've been using it with Chrome. I can't seem to get it to display the form in Safari though...(v6.0.4 on OS X).  

The modal shows up, and expands to the right size, but no form shows up - just the spinner. The form is there in the source code (within the iframe), but it isn't displayed. Maybe it could it be the z-index or maybe a source-order issue with the modal?

Thanks again!

Edit: forgot to mention - no javascript errors appear in the console

Link to comment
Share on other sites

  • 2 weeks later...

I've come across an error which is stopping fredi working with images in repeater fields.  I'm not quite sure why it's happening but this seems to be on all my templates with repeaters that contain image upload fields.

As an example I have a carousel as a repeater (code below).  If the carousel is filled with images from the backend it works perfectly.  When I try to fill it with images using fredi on the frontend the edit modal pops up as expected and the "choose file" button for the field brings up my file explorer.  When I choose an image you can see that the image is trying to load but nothing happens.  

The strange thing is this only happens with images.  I have other repeaters that contain both images and text and the text can be edited with fredi, just not the images.

Is this a bug or do you have any suggestions to fix the error?

Here's an example of my setup:

Call fredi at the top of the template:

<?php $fredi = $modules->get("Fredi");?> 

Example of an image repeater I'm using:

    foreach($page->sliders as $k => $slider) {		
    $active = ($k == 0) ? " active" : "";		
    $image = $slider->image_single->size(660,220);
    echo  "<div class='item {$active}'>
    <img class='photo' src='{$image->url}' alt='{$image->description}' />

Call the fredi edit link at the bottom of the template:

<?php echo $fredi->render("sliders");?> 
Link to comment
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.

      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

  • Create New...