Jump to content

Module(tte): InputfieldURLChecker


Recommended Posts

InputfieldURLChecker

This is a tiny module to add a URL check button to InputfieldURL. It's live, meaning that it opens what you just typed in, and visible only if the field is non-empty. It's as unobtrusive as can :)

Modules directory

GitHub

It would be the best if something similar would be built-in to PW.

post-3156-0-39566700-1445099748_thumb.gi

There will be probably some tweaks and settings in the future. Suggestions welcome (even for module name).

Edited by tpr
  • Like 10
Link to post
Share on other sites

v0.7 is ready. Download link in the first post.

Configuration

post-3156-0-44779500-1445162194_thumb.pn

Changelog

  • fixed link height when URL field is under admin tab (works with ajax-loaded tabs)
  • fixed link height when first tab didn't have any URL field
  • namespaced JS
  • new option: ctrl+shift+click and ctrl+shift+enter modes
  • new option: force http prefix
  • new option: limit module to list of enabled fields

What I plan to add in the future is opening links in a lightbox, and perhaps allowing all 3 modes to be used at the same time. But I think I'll do these only if there's a demand.

  • Like 2
Link to post
Share on other sites

It's still a modulette compared to other heavyweight modules :)

The first post contains the link to the GitHub page (v0.8). There was a small code optimization but otherwise it's the same as v0.7.

  • Like 1
Link to post
Share on other sites

Hi,

a very useful Modul(ette). :)

Primarily, it is not the "amount" of code what tells about the "weight" of a module. :lol:

------

BTW, when having a look at Github, I spotted DIRECTORY_SEPARATOR in URLs for script and style loading. Shouldn't it be a simple / (slash) instead?

  • Like 1
Link to post
Share on other sites

Thanks! DIRECTORY_SEPARATOR was indeed unnecessary, I guess it was a victim of a copy-paste operation :)

Unfortunately there were other bugs to fix. Just realized there are ajax-loaded FIELDS too and not only tabs. Now these are covered too (v0.85).

Positioning of the links was improved too, and fixed the issue when the field had description or notes.

Later I'll add enabled_templates function to make it more versatile, plus make field value clickable if the field is set to "closed + locked".

If I knew there are so many field options to take into account I probably won't start this module :)

  • Like 2
Link to post
Share on other sites

I was about to ask help here but finally solved things on my own (and looking into other modules).

v0.92 allows using the module on all admin pages. So far it was only added to pages where ProcessPageEdit could hook to, so for example now it is available on other modules's settings pages, or the new module install screen:

InputfieldURLChecker.gif

New (default) option was added: button-left - this is handier because the button is not on the far-right end of the input.

Also the appearance was changed a bit: colored arrow appears only on hover, otherwise remains gray. The button itself is visible all the time, even if the field is empty.

The height of the button was also fixed by adding a dummy url field on start, just to measure its height (and then it's removed). Other measurements were unfortunately buggy.

I'm still looking for a better module name, though I kinda like the abbreviation "TUF", which is used heavily in the JS for naming.

Locked fields got an underline on hover, just to make them more usable.

  • Like 2
Link to post
Share on other sites

Okay, settled with "InputfieldURLChecker" as the module name as I found no better one.

In the last few days the module got some major updates:

  • allow button and hotkey modes to be used together
  • asmSelect fields for enabled fields/templates
  • add "placeholder" to asmSelect fields
  • make strings translatable (with __FILE__ textdomain)
  • JS optimizations/fixes

Check the github repo for the details - the options page screenshot shows most of them.

  • Like 4
Link to post
Share on other sites

I'm experimenting with loading the URL in an iframe, sliding in from the right side of the browser window. It works in most cases but fails if the target site's X-Frame-Options is set to SAMEORIGIN, like here on this forum. Unfortunately this is something that cannot be check on the client side. However, I will keep this feature with a note in the readme.

post-3156-0-85631800-1445866999_thumb.gi

Link to post
Share on other sites
  • 4 weeks later...

I'm not having any luck getting this to work... no arrow is shown;

I'm on Mac, Firefox, Chrome, but no luck;

templates and fields all setup....

no js errors..

Any idea what might be the cause, or how to troubleshoot?

TIA

Link to post
Share on other sites

I just installed from the module directory (entered the classname "InputfieldURLChecker") and worked fine.

I'm on Win but I don't think that could be an issue. What FF/Chrome versions are you using?

I guess you tried it on az URL type field and not on a regular InputfieldText.

In the module settings, have you added anything to the "Enabled templates" and "Enabled fields" area? If so, the module will be active only in those templates/fields, and unavailable elsewhere.

Also make sure the Mode is set to "Button" and not hotkey.

On the admin page where you expect the button to appear, check the page source if it contains "IUC"  within a script tag in the head.

Link to post
Share on other sites

hey tpr - thanks and also let me thank you for this module, it looks great, and you have put a lot of work into it - it will be really handy for this project i'm working on where we need to check that links to external sites are working/correct!

So i checked everything and troubleshot it to where i have narrowed down the issue to the field restriction - if that is set, then it doesn't work; setting the template restriction works... being that i don't really need to restrict by field, i'm all good, but i can further assist with this issue if you need more info.

thanks again!

  • Like 1
Link to post
Share on other sites

I will rewrite half of the module to take advantage of InputfieldUrl::render, which would make things simpler. Now JavaScript makes all the heavyweight stuff which works, but it's too clunky here and there.

  • Like 1
Link to post
Share on other sites

Just committed v1.1.0 to the dev branch at GitHub:

https://github.com/rolandtoth/InputfieldURLChecker/tree/dev

This is 99% the same in functionality but under the hood it uses InputfieldURL::render and InputfieldURL::renderValue.

The only new feature is that locked field urls now respect the module setting "Target", so clicking on them may open in an iframe if setting so.

Locked url fields with description or notes was linkified incorrectly in the previous (JS-only) version, as all the field contents were wrapped in a link, not only the url. Now it's handled beautifully with the renderValue hook.

Using backend hooks made it much simpler and reliable to deal with template/field restrictions, and probably there will be more benefits in further developments.

  • Like 4
Link to post
Share on other sites
  • 8 months later...

Is there a way to specify array in field name? I have this in getDefaultData:

static public function getDefaultData() {
        return array(
            'InputfieldURLChecker'         => array(
                'IUC_mode'              => array(
                    'button'
                ),
                'IUC_button_position'   => 'button-left',
                'IUC_target'            => 'new-window',
                'IUC_force_http'        => 1,
                'IUC_enabled_templates' => array(),
                'IUC_enabled_fields'    => array()
            )
	)
}

Now if I make a  field and set its name to 'IUC_mode' and save the module, the $data in getModuleConfigInputfields($data) will NOT have 'IUC_mode' under 'InputfieldURLChecker' (but a flat array).

I have tried this, but no joy:

$f = wire('modules')->get('InputfieldCheckboxes');
$f->name = 'InputfieldURLChecker["IUC_mode"]';
...

 

Link to post
Share on other sites
  • 2 years later...

Hi @tpr.

Thanks for the module.

I have spent some time to understand why the module doesn't work and the issue is that only ProcessPageEdit and ProcessProfile processes are allowed.

But I have several process modules that handle page edit of custom page types.  It would be great if we could control this option in the module config.

There is $modules->findByPrefix("), so maybe you can provide such options with ASM select by $modules->findByPrefix("Process");

Thanks. 

Link to post
Share on other sites

Thanks. Are you using AdminOnSteroids? Because this module is not updated for a while since I added it to AOS.

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 FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • 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/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
×
×
  • Create New...