app/templates/components/ajax-block.html

{% macro ajax_block(partials, url, key, interval=2, finished=False, form='') %}
  {% if not finished %}
    <div
      data-module="update-content"
      data-resource="{{ url }}"
      data-key="{{ key }}"
      data-interval-seconds="{{ interval }}"
      data-form="{{ form }}"
      aria-live="polite"
    >
  {% endif %}
    {{ partials[key]|safe }}
  {% if not finished %}
    </div>
  {% endif %}
{% endmacro %}
Make AJAX requests on activity page POST not GET See parent commit for the reason we’re doing this. Currently our AJAX requests only work as `GET` requests. So this commit does a bit of work to make them work as `POST` requests. This is optional behaviour, and will only happen when the element in the page that should be updated with AJAX has the `data-form` attribute set. It will take the form that has the corresponding `id`, serialise it, and use that data as the body of the post request. If not form is specified it will not do the serialisation, and submit as a `GET` request as before. 2017-06-13 11:20:41 +01:00			`{% macro ajax_block(partials, url, key, interval=2, finished=False, form='') %}`
Make a macro for the AJAX update module This is less repetitive than typing out the HTML with all its attributes every time. It also lets us wrap up the idea of ‘finished’ as a parameter, so the AJAX code will only be initiated when it’s needed, eg if a job is still processing. 2016-06-28 09:21:46 +01:00			`{% if not finished %}`
			`<div`
			`data-module="update-content"`
			`data-resource="{{ url }}"`
			`data-key="{{ key }}"`
			`data-interval-seconds="{{ interval }}"`
Make AJAX requests on activity page POST not GET See parent commit for the reason we’re doing this. Currently our AJAX requests only work as `GET` requests. So this commit does a bit of work to make them work as `POST` requests. This is optional behaviour, and will only happen when the element in the page that should be updated with AJAX has the `data-form` attribute set. It will take the form that has the corresponding `id`, serialise it, and use that data as the body of the post request. If not form is specified it will not do the serialisation, and submit as a `GET` request as before. 2017-06-13 11:20:41 +01:00			`data-form="{{ form }}"`
Make a macro for the AJAX update module This is less repetitive than typing out the HTML with all its attributes every time. It also lets us wrap up the idea of ‘finished’ as a parameter, so the AJAX code will only be initiated when it’s needed, eg if a job is still processing. 2016-06-28 09:21:46 +01:00			`aria-live="polite"`
			`>`
			`{% endif %}`
Derive markup dashboard from rendered partials This commit extends the `ajax_block` component to take a `dict` of partials, from which it can select the partial matching its `key` argument and print its HTML to the page. This means that the same markup is only rendered in one place, rather than in two (individually in the JSON endpoint and as `include`s in the parent template). 2016-06-28 11:23:43 +01:00			`{{ partials[key]\|safe }}`
Make a macro for the AJAX update module This is less repetitive than typing out the HTML with all its attributes every time. It also lets us wrap up the idea of ‘finished’ as a parameter, so the AJAX code will only be initiated when it’s needed, eg if a job is still processing. 2016-06-28 09:21:46 +01:00			`{% if not finished %}`
			`</div>`
			`{% endif %}`
			`{% endmacro %}`