Skip to content

Latest commit

 

History

History

README.md

Form Block Text Field Max Length

Synopsis

Limit the number of characters allowed in some form block fields.

Version

  • 0.5.0

SS Versions

  • 7.1

  • 7.0

v7.1 Fluid Engine Compatible

  • Yes

Dependencies


Install

  • Install Form Block Form Element Add Watch. After you install the code be sure to continue on with the rest of the steps.

  • Options

    • CDN Hosted

      Use this option for the quickest way to install this effect (files hosted externally on the jsDelivr, a CDN)

      • Options

        • Page Specific

          Use this option if you want to have this effect on only one Page.

          • Add the following code to Page Settings > Advanced > Page Header Code Injection for the Page.

            <!-- begin TWC Form Block Text Field Max Length -->
            
              <!-- License < https://github.com/tomsWebConsulting/twcsl/blob/main/LICENSE.txt#L1 > -->
              
              <script src="https://cdn.jsdelivr.net/gh/tomsWebConsulting/twcsl@0c145aacb42a3e067ecc60e18f756a01df9ea2a8/Block/Form/Form%20Block%20Text%20Field%20Max%20Length/form%20block%20text%20field%20max%20length.min.js" type="module"></script>
              
              <!-- end TWC Form Block Text Field Max Length -->
              
          • Refer to per-page code injection for details.

        • Site-wide

          Use this option if you want to have this effect on all Pages.

          • v7.1

            • Add the following code to Website > Pages > Custom Code > Code Injection > FOOTER.

              <!-- begin TWC Form Block Text Field Max Length -->
              
                <!-- License < https://github.com/tomsWebConsulting/twcsl/blob/main/LICENSE.txt#L1 > -->
                
                <script src="https://cdn.jsdelivr.net/gh/tomsWebConsulting/twcsl@0c145aacb42a3e067ecc60e18f756a01df9ea2a8/Block/Form/Form%20Block%20Text%20Field%20Max%20Length/form%20block%20text%20field%20max%20length.min.js" type="module"></script>
                
                <!-- end TWC Form Block Text Field Max Length -->
                
          • v7.0

            • Add the following code to Website > Pages > Website Tools > Custom Code > Code Injection > FOOTER.

              <!-- begin TWC Form Block Text Field Max Length -->
              
                <!-- License < https://github.com/tomsWebConsulting/twcsl/blob/main/LICENSE.txt#L1 > -->
                
                <script src="https://cdn.jsdelivr.net/gh/tomsWebConsulting/twcsl@0c145aacb42a3e067ecc60e18f756a01df9ea2a8/Block/Form/Form%20Block%20Text%20Field%20Max%20Length/form%20block%20text%20field%20max%20length.min.js" type="module"></script>
                
                <!-- end TWC Form Block Text Field Max Length -->
                
          • Refer to Add code to code injection for details.

    • On-site

      Use this option to install the full code of this effect (files hosted on your site).

How To Use

  • Add or edit a form block on your Page and set up as desired.

  • In the Form Block Form Element Add Watch code add the callback name twcFbtfml to added per the Form Block Form Element Add Watch code install steps.

  • For each text or text area field where you want a max character limit do the following.

    • Edit the field.

    • At the beginning of the description field enter twc-fbtfml : [ enter max length number here replacing square brackets ]. An example.

      twc-fbtfml : 10
      

      If you want to have description text for the field that the user will see enter it after the twc-fbtfml tag. An example.

      twc-fbtfml : 10
      My description text that helps the user.
      

Note

This code is client side and making use of an HTML form feature. Since this code is client side it is possible to bypass the max length limit this code is setting. In other words you still need to be checking manually when forms or orders come in to make sure your limits are not being exceeded. Consider this code more of an aid to help users not exceed your field max length limits.

Demo

You can see a demo of this effect here.

Make a Donation

Please consider making a donation.

Changes

  • 2025-02-13

    • updated to work with Form Block Form Element Add Watch v0.5.0
    • bumped version to 0.5.0
  • 2025-03-01

    • restructure how user callbacks are added
    • code is active in Preview
    • remove jQuery dependency
    • bumped version to 0.4.0
  • 2024-04-27

    • restructured the code
    • fix for user callbacks not running
    • bumped version to 0.3.0
  • 2023-10-09

    • remove some guard checks that prevented some nodes being passed to callbacks
    • bumped version to 0.2.1
  • 2023-07-28

    • support calling multiple callbacks
    • bumped version to 0.2.0
  • 2023-07-14

    • initial version