Skip to content

Configuration Options

Complete alphabetical reference of all available configuration options with defaults, types, and descriptions.

Core Configuration

Setting Type Default Description Reference
action_button_classes str '' Additional CSS classes for action buttons (edit, delete, etc.) Styling
base_template_path str Framework-specific Path to your project's base template Core Config
bulk_async bool False Enable asynchronous processing for bulk operations Bulk Operations
bulk_async_backend str 'q2' Backend for async processing (currently only 'q2' supported) Bulk Operations
bulk_async_notification str 'status_page' Notification method for async operations ('status_page', 'email', 'messages') Bulk Operations
bulk_delete bool False Enable bulk delete functionality Bulk Operations
bulk_fields list [] List of fields available for bulk editing Bulk Operations
bulk_full_clean bool True Run full_clean() on each object during bulk operations Bulk Operations
bulk_min_async_records int 20 Minimum number of records to trigger async processing Bulk Operations
default_htmx_target str '#content' Default target for HTMX responses HTMX & Modals
detail_exclude list [] Fields to exclude from detail view Core Config
detail_fields list/str Same as fields Fields to show in detail view ('__all__', '__fields__', or list) Core Config
detail_properties list/str [] Properties to show in detail view ('__all__', '__properties__', or list) Core Config
detail_properties_exclude list [] Properties to exclude from detail view Core Config
dropdown_sort_options dict {} Sort options for dropdown fields (applies to forms, filters, bulk operations) Form Handling
exclude list [] Fields to exclude from list view Core Config
extra_actions list [] Additional actions for each record in the list Complete Example
extra_button_classes str '' Additional CSS classes for extra buttons at top of page Styling
extra_buttons list [] Additional buttons at the top of the page Complete Example
fields list/str All model fields Fields to show in list view ('__all__' or list) Core Config
filter_queryset_options dict {} Restrict options in filter dropdowns Filtering
filter_sort_options dict {} Sort options for filter dropdown fields Filtering
filterset_class FilterSet Auto-generated Custom filterset class for advanced filtering Filtering
filterset_fields list [] Fields to enable filtering on Filtering
form_class ModelForm Auto-generated Custom form class (overrides form_fields) Form Handling
form_fields list/str Editable fields from detail_fields Fields to include in forms ('__all__', '__fields__', or list) Form Handling
form_fields_exclude list [] Fields to exclude from forms Form Handling
hx_trigger str/dict None Custom HTMX triggers for responses HTMX & Modals
m2m_filter_and_logic bool False Use AND logic for M2M filters (default is OR) Filtering
modal_id str "powercrudBaseModal" ID of modal container HTMX & Modals
modal_target str "powercrudModalContent" Target for modal content (no # prefix) HTMX & Modals
model Model Required Django model class for the CRUD view Core Config
namespace str None URL namespace (must match app_name in urls.py) Core Config
paginate_by int None Default page size (enables pagination) Pagination
properties list/str [] Properties to show in list view ('__all__' or list) Core Config
properties_exclude list [] Properties to exclude from list view Core Config
table_classes str '' Additional CSS classes for tables Styling
table_header_min_wrap_width int Same as table_max_col_width Minimum width for column headers when they wrap (ch units) Styling
table_max_col_width int 25 Maximum column width in characters Styling
table_max_height int 70 Max table height as percentage of remaining viewport Styling
table_pixel_height_other_page_elements int/float 0 Height of other page elements in pixels Styling
templates_path str "powercrud/{framework}" Path to override templates Core Config
url_base str Model name Base for URL patterns Core Config
use_crispy bool True if installed Enable crispy forms styling Form Handling
use_htmx bool None Enable HTMX for reactive updates HTMX & Modals
use_modal bool None Enable modal dialogs for CRUD operations HTMX & Modals

Settings Configuration

Setting Default Description Reference
NOMINOPOLITAN_CSS_FRAMEWORK 'daisyui' CSS framework choice ('daisyui', 'bootstrap5', or custom) Styling
NM_TAILWIND_SAFELIST_JSON_LOC None Location for Tailwind safelist file generation Styling

Notes

  • Required settings: Only model and base_template_path are required
  • Auto-detection: use_crispy and use_htmx auto-detect library availability
  • Dependencies: Bulk operations require both use_htmx = True and use_modal = True
  • Field shortcuts: Use '__all__' for all fields, '__fields__' to reference the fields setting
  • Property shortcuts: Use '__all__' for all properties, '__properties__' to reference the properties setting