Shad4Fasthtml screenshot

Shad4Fasthtml

Author Avatar Theme by Curtis allan
Updated: 9 Nov 2024
153 Stars

Porting Shadcn-ui components to python/js for use with fasthtml

Overview:

This documentation provides a guide for installing and utilizing Shad4Fast, a UI component framework for FastHtml. Credits are given to the contributors and guidance is offered on setting up the framework, including installation, configuration, and theme handling. Users are encouraged to report any bugs or issues encountered on the GitHub repository.

Features:

  • Quick Start Guide: Easy setup and installation process for Shad4Fast.
  • Tailwind Configuration: Utilizes TailwindCSS library for styling via cdn script or standalone package.
  • Theme Handling: Includes a script for seamless light/dark theme implementation in FastHtml applications.
  • Component Documentation: Detailed guidelines on implementing Shadcn UI components with their properties and usage instructions.
  • Lucide Icons Integration: Dependency on Lucide Icons with an optional pip package for improved rendering and configuration.

Installation:

  1. Ensure Python environment is set up (recommended to use venv).
  2. Install Shad4Fast pip package: pip install Shad4Fast.
  3. Create a root file for FastHtml application.
  4. Import necessary statements to file.
  5. Add ShadHead() in FastHTML headers and disable default Pico.css header.

Summary:

Shad4Fast documentation provides a comprehensive overview of setting up and leveraging the UI components in FastHtml applications. It offers easy installation steps, guidance on TailwindCSS configuration, theme handling, component usage, and Lucide Icons integration. Users are encouraged to report any encountered issues on the GitHub repository.