Inertiajs Adapter for Flask.
Project description
Installation
$ pip install flask-inertiaConfiguration
The module needs to be initialized the usual Flask way and can be configured using app.config keys:
from flask import Flask from flask_inertia import Inertia SECRET_KEY = "secret!" # mandatory key INERTIA_TEMPLATE = "base.html" app = Flask(__name__) app.config.from_object(__name__) inertia = Inertia() inertia.init_app(app) # or inertia = Inertia(app)
The config key INERTIA_TEMPLATE must be used to set globally the template used by flask_inertia to render the server responses. This template must exists in the Flask app templates folder.
Use
For more information about InertiaJS, please read the docs provided by Inertia.
Whereas the Rails and Laravel adapters use a middleware to manage Inertia’s requests, this module doesn’t. Once it has been initiliazed it will create before_request and after_request hooks for your app to handle InertiaJS frontend requests.
Your templates
You will need to setup the root template that will be loaded on the first page visit. It will be used to load your site assets (CSS and JavaScript), and will also contain a root <div> to boot your JavaScript application in.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<title>My app</title>
<link href="{{ url_for('static', filename='/css/app.css') }}" rel="stylesheet" />
<script lang="javascript">
{{ inertia.include_router() }}
</script>
</head>
<body>
<div id="app" data-page='{{ page | tojson }}'></div>
<script src="{{ url_for('static', filename='/js/app.js') }}" defer></script>
</body>
</html>Your root div must set a HTML data-page attribute. It will be used by Flask, using a Page JSON object to communicate with Inertia.
To facilitate the route path resolving, the module provide a template context method called inertia.include_router. It will expose the Flask views resolution (like the url_for method) to your frontend Components.
This method has been extracted to django-js-routes package and works the same way via a window.reverseUrl JavaScript method ( https://github.com/ellmetha/django-js-routes#usage).
Create responses
This module provides a method render_inertia to render your frontend component through Flask responses. It will wrap your Responses and act accordingly to Inertia requests context responding a full html or a JSON reponse. It will be used instead of Flask render_template method:
from flask_inertia import render_inertia
@app.route("/test_inertia/")
def test_inertia():
"""An endpoint to test inertia integration."""
data = {
"username": "foo",
"login": "bar",
}
return render_inertia(
component_name="Index",
props=data,
)
This method take 3 arguments:
component_name: Your frontend component name (eg “Index” for an Index.vue Component for example)
props: [OPTIONAL] Data used by your component
view_data: [OPTIONAL] Data used in your template but not sent to your JavaScript components
Root template data
There are situations where you may want to access your prop data in your root Jinja2 template. These props are available via the page variable.
<meta name="author" content="{{ page['props']['username'] }}">You may want to provide data that will not be sent to your JavaScript components. You can do this using the view_data dictionnary in the render_inertia method:
return render_inertia(
component_name="Index",
props=data,
view_data={
"description": "A test page"
}
)
You can then access this variable with the template variable view_data.
<meta name="content" content="{{ view_data['description'] }}">Contributing
If you want to contribute to this project, please read the dedicated file : CONTRIBUTING.rst.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flask-inertia-0.6.tar.gz.
File metadata
- Download URL: flask-inertia-0.6.tar.gz
- Upload date:
- Size: 20.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e376532006cbab7c7a0ebc99a83ec289c6768f94218a611cd1b1c74cbf595773
|
|
| MD5 |
73562e4faa2ad7dbf331c756602b5f21
|
|
| BLAKE2b-256 |
23094e39511d55c7a9acdfa73f00e4b578944fbd67f3f85921ac8c21b4195087
|
File details
Details for the file flask_inertia-0.6-py2.py3-none-any.whl.
File metadata
- Download URL: flask_inertia-0.6-py2.py3-none-any.whl
- Upload date:
- Size: 14.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aef8db8750b3813b19390bf47bd16740e7bdf3316c77a224400a6b8b7f868758
|
|
| MD5 |
5cef04c96a332facb967d3e87fc3644d
|
|
| BLAKE2b-256 |
cf3233884b4be36b4f5613ffd232ee6e7261b38506d29f00d0cfb0f8f7f86f2b
|
