insight-ui 1.15.1

The Modern Django Component Framework with built-in Accessibility

65+ UI components designed with WCAG 2.2 AA as an accessibility target
HTMX-powered · Tailwind-based · RTL & i18n ready

Live Demo · Get Started · Components

Insight UI is a reusable Django component library that provides production-ready UI building blocks. Components are implemented as Django template tags with typed configuration dataclasses, styled with Tailwind CSS, and enhanced with HTMX for interactivity — no JavaScript framework required.

Features

• Accessibility-focused — Keyboard, focus and ARIA behavior in navigation, forms, tables and modals
• HTMX integration — Partial updates without full page reloads
• Tailwind design system — Customizable semantic tokens for fast brand alignment
• RTL & i18n ready — Right-to-left layouts and localization included
• Light & dark themes — Automatic theme switching with CSS custom properties

WCAG 2.2 AA is a design target, not a verified package-wide conformance claim. Conformance must be assessed for complete pages and processes in the consuming application. See Accessibility for scope and limitations.

Quick Start

Install the package:

uv add insight-ui

Add to your Django settings:

INSTALLED_APPS = [
    # Your apps...
    "django.contrib.staticfiles",
    "insight_ui",
]

TEMPLATES = [
    {
        # ...
        "OPTIONS": {
            "context_processors": [
                # ...
                "insight_ui.context_processors.insight_ui_context",
            ],
        },
    },
]

Use components in your templates:

{% extends "insight_ui/base.html" %}
{% load insight_tags %}

{% block title %}My application{% endblock %}

{% block content %}
    {% button label="Get started" type="primary" %}
    {% card title="Welcome" subtitle="Your first card" content="Card content goes here." %}
    {% alert type="success" message="Component rendered successfully." %}
{% endblock %}

See Getting Started for complete setup including static assets.

Documentation

The following guides describe the public package and contributor workflow on GitHub.

Full component reference and live examples at django-insight-ui.com.

Contributing

git clone https://github.com/alpininsight/insight-ui.git
cd insight-ui
uv sync --all-groups
npm ci
npm run build:static-all
uv run pytest

The devtools app provides a local playground for component development:

uv run python manage.py runserver 127.0.0.1:8000

Edit devtools/views.py for Configs and devtools/templates/devtools/playground.html for their template tags, then open http://127.0.0.1:8000/.

To scaffold a new component:

uv run python manage.py create_component --name "My Widget" --category input --no-js --dry-run

See CONTRIBUTING.md for the full workflow.

Package Scope

This repository contains the insight_ui Python package. The documentation website, component catalog, and examples are maintained in a separate repository. The local devtools playground and contributor guides stay in the Git checkout, not the wheel or sdist. Contributors need no private repository or credentials.

License

GNU Affero General Public License v3.0. For commercial licensing see COMMERCIAL_LICENSE.md.

Licensing metadata follows REUSE. Third-party notices are in NOTICE and insight_ui/THIRD_PARTY_NOTICES.md.