app/assets/javascripts/autofocus.js

(function(Modules) {
  "use strict";

  Modules.Autofocus = function() {
    this.start = function($component) {
      var forceFocus = $component.data('forceFocus');

      // if the page loads with a scroll position, we can't assume the item to focus onload
      // is still where users intend to start
      if (($(window).scrollTop() > 0) && !forceFocus) { return; }

      $('input, textarea, select', $component).eq(0).trigger('focus');

    };
  };

})(window.GOVUK.Modules);
Make autofocus textbox module This commit adds a very small Javascript module to autofocus a textbox on page load. It should only be used once per page. It also adds a parameter to the textbox macro which adds the attribute to trigger autofocus. 2016-02-02 16:16:29 +00:00			`(function(Modules) {`
			`"use strict";`

			`Modules.Autofocus = function() {`
Prevent autofocus when page has scrolled If users scroll a page with an autofocus component on so it is off-screen it seems safe to assume they won't want it focused if they return to it. This prevents that happening. This adds a data-attribute flag to allow this behaviour to be overridden. We have some situations where the assumption here isn't appropriate, for example on pages where the component with autofocus is in a sticky element. This means it will appear offscreen when the page loads but, when its parent becomes sticky, will be visible again. 2019-03-28 16:45:36 +00:00			`this.start = function($component) {`
			`var forceFocus = $component.data('forceFocus');`
Make autofocus textbox module This commit adds a very small Javascript module to autofocus a textbox on page load. It should only be used once per page. It also adds a parameter to the textbox macro which adds the attribute to trigger autofocus. 2016-02-02 16:16:29 +00:00
Prevent autofocus when page has scrolled If users scroll a page with an autofocus component on so it is off-screen it seems safe to assume they won't want it focused if they return to it. This prevents that happening. This adds a data-attribute flag to allow this behaviour to be overridden. We have some situations where the assumption here isn't appropriate, for example on pages where the component with autofocus is in a sticky element. This means it will appear offscreen when the page loads but, when its parent becomes sticky, will be visible again. 2019-03-28 16:45:36 +00:00			`// if the page loads with a scroll position, we can't assume the item to focus onload`
			`// is still where users intend to start`
			`if (($(window).scrollTop() > 0) && !forceFocus) { return; }`

			`$('input, textarea, select', $component).eq(0).trigger('focus');`
Make autofocus textbox module This commit adds a very small Javascript module to autofocus a textbox on page load. It should only be used once per page. It also adds a parameter to the textbox macro which adds the attribute to trigger autofocus. 2016-02-02 16:16:29 +00:00
			`};`
			`};`

			`})(window.GOVUK.Modules);`