Skip to main content

material-ui for fasthtml

Project description

fh-matui

What is fh-matui?

fh-matui is a Python library that brings Google’s Material Design to FastHTML applications. It provides a comprehensive set of pre-built UI components that integrate seamlessly with FastHTML’s hypermedia-driven architecture.

Built on top of BeerCSS (a lightweight Material Design 3 CSS framework), fh-matui enables you to create modern, responsive web interfaces entirely in Python — no JavaScript required.

✨ Key Features

Feature Description
🎨 Material Design 3 Modern, beautiful components following Google’s latest design language
Zero JavaScript Build interactive UIs entirely in Python with FastHTML
📱 Responsive Mobile-first design with automatic breakpoint handling
🌙 Dark Mode Built-in light/dark theme support with 20+ color schemes
🧩 Composable Chainable styling APIs inspired by MonsterUI
📊 Data Tables Full-featured tables with pagination, search, sorting, and CRUD
🔧 nbdev-powered Literate programming with documentation built from notebooks

🏗️ Architecture

┌─────────────────────────────────────────────────────────────┐
│                        fh-matui                              │
├─────────────────────────────────────────────────────────────┤
│  Foundations     │  Core styling utilities, helpers, enums  │
│  Core            │  Theme system, MatTheme color presets    │
│  Components      │  Buttons, Cards, Modals, Forms, Tables   │
│  App Pages       │  Full-page layouts, navigation patterns  │
│  Data Tables     │  DataTable, DataTableResource for CRUD   │
│  Web Pages       │  Landing pages, marketing components     │
├─────────────────────────────────────────────────────────────┤
│  BeerCSS         │  Material Design 3 CSS framework         │
│  FastHTML        │  Python hypermedia web framework         │
└─────────────────────────────────────────────────────────────┘

🎨 Available Themes

fh-matui includes 15+ pre-configured Material Design 3 color themes:

Theme Preview Theme Preview
MatTheme.red 🔴 MatTheme.pink 🩷
MatTheme.purple 🟣 MatTheme.deepPurple 💜
MatTheme.indigo 🔵 MatTheme.blue 💙
MatTheme.lightBlue 🩵 MatTheme.cyan 🌊
MatTheme.teal 🩶 MatTheme.green 💚
MatTheme.lightGreen 🍀 MatTheme.lime 💛
MatTheme.yellow 🌟 MatTheme.amber 🧡
MatTheme.orange 🟠 MatTheme.deepOrange 🔶

Usage:

# Choose your theme
app, rt = fast_app(hdrs=[MatTheme.deepPurple.headers()])

🚀 Quick Start

Here’s a minimal example to get you started:

from fasthtml.common import *
from fh_matui.core import MatTheme
from fh_matui.components import Button, Card, FormField

# Create a themed FastHTML app
app, rt = fast_app(hdrs=[MatTheme.indigo.headers()])

@rt('/')
def home():
    return Div(
        Card(
            H3("Welcome to fh-matui!"),
            P("Build beautiful Material Design apps with Python."),
            FormField("email", label="Email", type="email"),
            Button("Get Started", cls="primary"),
        ),
        cls="padding"
    )

serve()

📦 Installation

pip install fh-matui

Dependencies

fh-matui automatically includes: - python-fasthtml - The core FastHTML framework - BeerCSS - Loaded via CDN for Material Design 3 styling

What This Code Does

  1. MatTheme.indigo.headers() - Loads BeerCSS with the indigo color scheme
  2. Card - Creates a Material Design card component with elevation
  3. FormField - Generates a styled input with floating label
  4. Button - Renders a Material Design button with ripple effects

📚 Module Reference

Module Description Key Components
Foundations Base utilities and helper functions BeerHeaders, display, styling helpers
Core Theme system and styling MatTheme, color presets, theme configuration
Components UI component library Button, Card, FormField, FormModal, Grid
App Pages Application layouts Navigation, sidebars, full-page layouts
Data Tables Data management components DataTable, DataTableResource, CRUD operations
Web Pages Marketing/landing pages Hero sections, feature grids, testimonials

🛠️ Development

Install in Development Mode

# Clone the repository
git clone https://github.com/user/fh-matui.git
cd fh-matui

# Install in editable mode
pip install -e .

# Make changes under nbs/ directory, then compile
nbdev_prepare

🤝 Why fh-matui?

Challenge fh-matui Solution
CSS complexity Pre-built Material Design 3 components via BeerCSS
JavaScript fatigue FastHTML handles interactivity declaratively
Component consistency Unified API across all components
Dark mode support Built-in with automatic system preference detection
Responsive design Mobile-first grid system and responsive utilities
Form handling FormField, FormGrid, FormModal for rapid form building
Data management DataTable and DataTableResource for CRUD operations

🤖 For LLM Users

fh-matui includes comprehensive documentation bundles for Large Language Models, enabling AI assistants (like Claude, ChatGPT, or GitHub Copilot) to help you build FastHTML apps with complete knowledge of the component APIs.

📥 Download Context File

📄 llms-ctx.txt — Complete API documentation in LLM-optimized format

💡 How to Use

  1. Download the context file from the link above
  2. Attach it to your LLM conversation (drag & drop or paste contents)
  3. Ask for implementation using natural language

Example Prompt:

I'm using fh-matui (context attached). Create a dashboard with:
- A sidebar navigation with 5 menu items
- A DataTable showing products with pagination
- A modal form to add/edit products
- Use the deep purple theme

The LLM will generate production-ready FastHTML code using the exact component APIs from the documentation.

🔄 Staying Up to Date

The llms-ctx.txt file is automatically regenerated with each release to ensure it stays synchronized with the latest API changes. Always download the version matching your installed package version for the most accurate results.

📌 Note: The context file is generated from the same literate programming notebooks that build the library itself, ensuring 100% accuracy with the actual implementation.

📄 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.


Built with ❤️ using FastHTML and nbdev

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fh_matui-0.9.16.tar.gz (57.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fh_matui-0.9.16-py3-none-any.whl (55.3 kB view details)

Uploaded Python 3

File details

Details for the file fh_matui-0.9.16.tar.gz.

File metadata

  • Download URL: fh_matui-0.9.16.tar.gz
  • Upload date:
  • Size: 57.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for fh_matui-0.9.16.tar.gz
Algorithm Hash digest
SHA256 63b04fd6a65aa6516fb7073689eee87ddb9b9a8e9ca3c026e6254cba249ab130
MD5 45dbd0f74c208281df9342efb6d757f9
BLAKE2b-256 54bf3c693d202236fb2cbab6ff271ac79bf37ebef80e9ddce334e691f2010c41

See more details on using hashes here.

File details

Details for the file fh_matui-0.9.16-py3-none-any.whl.

File metadata

  • Download URL: fh_matui-0.9.16-py3-none-any.whl
  • Upload date:
  • Size: 55.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for fh_matui-0.9.16-py3-none-any.whl
Algorithm Hash digest
SHA256 f4d0826dee786c37c513ed77cd1303ea42315bd6f7dca26e88ad884257ea9303
MD5 f70dc40f8c1f125b504c92002b0b9555
BLAKE2b-256 f94b387de289b89507a70c91d17bde846f6aa945d611579a09d9990479ebcbc1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page