Frappe Theme

A powerful utility app for Frappe Framework that extends desk and web interfaces with advanced UI components, data visualization, theme customization, and security features — all configurable without writing code.

Built and maintained by Suvaidyam · GitHub

Key Features

Feature	Description	Guide
SvaDatatable	Display connected/linked DocTypes as interactive tables inside any form	docs/sva-datatable.md
Number Cards & Charts	Embed number cards and dashboard charts inside DocType form tabs	docs/number-cards-and-charts.md
India Heatmap	Interactive state/district map visualization with Leaflet.js	docs/india-heatmap.md
Theme Customization	Customize colors for navbar, sidebar, buttons, inputs, tables, login page	docs/theme-customization.md
Data Protection	Field-level encryption (Fernet) and masking across forms, lists, and reports	docs/data-protection.md
Workflow Customization	Approval assignments, audit trail, and timeline visualization	docs/workflow-customization.md
Cloud Storage	Auto-upload files to AWS S3 or Azure Blob Storage	docs/cloud-storage.md
Gallery & Carousel	File gallery (Card/List/Directory views), image carousel, drag-drop reordering	docs/gallery-and-carousel.md
Workspace Widgets	Embed heatmaps and data tables directly in Frappe workspaces	docs/workspace-configuration.md
Dashboard Mode	Turn any Single DocType into a dashboard with cards, charts, maps	docs/dashboard-mode.md
Custom Property Setter	Field-level component configuration via props (replaces central config)	docs/custom-property-setter.md
Change Log	Unified version history across parent and connected child documents	docs/changelog-component.md
Additional Components	Timeline, Notes, Tasks, Approval Tracker, Field Comments, SDG Wheel	docs/additional-components.md

Screenshots

Heatmaps in Workspace

Connected DocType Tables in Forms

Number Cards & Charts in Form Tabs

Custom Tables in Workspaces

Theme Color Customization

Installation

Stable (main branch):

cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch main
bench install-app frappe_theme

Latest (development branch):

cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch development
bench install-app frappe_theme

Quick Start

1. Install the app using the commands above
2. Navigate to My Theme in the search bar to configure your desk colors
3. Create an SVADatatable Configuration to embed linked DocType tables in forms
4. Create an SVAWorkspace Configuration to add heatmaps or tables to workspaces

For detailed setup instructions, see the Getting Started Guide.

Documentation

• Getting Started — Installation, prerequisites, first setup
• Theme Customization — My Theme DocType configuration
• SvaDatatable — Connected DocType tables in forms
• Number Cards & Charts — Dashboard widgets in form tabs
• India Heatmap — State/district map visualization
• Workspace Configuration — Heatmaps and tables in workspaces
• Data Protection — Field-level encryption and masking
• Workflow Customization — Approval workflows and audit trail
• Cloud Storage — AWS S3 and Azure Blob integration
• Gallery & Carousel — File gallery and image carousel
• Dashboard Mode — Single DocType dashboards with cards, charts, maps
• Custom Property Setter — Field-level component configuration
• Change Log — Unified version history component
• Additional Components — Timeline, Notes, Tasks, and more
• API Reference — Python APIs, JavaScript classes, DTConf engine

Contributing

This app uses pre-commit for code formatting and linting. Please install pre-commit and enable it for this repository:

cd apps/frappe_theme
pre-commit install

Pre-commit is configured to use the following tools for checking and formatting your code:

• ruff
• eslint
• prettier
• pyupgrade

License

MIT