gpi_field_refreshed (JS)

  1. Description
  2. Usage
  3. Parameters
  4. Example
    1. Move inventory available message into HTML field after field is refreshed
  5. Since

Description

Action fired after a field with inventory dependent on a property is refreshed.

Usage

gform.addAction( 'gpi_field_refreshed', 'my_custom_function' );

Parameters

  • $targetField JQuery

    Field with inventory that was refreshed.

  • $triggerField JQuery

    Property field that caused the field with inventory to be refreshed.

  • initialLoad boolean

    Whether the field was refreshed on the initial load of the form.

Example

Move inventory available message into HTML field after field is refreshed

window.gform.addAction('gpi_field_refreshed', function ($targetField, $triggerField) {
    // Customize selector below
    var $htmlField = jQuery('#field_3_3');

    if (!$htmlField.length) {
        return;
    }

    var targetFieldId = $targetField.prop('id');

    // Clear out existing inventory message for the current $targetField
    $htmlField.find('.gpi-available-inventory-message[data-field-id="' + targetFieldId + '"]').remove();

    // Move target field inventory message into HTML field.
    $targetField
        .find('.gpi-available-inventory-message').attr('data-field-id', targetFieldId)
        .appendTo($htmlField);
});

Since

This filter is available since Gravity Forms Inventory 1.0-beta-1.3.