Installation Erste Schritte
So integrierst du Insight UI in dein Projekt und nutzt alle Komponenten.
Anforderungen
Python 3.12+
Django 5.2 - 6.0
INFO:
Insight UI includes Tailwind CSS and HTMX out of the box. No additional setup required.
Installation
Installiere Insight UI mit deinem bevorzugten Paketmanager:
uv add insight-ui
Schnellstart
1
Zu INSTALLED_APPS hinzufügen
Füge insight_ui zu den Django-Einstellungen hinzu:
INSTALLED_APPS = [
# ...
'insight_ui',
# ...
]
2
Base-Template erweitern
Erweitere unser Basis Template , um alle Funktionen (Navigationsleiste, Seitenleiste, Fußzeile, Themenwechsel) zu erhalten:
{% extends "insight_ui/base.html" %}
{% load insight_tags %}
3
Konfiguration an Vorlage übergeben
Übergebe die Insight-UI-Konfiguration in die View. Alle Optionen können unter Anpassung gefunden werden.
from django.http import HttpRequest, HttpResponse
from django.shortcuts import render
from insight_ui import config
def my_view(request: HttpRequest) -> HttpResponse:
"""Render my page with Insight UI."""
context = config.get_config()
return render(request, "my_app/my_template.html", context)
4
Komponenten verwenden
Beginne damit Komponenten in deinen Templates zu verwenden:
{% extends "insight_ui/base.html" %}
{% load insight_tags %}
{% block content %}
{% alert message="It works!" type="success" dismissible=True %}
{% endblock content %}
Live-Vorschau
So sieht die Meldung aus dem obigen Beispiel aus:
Es funktioniert!