Customize shared template

[jonocodes]

I would like to add some javascript and css that will affect all the pages.

For now I am doing that individually on each custom template. For example:

organization_edit.html

{% extends "edit.html" %}

{% block tail %}
  <script type="text/javascript">
      $(document).ready(function() {
          $('select[multiple]').select2()
      });
  </script>
{% endblock %}

I would like to make this change either to the layout.html file to affect the whole site. Or do it in a more targeted fashion to the 'edit.html' template so all edit pages affected.

[hasansezertasan]

You can simply override base.html.

Flask Admin has some examples of doing this in the repo. Here are the four examples I could find:

• flask-admin/examples/simple at master · flask-admin/flask-admin
• flask-admin/examples/custom-layout at master · flask-admin/flask-admin
• flask-admin/examples/auth at master · flask-admin/flask-admin
• flask-admin/examples/auth-flask-login at master · flask-admin/flask-admin

I think we can add a recipe to the cookbook that demonstrates this but an examples folder could be better, WDYT @aminalaee?

[hasansezertasan]

Visiting this again, I'm down to work on some examples like in the Flask Admin repo but I want to know what @aminalaee thinks about it.

The examples folder in the Flask Admin repo did (and still does) helped me a lot when creating a project with it.

[jonocodes]

Some other ideas for implementing this feature.

1. It appears templates are now referenced to in the 'sqladmin' dir. For example:
   {% extends "sqladmin/layout.html" %}

   Going forward, if the user specifies:
   {% extends "layout.html" %}

   Then it can look for 'layout.html' in templates_dir and use that.

   I guess that roughly means any template that does not start with sqladmin/ will be looked for in templates_dir regardless of the name. For example:
   {% extends "my/great/layout.html" %}

2. Search the templates_dir for templates with the same name before looking in the sqladmin package.
   So specifying this:
   {% extends "sqladmin/layout.html" %}

   Will first look in templates_dir and use it if found. It not found, use the library template.

[hasansezertasan]

Flask Admin has a great solution for this.

Checkout these links and follow the admin_base_template and base_template parameters.

• https://github.com/flask-admin/flask-admin/blob/14e24c970f0ee3a29add830612eee9a0b0ba5dcc/flask_admin/templates/bootstrap4/admin/master.html#L1C12-L1C31
• https://github.com/flask-admin/flask-admin/blob/14e24c970f0ee3a29add830612eee9a0b0ba5dcc/flask_admin/base.py#L468

@aminalaee, what do you think about Flask Admin's solution on this? Do we need such an approach?

[hasansezertasan]

Also, the user will know what to specify because the documentation is updated accordingly and there are only two resources for the user to know how to override templates: source code and documentation.

[jonocodes]

You can simply override base.html.

Thanks @hasansezertasan . Is this a recommendation to me as a user, or is this an idea for a new feature in sqladmin.

If the first how would I "override" base.html? Some kind of package monkey patching? I'm not sure how to do that.

[aminalaee]

Feel free to document it as you think fit.

[jonocodes]

Well after all that when I went to update docs/working_with_templates.md I see that this was covered right at the top of the doc. So I just expanded it a bit:
#769

[hasansezertasan]

Oh, I take it back. That worked. Awesome!
This should be documented since its super useful.

Happy to help 👍.

[hasansezertasan]

Well after all that when I went to update docs/working_with_templates.md I see that this was covered right at the top of the doc. So I just expanded it a bit:
#769

I think the "copy and paste" approach is terrible (yep, I was the one who came up with that solution to save the day). @aminalaee would know, Flask Admin has parameters called admin_base_template and base_template to make overriding/extending process easier, I have mentioned above at #762 (reply in thread).

Check out the Flask Admin Documentation.

We need that...

[jonocodes]

Yeah, if you could extend instead of overwrite that would be great.