Skip to content

Admin reference

Reference for @ghuri/admin. For setup and a guided tour, read The admin first. Options are class fields; Django’s snake_case names become camelCase (list_display is listDisplay). Hooks receive the Hono context c where Django passes request; use getUser(c) for request.user.

Option Default
listDisplay ['__str__'] Columns: field names, 'author__username' paths, ModelAdmin method names, model method names, or functions
listDisplayLinks first column Columns linking to the change form; null for none
listFilter [] Field names ('published', 'author__isStaff'), SimpleListFilter subclasses, or ['field', FilterClass]. See List filters
listSelectRelated false true (all foreign keys), field names, or false (the foreign keys shown in listDisplay)
listPerPage 100 Rows per page
listMaxShowAll 200 Largest result count for which “Show all” is offered
listEditable [] Fields edited in place on the change list, saved with one “Save” button
searchFields [] 'title' (icontains), '^slug' (istartswith), '=email' (iexact), '@body' (treated as icontains), 'author__username'. Words are ANDed, fields ORed; "quoted phrases" stay together
searchHelpText null Text under the search box
dateHierarchy null A date or datetime field: year → month → day drill-down links
ordering the model’s Meta.ordering Default ordering; the pk is appended for a stable order
sortableBy all columns Restrict sortable columns
showFullResultCount true Show “N results (M total)” when filtered; false saves a COUNT query
actions [] Extra actions, added to the site-wide delete_selected; null disables actions. See Actions
actionsOnTop / actionsOnBottom true / false Where the action bar is shown
actionsSelectionCounter true Show “N of M selected”
emptyValueDisplay the site’s '-' Shown for empty values
preserveFilters true Keep the change list filters across add, change and delete

Sorting uses Django’s ?o= parameter (?o=2.-1 sorts by column 2 ascending, then column 1 descending); column headers show the sort priority with toggle and remove links.

class PostAdmin extends ModelAdmin<Post> {
listDisplay = ['title', 'author', 'status', 'wordCount']
listDisplayLinks = ['title']
listFilter = ['status', 'author', 'createdAt', DecadeFilter, ['category', RelatedOnlyFieldListFilter]]
listSelectRelated = ['author']
searchFields = ['^title', 'body', 'author__username']
dateHierarchy = 'createdAt'
ordering = ['-createdAt']
listPerPage = 50
listEditable = ['status']
}
Option Default
fields all editable fields Field names; nest an array to put fields on one line: ['title', ['slug', 'status']]
exclude null Fields left off the form
fieldsets one unnamed fieldset [[name | null, { fields, classes?, description? }], ...]. classes: ['collapse'] renders a <details>, ['wide'] widens labels
readonlyFields [] Field names, method names or functions, shown as text. Non-editable fields (autoNowAdd, …) are always read-only
prepopulatedFields {} { slug: ['title'] }: slugified as you type (JavaScript), on new and empty fields
rawIdFields [] Foreign key or many-to-many as an id input with a lookup link (comma-separated ids for many-to-many)
autocompleteFields [] Foreign key or many-to-many with search-as-you-type (htmx). The related model’s admin needs searchFields
filterHorizontal / filterVertical [] Many-to-many as a filterable multi-select
radioFields {} { status: HORIZONTAL }: choices or a foreign key as radio buttons (HORIZONTAL / VERTICAL)
formfieldOverrides {} Per model field type, keyed by internalType: { TextField: { widget: 'text', attrs: { size: 80 } } }
saveAs false Show “Save as new”
saveAsContinue true After “Save as new”, continue editing the new object
saveOnTop false Show the save buttons above the form too
viewOnSite true “View on site” uses obj.getAbsoluteUrl(); or a function (obj) => url, or false
inlines [] Inline classes. See Inlines
class PostAdmin extends ModelAdmin<Post> {
fieldsets = [
[null, { fields: ['title', 'slug', 'body'] }],
['Publishing', {
fields: [['published', 'publishedAt'], 'author', 'tags'],
classes: ['collapse'],
description: 'Visible on the site once published.',
}],
]
readonlyFields = ['createdAt', 'wordCount']
prepopulatedFields = { slug: ['title'] }
autocompleteFields = ['author']
filterHorizontal = ['tags']
radioFields = { status: admin.VERTICAL }
saveAs = true
}

Forms are built from each model field’s formHint(), converted with field.toPython() and validated with the model’s fullClean() (null, blank, choices, validators, clean(), foreign-key existence and uniqueness). Non-field errors appear above the form.

Model field Widget
CharField, SlugField, UUIDField, … <input type="text"> with maxlength
TextField <textarea>
EmailField / URLField type="email" / type="url"
integer, float, decimal, duration type="number" with step, min, max
BooleanField checkbox
DateField / TimeField / DateTimeField type="date" / type="time" / type="datetime-local", in UTC
JSONField <textarea>, pretty-printed and validated
fields with choices <select> (or radios)
ForeignKey / OneToOneField <select>, raw id, autocomplete or radios
ManyToManyField multi-select, filter box, raw ids or autocomplete
FileField / ImageField file input with “Currently: link”, “Clear” and “Change” (multipart)

Add form-wide validation with cleanForm(c, form):

class EventAdmin extends ModelAdmin<Event> {
cleanForm(c: Context, form: ModelForm) {
const { start, end } = form.cleanedData as any
if (start && end && end < start) form.addError('end', 'The end must be after the start.')
}
}

There are no separate ModelForm classes to declare. At a lower level, getFormFields(c, obj, fieldNames?) returns the FormFields (override it to add virtual fields, as UserAdmin does for its password fields), formfieldForDbField(c, field) builds one, and getFieldQueryset(c, field) limits foreign-key and many-to-many choices.

display({ description, ordering, boolean, emptyValue }) (Django’s @admin.display) decorates a listDisplay or readonlyFields callable:

Option
description Column header or label (Django’s short_description)
ordering Field (or -field) to sort by when the header is clicked (Django’s admin_order_field)
boolean Render the value as a yes / no / unknown icon
emptyValue Text for empty values
import { display, ModelAdmin } from '@ghuri/admin'
class PostAdmin extends ModelAdmin<Post> {
listDisplay = ['title', 'isRecent', 'colored', 'authorName']
@display({ description: 'Recent?', boolean: true, ordering: '-createdAt' })
isRecent(obj: Post) { return obj.createdAt > lastWeek() }
@display({ description: 'Status' })
colored(obj: Post) { return <span style={`color: ${obj.color}`}>{obj.status}</span> } // JSX is rendered
// without decorators
authorName = display({ description: 'Author', emptyValue: '(nobody)' }, async (obj: Post) => (await obj.author)?.username)
}

Callables may be async. Values are escaped; return JSX or html from hono/html for markup, and never build HTML from user data with raw().

A field name in listFilter picks a filter from the field’s type:

Class Used for Choices
BooleanFieldListFilter BooleanField All / Yes / No (/ Unknown when nullable)
ChoicesFieldListFilter fields with choices All and each choice
RelatedFieldListFilter foreign key, many-to-many, reverse relations All and one link per related object
DateFieldListFilter DateField, DateTimeField Any date / Today / Past 7 days / This month / This year (/ No date / Has date when nullable)
AllValuesFieldListFilter everything else Every distinct value

Two more are chosen explicitly with ['field', FilterClass]:

Class
RelatedOnlyFieldListFilter Like RelatedFieldListFilter, but only related objects actually in use
EmptyFieldListFilter Empty / Not empty
listFilter = ['published', ['category', RelatedOnlyFieldListFilter], ['summary', EmptyFieldListFilter]]

FieldListFilter.register(test, FilterClass, takePriority?) adds a filter class for the fields matching test (Django’s FieldListFilter.register).

Subclass SimpleListFilter, set title and parameterName, and implement lookups() and queryset():

import type { Context } from 'hono'
import type { QuerySet } from '@ghuri/orm'
import { type ModelAdmin, SimpleListFilter } from '@ghuri/admin'
class DecadeFilter extends SimpleListFilter {
title = 'decade born'
parameterName = 'decade'
lookups(c: Context, modelAdmin: ModelAdmin) {
return [['80s', 'in the eighties'], ['90s', 'in the nineties']] as Array<[string, string]>
}
queryset(c: Context, qs: QuerySet<any>) {
if (this.value() === '80s') return qs.filter({ birthday__gte: '1980-01-01', birthday__lt: '1990-01-01' })
if (this.value() === '90s') return qs.filter({ birthday__gte: '1990-01-01', birthday__lt: '2000-01-01' })
return qs
}
}
Member
title Heading shown as “By ”. Required</td> </tr> <tr> <td><code dir="auto">parameterName</code></td> <td>Query-string parameter. Required</td> </tr> <tr> <td><code dir="auto">lookups(c, modelAdmin)</code></td> <td><code dir="auto">[value, label]</code> pairs for the links. May be async. The filter is hidden when it returns none</td> </tr> <tr> <td><code dir="auto">queryset(c, qs)</code></td> <td>The filtered QuerySet, or <code dir="auto">qs</code> unchanged when inactive</td> </tr> <tr> <td><code dir="auto">value()</code></td> <td>The selected value, or <code dir="auto">null</code></td> </tr> </tbody> </table> <aside aria-label="Caution" class="starlight-aside starlight-aside--caution"><p class="starlight-aside__title" aria-hidden="true"><svg viewBox="0 0 24 24" width="16" height="16" fill="currentColor" class="starlight-aside__icon"><path d="M12 16a1 1 0 1 0 0 2 1 1 0 0 0 0-2Zm10.67 1.47-8.05-14a3 3 0 0 0-5.24 0l-8 14A3 3 0 0 0 3.94 22h16.12a3 3 0 0 0 2.61-4.53Zm-1.73 2a1 1 0 0 1-.88.51H3.94a1 1 0 0 1-.88-.51 1 1 0 0 1 0-1l8-14a1 1 0 0 1 1.78 0l8.05 14a1 1 0 0 1 .05 1.02v-.02ZM12 8a1 1 0 0 0-1 1v4a1 1 0 0 0 2 0V9a1 1 0 0 0-1-1Z"/></svg>Caution</p><div class="starlight-aside__content"><p>Return the QuerySet <strong>synchronously</strong> from <code dir="auto">queryset()</code>. QuerySets are thenable, so an <code dir="auto">async</code> method would resolve it to an array. From async code, return <code dir="auto">{ qs }</code> instead.</p></div></aside> <p>For full control, extend <code dir="auto">ListFilter</code> and implement <code dir="auto">hasOutput()</code>, <code dir="auto">choices(cl)</code>, <code dir="auto">queryset(c, qs)</code> and <code dir="auto">expectedParameters()</code>.</p> <div class="sl-heading-wrapper level-h3"><h3 id="query-string-lookups">Query-string lookups</h3><a class="sl-anchor-link" href="#query-string-lookups"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Query-string lookups”</span></a></div> <p>Lookups on local fields in the query string (<code dir="auto">?views__gte=100</code>) work like Django’s. Lookups that span relations are only allowed for paths listed in <code dir="auto">listFilter</code> or <code dir="auto">dateHierarchy</code> (<code dir="auto">lookupAllowed(lookup, value, c)</code>); others redirect to <code dir="auto">?e=1</code>.</p> <div class="sl-heading-wrapper level-h2"><h2 id="actions">Actions</h2><a class="sl-anchor-link" href="#actions"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Actions”</span></a></div> <p>An action function has the signature <code dir="auto">(modelAdmin, c, queryset) => void | Response</code> (sync or async). Return nothing to redirect back to the change list (with any flash messages), or a <code dir="auto">Response</code>, such as a confirmation page or a file download. <code dir="auto">action()</code> attaches options:</p> <table> <thead> <tr> <th>Option</th> <th></th> </tr> </thead> <tbody> <tr> <td><code dir="auto">description</code></td> <td>Label in the action menu (Django’s <code dir="auto">short_description</code>). <code dir="auto">%(verbose_name_plural)s</code> is replaced with the model’s plural name</td> </tr> <tr> <td><code dir="auto">permissions</code></td> <td><code dir="auto">['add' | 'change' | 'delete' | 'view' | 'x']</code>. The action is offered when any of <code dir="auto">hasAddPermission(c)</code>, …, or <code dir="auto">hasXPermission(c)</code> is true</td> </tr> </tbody> </table> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { action, ModelAdmin } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/admin</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { getUser } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/core</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">export const </span><span style="--0:#82AAFF;--1:#3B61B0">makePublished</span><span style="--0:#C792EA;--1:#8844AE"> = </span><span style="--0:#82AAFF;--1:#3B61B0">action</span><span style="--0:#D6DEEB;--1:#403F53">(</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">{ description: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Mark selected %(verbose_name_plural)s as published</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">, permissions:</span><span style="--0:#D6DEEB;--1:#403F53"> [</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">change</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">]</span><span style="--0:#C792EA;--1:#8844AE"> },</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">async </span><span style="--0:#D9F5DD;--1:#111111">(</span><span style="--0:#D7DBE0;--1:#403F53">modelAdmin</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D7DBE0;--1:#403F53">c</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D7DBE0;--1:#403F53">queryset</span><span style="--0:#D9F5DD;--1:#111111">)</span><span style="--0:#C792EA;--1:#8844AE"> => {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">const </span><span style="--0:#82AAFF;--1:#3B61B0">n</span><span style="--0:#C792EA;--1:#8844AE"> = await </span><span style="--0:#D6DEEB;--1:#403F53">queryset</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">update</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#C792EA;--1:#8844AE">{ published: </span><span style="--0:#FF6A83;--1:#A24848">true</span><span style="--0:#C792EA;--1:#8844AE"> }</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">await </span><span style="--0:#D6DEEB;--1:#403F53">modelAdmin</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">messageUser</span><span style="--0:#D6DEEB;--1:#403F53">(c</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D6DEEB;--1:#403F53">`</span><span style="--0:#E2817F;--1:#B23834">${</span><span style="--0:#D6DEEB;--1:#403F53">n</span><span style="--0:#E2817F;--1:#B23834">}</span><span style="--0:#ECC48D;--1:#3B61B0"> posts were published.</span><span style="--0:#D6DEEB;--1:#403F53">`</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">success</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">},</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">class</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">PostAdmin</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">extends</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C5E478;--1:#3B61B0">ModelAdmin</span><span style="--0:#D6DEEB;--1:#403F53"><</span><span style="--0:#FFCB8B;--1:#111111">Post</span><span style="--0:#D6DEEB;--1:#403F53">> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">actions </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> [makePublished, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">archive</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">]</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#82AAFF;--1:#3B61B0">@action</span><span style="--0:#D6DEEB;--1:#403F53">({ description: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Archive</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, permissions: [</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">publish</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">] })</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">async</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#82AAFF;--1:#3B61B0">archive</span><span style="--0:#D9F5DD;--1:#111111">(</span><span style="--0:#D7DBE0;--1:#403F53">c</span><span style="--0:#7FDBCA;--1:#096E72">:</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">Context</span><span style="--1:#403F53"><span style="--0:#D6DEEB">, </span><span style="--0:#D7DBE0">queryset</span></span><span style="--0:#7FDBCA;--1:#096E72">:</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">QuerySet</span><span style="--0:#D6DEEB;--1:#403F53"><</span><span style="--0:#FFCB8B;--1:#111111">Post</span><span style="--0:#D6DEEB;--1:#403F53">></span><span style="--0:#D9F5DD;--1:#111111">)</span><span style="--0:#D6DEEB;--1:#403F53"> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">await</span><span style="--0:#D6DEEB;--1:#403F53"> queryset</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">update</span><span style="--0:#D6DEEB;--1:#403F53">({ archived: </span><span style="--0:#FF6A83;--1:#A24848">true</span><span style="--0:#D6DEEB;--1:#403F53"> })</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">async</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#82AAFF;--1:#3B61B0">hasPublishPermission</span><span style="--0:#D9F5DD;--1:#111111">(</span><span style="--0:#D7DBE0;--1:#403F53">c</span><span style="--0:#7FDBCA;--1:#096E72">:</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--1:#111111"><span style="--0:#FFCB8B">Context</span><span style="--0:#D9F5DD">)</span></span><span style="--0:#D6DEEB;--1:#403F53"> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">return</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#82AAFF;--1:#3B61B0">getUser</span><span style="--0:#D6DEEB;--1:#403F53">(c)</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">hasPerm</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">blog.publish_post</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { action, ModelAdmin } from '@ghuri/admin'import { getUser } from '@ghuri/core'export const makePublished = action( { description: 'Mark selected %(verbose_name_plural)s as published', permissions: ['change'] }, async (modelAdmin, c, queryset) => { const n = await queryset.update({ published: true }) await modelAdmin.messageUser(c, `${n} posts were published.`, 'success') },)class PostAdmin extends ModelAdmin<Post> { actions = [makePublished, 'archive'] @action({ description: 'Archive', permissions: ['publish'] }) async archive(c: Context, queryset: QuerySet<Post>) { await queryset.update({ archived: true }) } async hasPublishPermission(c: Context) { return getUser(c).hasPerm('blog.publish_post') }}"><div></div></button></div></figure></div> <p>Entries in <code dir="auto">actions</code> can be functions, names of <code dir="auto">ModelAdmin</code> methods (methods receive <code dir="auto">(c, queryset)</code>), or names of site-wide actions. Without a <code dir="auto">description</code>, the label is the humanized function name.</p> <p><code dir="auto">messageUser(c, message, level)</code> adds a flash message; levels are <code dir="auto">'debug'</code>, <code dir="auto">'info'</code>, <code dir="auto">'success'</code>, <code dir="auto">'warning'</code> and <code dir="auto">'error'</code> (or the exported <code dir="auto">DEBUG</code>, <code dir="auto">INFO</code>, <code dir="auto">SUCCESS</code>, <code dir="auto">WARNING</code>, <code dir="auto">ERROR</code> constants).</p> <div class="sl-heading-wrapper level-h3"><h3 id="delete_selected"><code dir="auto">delete_selected</code></h3><a class="sl-anchor-link" href="#delete_selected"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “delete_selected”</span></a></div> <p>“Delete selected …” (<code dir="auto">deleteSelected</code>, named <code dir="auto">delete_selected</code>) is a site-wide action that requires the <code dir="auto">delete</code> permission. Its confirmation page lists every object that will be deleted, including cascades, and refuses when objects are protected or the user lacks delete permission on any of them. Deletion goes through <code dir="auto">deleteQueryset(c, qs)</code>.</p> <table> <thead> <tr> <th></th> <th></th> </tr> </thead> <tbody> <tr> <td><code dir="auto">admin.site.disableAction('delete_selected')</code></td> <td>Remove it everywhere. Name it in a <code dir="auto">ModelAdmin</code>’s <code dir="auto">actions</code> to re-enable it for that admin</td> </tr> <tr> <td><code dir="auto">admin.site.addAction(fn, name?)</code></td> <td>Add a site-wide action</td> </tr> <tr> <td><code dir="auto">admin.site.getAction(name)</code></td> <td>Look one up</td> </tr> <tr> <td><code dir="auto">actions = null</code></td> <td>No actions (and no checkboxes) on one admin</td> </tr> </tbody> </table> <p>“Select all N” (selecting across pages) is supported.</p> <div class="sl-heading-wrapper level-h2"><h2 id="inlines">Inlines</h2><a class="sl-anchor-link" href="#inlines"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Inlines”</span></a></div> <p><code dir="auto">TabularInline</code> (rows of a table) and <code dir="auto">StackedInline</code> (one full form per object) both extend <code dir="auto">InlineModelAdmin</code>:</p> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { ModelAdmin, StackedInline, TabularInline } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/admin</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">class</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">CommentInline</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">extends</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C5E478;--1:#3B61B0">TabularInline</span><span style="--0:#D6DEEB;--1:#403F53"><</span><span style="--0:#FFCB8B;--1:#111111">Comment</span><span style="--0:#D6DEEB;--1:#403F53">> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">model </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> Comment</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">extra </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#F78C6C;--1:#AA0982">1</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">minNum </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#F78C6C;--1:#AA0982">0</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">maxNum </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#F78C6C;--1:#AA0982">10</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">canDelete </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FF6A83;--1:#A24848">true</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">showChangeLink </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FF6A83;--1:#A24848">true</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">fkName </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">post</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#919F9F;--1:#5D6376">// only when Comment has several foreign keys to Post</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">readonlyFields </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> [</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">createdAt</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">]</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">class</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">PostAdmin</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">extends</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C5E478;--1:#3B61B0">ModelAdmin</span><span style="--0:#D6DEEB;--1:#403F53"><</span><span style="--0:#FFCB8B;--1:#111111">Post</span><span style="--0:#D6DEEB;--1:#403F53">> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">inlines </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> [CommentInline]</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { ModelAdmin, StackedInline, TabularInline } from '@ghuri/admin'class CommentInline extends TabularInline<Comment> { model = Comment extra = 1 minNum = 0 maxNum = 10 canDelete = true showChangeLink = true fkName = 'post' // only when Comment has several foreign keys to Post readonlyFields = ['createdAt']}class PostAdmin extends ModelAdmin<Post> { inlines = [CommentInline]}"><div></div></button></div></figure></div> <table> <thead> <tr> <th>Option</th> <th>Default</th> <th></th> </tr> </thead> <tbody> <tr> <td><code dir="auto">model</code></td> <td>required</td> <td>The inline model</td> </tr> <tr> <td><code dir="auto">fkName</code></td> <td>auto-detected</td> <td>The foreign key to the parent; required when there are several</td> </tr> <tr> <td><code dir="auto">extra</code></td> <td><code dir="auto">3</code></td> <td>Empty forms shown</td> </tr> <tr> <td><code dir="auto">minNum</code> / <code dir="auto">maxNum</code></td> <td><code dir="auto">null</code></td> <td>Minimum and maximum number of forms</td> </tr> <tr> <td><code dir="auto">canDelete</code></td> <td><code dir="auto">true</code></td> <td>Show “Delete” checkboxes</td> </tr> <tr> <td><code dir="auto">showChangeLink</code></td> <td><code dir="auto">false</code></td> <td>Link each row to the object’s own change form</td> </tr> <tr> <td><code dir="auto">verboseName</code> / <code dir="auto">verboseNamePlural</code></td> <td>the model’s</td> <td>Heading</td> </tr> <tr> <td><code dir="auto">classes</code></td> <td><code dir="auto">[]</code></td> <td>CSS classes, e.g. <code dir="auto">['collapse']</code></td> </tr> <tr> <td><code dir="auto">description</code></td> <td>unset</td> <td>Text above the inline</td> </tr> </tbody> </table> <p>Inlines also take the form options (<code dir="auto">fields</code>, <code dir="auto">exclude</code>, <code dir="auto">fieldsets</code>, <code dir="auto">readonlyFields</code>, <code dir="auto">rawIdFields</code>, <code dir="auto">autocompleteFields</code>, <code dir="auto">formfieldOverrides</code>, …) and the hooks <code dir="auto">getExtra(c, obj)</code>, <code dir="auto">getMinNum(c, obj)</code> and <code dir="auto">getMaxNum(c, obj)</code>. Permission hooks default to the inline model’s permissions; for auto-created many-to-many through models they use the parent’s <code dir="auto">change</code> (and <code dir="auto">view</code>) permission. On an inline, <code dir="auto">hasAddPermission(c, obj)</code> receives the parent object being edited (undefined on the parent’s add page).</p> <p>Without JavaScript the <code dir="auto">extra</code> rows are shown; with it an “Add another …” link clones rows. Form fields are named like Django’s formsets (<code dir="auto">comments-0-text</code>, <code dir="auto">comments-TOTAL_FORMS</code>, …); the prefix is the reverse accessor name, such as <code dir="auto">comments</code> or <code dir="auto">commentSet</code>.</p> <div class="sl-heading-wrapper level-h2"><h2 id="hooks">Hooks</h2><a class="sl-anchor-link" href="#hooks"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Hooks”</span></a></div> <p>Override these like Django’s methods:</p> <table> <thead> <tr> <th>Hook</th> <th></th> </tr> </thead> <tbody> <tr> <td><code dir="auto">getQueryset(c)</code></td> <td>Base queryset of every view. Return it synchronously</td> </tr> <tr> <td><code dir="auto">getSearchResults(c, qs, term)</code></td> <td><code dir="auto">[qs, mayHaveDuplicates]</code></td> </tr> <tr> <td><code dir="auto">getListDisplay(c)</code>, <code dir="auto">getListDisplayLinks(c, list)</code>, <code dir="auto">getListFilter(c)</code>, <code dir="auto">getSearchFields(c)</code>, <code dir="auto">getSortableBy(c)</code>, <code dir="auto">getListSelectRelated(c)</code>, <code dir="auto">getOrdering(c)</code></td> <td>Per-request change list options</td> </tr> <tr> <td><code dir="auto">getFields(c, obj)</code>, <code dir="auto">getFieldsets(c, obj)</code>, <code dir="auto">getReadonlyFields(c, obj)</code>, <code dir="auto">getPrepopulatedFields(c, obj)</code>, <code dir="auto">getExclude(c, obj)</code>, <code dir="auto">getAutocompleteFields(c)</code></td> <td>Per-request form options</td> </tr> <tr> <td><code dir="auto">getInlines(c, obj)</code>, <code dir="auto">getInlineInstances(c, obj)</code></td> <td>Inlines</td> </tr> <tr> <td><code dir="auto">getFormFields(c, obj, names?)</code>, <code dir="auto">formfieldForDbField(c, field)</code>, <code dir="auto">getFieldQueryset(c, field)</code>, <code dir="auto">cleanForm(c, form)</code></td> <td>Form construction (Django’s <code dir="auto">get_form</code>)</td> </tr> <tr> <td><code dir="auto">getChangeformInitialData(c)</code></td> <td>Initial values of the add form (default: the query string, <code dir="auto">?title=Hi</code>)</td> </tr> <tr> <td><code dir="auto">getObject(c, id)</code></td> <td>The object of the change, delete and history views</td> </tr> <tr> <td><code dir="auto">saveModel(c, obj, form, change)</code>, <code dir="auto">saveRelated(c, form, formsets, change)</code>, <code dir="auto">saveFormset(c, form, formset, change)</code></td> <td>Saving</td> </tr> <tr> <td><code dir="auto">deleteModel(c, obj)</code>, <code dir="auto">deleteQueryset(c, qs)</code></td> <td>Deleting</td> </tr> <tr> <td><code dir="auto">responseAdd(c, obj, data)</code>, <code dir="auto">responseChange(c, obj, data)</code>, <code dir="auto">responseDelete(c, repr)</code></td> <td>Redirects after saving (<code dir="auto">_continue</code>, <code dir="auto">_addanother</code>, <code dir="auto">_saveasnew</code>)</td> </tr> <tr> <td><code dir="auto">logAddition</code>, <code dir="auto">logChange</code>, <code dir="auto">logDeletion</code></td> <td><code dir="auto">LogEntry</code> records</td> </tr> <tr> <td><code dir="auto">messageUser(c, message, level)</code></td> <td>Flash message</td> </tr> <tr> <td><code dir="auto">lookupAllowed(lookup, value, c)</code></td> <td>Query-string filtering policy</td> </tr> <tr> <td><code dir="auto">getActions(c)</code>, <code dir="auto">getAction(spec)</code>, <code dir="auto">responseAction(c, data, qs)</code></td> <td>Actions</td> </tr> <tr> <td><code dir="auto">getUrls()</code></td> <td>URL patterns (add custom views)</td> </tr> <tr> <td><code dir="auto">getDeletedObjects(objs, c)</code></td> <td>Objects listed on delete confirmations</td> </tr> <tr> <td><code dir="auto">getViewOnSiteUrl(obj)</code>, <code dir="auto">getEmptyValueDisplay()</code></td> <td></td> </tr> </tbody> </table> <div class="sl-heading-wrapper level-h3"><h3 id="permission-hooks">Permission hooks</h3><a class="sl-anchor-link" href="#permission-hooks"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Permission hooks”</span></a></div> <table> <thead> <tr> <th>Hook</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code dir="auto">hasViewPermission(c, obj?)</code></td> <td><code dir="auto">app.view_model</code> or <code dir="auto">app.change_model</code></td> </tr> <tr> <td><code dir="auto">hasAddPermission(c, obj?)</code></td> <td><code dir="auto">app.add_model</code></td> </tr> <tr> <td><code dir="auto">hasChangePermission(c, obj?)</code></td> <td><code dir="auto">app.change_model</code></td> </tr> <tr> <td><code dir="auto">hasDeletePermission(c, obj?)</code></td> <td><code dir="auto">app.delete_model</code></td> </tr> <tr> <td><code dir="auto">hasModulePermission(c)</code></td> <td><code dir="auto">user.hasModulePerms(appLabel)</code></td> </tr> </tbody> </table> <p>Active superusers pass every check. Users with only the view permission get read-only change forms with no save buttons, and their POSTs answer <code dir="auto">403</code>. The index and app pages list only models the user may see. <code dir="auto">AdminSite.hasPermission(c)</code> (default: active staff) guards the whole site.</p> <div class="sl-heading-wrapper level-h2"><h2 id="custom-admin-views">Custom admin views</h2><a class="sl-anchor-link" href="#custom-admin-views"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Custom admin views”</span></a></div> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="tsx"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { path } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/core</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">class</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">PostAdmin</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">extends</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C5E478;--1:#3B61B0">ModelAdmin</span><span style="--0:#D6DEEB;--1:#403F53"><</span><span style="--0:#FFCB8B;--1:#111111">Post</span><span style="--0:#D6DEEB;--1:#403F53">> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#82AAFF;--1:#3B61B0">getUrls</span><span style="--0:#D9F5DD;--1:#111111">()</span><span style="--0:#D6DEEB;--1:#403F53"> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">return</span><span style="--0:#D6DEEB;--1:#403F53"> [</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#82AAFF;--1:#3B61B0">path</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">stats/</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, </span><span style="--0:#7FDBCA;--1:#096E72">this</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#FAF39F;--1:#111111">adminSite</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">adminView</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">(</span><span style="--0:#D7DBE0;--1:#403F53">c</span><span style="--0:#D9F5DD;--1:#111111">)</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">=></span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#7FDBCA;--1:#096E72">this</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">stats</span><span style="--0:#D6DEEB;--1:#403F53">(c)), { name: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">blog_post_stats</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> }),</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#7FDBCA;--1:#096E72">...super</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">getUrls</span><span style="--0:#D6DEEB;--1:#403F53">(),</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">]</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">async</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#82AAFF;--1:#3B61B0">stats</span><span style="--0:#D9F5DD;--1:#111111">(</span><span style="--0:#D7DBE0;--1:#403F53">c</span><span style="--0:#7FDBCA;--1:#096E72">:</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--1:#111111"><span style="--0:#FFCB8B">Context</span><span style="--0:#D9F5DD">)</span></span><span style="--0:#D6DEEB;--1:#403F53"> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#82AAFF;--1:#3B61B0">const</span><span style="--0:#C792EA;--1:#8844AE"> </span><span style="--0:#82AAFF;--1:#3B61B0">total</span><span style="--0:#C792EA;--1:#8844AE"> = await </span><span style="--0:#D6DEEB;--1:#403F53">Post</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#FAF39F;--1:#111111">objects</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">count</span><span style="--0:#D6DEEB;--1:#403F53">()</span></div></div><div class="ec-line"><div class="code"><span class="indent"> </span><span style="--0:#C792EA;--1:#8844AE">return</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#7FDBCA;--1:#096E72">this</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#FAF39F;--1:#111111">adminSite</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">renderPage</span><span style="--0:#D6DEEB;--1:#403F53">(c, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Post statistics</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, </span><span style="--1:#8844AE"><span style="--0:#7FDBCA"><</span><span style="--0:#CAECE6">p</span><span style="--0:#7FDBCA">></span></span><span style="--0:#E2817F;--1:#B23834">{</span><span style="--0:#D6DEEB;--1:#403F53">total</span><span style="--0:#E2817F;--1:#B23834">}</span><span style="--0:#D6DEEB;--1:#403F53"> posts</span><span style="--1:#8844AE"><span style="--0:#7FDBCA"></</span><span style="--0:#CAECE6">p</span><span style="--0:#7FDBCA">></span></span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"><span style="--0:#919F9F;--1:#5D6376">// /admin/blog/post/stats/, reverse('admin:blog_post_stats')</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { path } from '@ghuri/core'class PostAdmin extends ModelAdmin<Post> { getUrls() { return [ path('stats/', this.adminSite.adminView((c) => this.stats(c)), { name: 'blog_post_stats' }), ...super.getUrls(), ] } async stats(c: Context) { const total = await Post.objects.count() return this.adminSite.renderPage(c, 'Post statistics', <p>{total} posts</p>) }}// /admin/blog/post/stats/, reverse('admin:blog_post_stats')"><div></div></button></div></figure></div> <p><code dir="auto">adminSite.adminView(view)</code> requires a staff user (others are sent to the login page), checks CSRF on unsafe methods and disables caching. <code dir="auto">adminSite.renderPage(c, title, content)</code> renders inside the admin chrome, <code dir="auto">adminSite.render(c, jsx)</code> renders any page, and <code dir="auto">adminSite.eachContext(c)</code> returns the base template context.</p> <div class="sl-heading-wrapper level-h2"><h2 id="customising-the-site">Customising the site</h2><a class="sl-anchor-link" href="#customising-the-site"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Customising the site”</span></a></div> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { AdminSite } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/admin</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">class</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FFCB8B;--1:#111111">MyAdminSite</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C792EA;--1:#8844AE">extends</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#C5E478;--1:#3B61B0">AdminSite</span><span style="--0:#D6DEEB;--1:#403F53"> {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">siteHeader </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Acme back office</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#919F9F;--1:#5D6376">// <h1> in the header</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">siteTitle </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Acme</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#919F9F;--1:#5D6376">// <title> suffix</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">indexTitle </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Dashboard</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#919F9F;--1:#5D6376">// index page title</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">siteUrl </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">/</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#919F9F;--1:#5D6376">// "View site" link (null hides it)</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">emptyValueDisplay </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">—</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#D6DEEB;--1:#403F53"> </span></span><span style="--0:#D6DEEB;--1:#403F53">enableNavSidebar </span><span style="--0:#C792EA;--1:#8844AE">=</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#FF6A83;--1:#A24848">true</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">}</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">export const </span><span style="--0:#82AAFF;--1:#3B61B0">staffSite</span><span style="--0:#C792EA;--1:#8844AE"> = </span><span style="--0:#7FDBCA;--1:#096E72">new</span><span style="--0:#C792EA;--1:#8844AE"> </span><span style="--0:#82AAFF;--1:#3B61B0">MyAdminSite</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#C792EA;--1:#8844AE">{ name: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">staff</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE"> }</span><span style="--0:#D6DEEB;--1:#403F53">)</span><span style="--0:#C792EA;--1:#8844AE"> </span><span style="--0:#919F9F;--1:#5D6376">// URL namespace</span></div></div><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">staffSite</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">register</span><span style="--0:#D6DEEB;--1:#403F53">(Post, PostAdmin)</span></div></div><div class="ec-line"><div class="code"><span style="--0:#919F9F;--1:#5D6376">// urls.ts: path('staff/', staffSite.urls), then reverse('staff:index')</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { AdminSite } from '@ghuri/admin'class MyAdminSite extends AdminSite { siteHeader = 'Acme back office' // <h1> in the header siteTitle = 'Acme' // <title> suffix indexTitle = 'Dashboard' // index page title siteUrl = '/' // "View site" link (null hides it) emptyValueDisplay = '—' enableNavSidebar = true}export const staffSite = new MyAdminSite({ name: 'staff' }) // URL namespacestaffSite.register(Post, PostAdmin)// urls.ts: path('staff/', staffSite.urls), then reverse('staff:index')"><div></div></button></div></figure></div> <table> <thead> <tr> <th>Attribute</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code dir="auto">name</code></td> <td><code dir="auto">'admin'</code> (the URL namespace)</td> </tr> <tr> <td><code dir="auto">siteHeader</code></td> <td><code dir="auto">'Ghuri administration'</code></td> </tr> <tr> <td><code dir="auto">siteTitle</code></td> <td><code dir="auto">'Ghuri site admin'</code></td> </tr> <tr> <td><code dir="auto">indexTitle</code></td> <td><code dir="auto">'Site administration'</code></td> </tr> <tr> <td><code dir="auto">siteUrl</code></td> <td><code dir="auto">'/'</code></td> </tr> <tr> <td><code dir="auto">emptyValueDisplay</code></td> <td><code dir="auto">'-'</code></td> </tr> <tr> <td><code dir="auto">enableNavSidebar</code></td> <td><code dir="auto">true</code></td> </tr> </tbody> </table> <p>The same keys can be passed to the constructor (<code dir="auto">new AdminSite({ name, siteHeader, ... })</code>), or set on the default site in place: <code dir="auto">admin.site.siteHeader = 'Acme'</code>. Override <code dir="auto">hasPermission(c)</code>, <code dir="auto">getUrls()</code>, <code dir="auto">index(c)</code> and <code dir="auto">getAppList(c)</code> like Django’s. <code dir="auto">@admin.register(Post, { site: staffSite })</code> registers on another site.</p> <div class="sl-heading-wrapper level-h3"><h3 id="assets">Assets</h3><a class="sl-anchor-link" href="#assets"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Assets”</span></a></div> <p><code dir="auto">ADMIN_ASSETS</code> configures the admin’s front-end assets:</p> <div class="expressive-code"><figure class="frame has-title not-content"><figcaption class="header"><span class="title">src/settings.ts</span></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#D6DEEB;--1:#403F53">ADMIN_ASSETS: { htmx: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">/static/htmx.min.js</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, css: [</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">/static/admin-brand.css</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">], js: [] },</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="ADMIN_ASSETS: { htmx: '/static/htmx.min.js', css: ['/static/admin-brand.css'], js: [] },"><div></div></button></div></figure></div> <table> <thead> <tr> <th>Key</th> <th>Default</th> <th></th> </tr> </thead> <tbody> <tr> <td><code dir="auto">htmx</code></td> <td>jsDelivr CDN</td> <td>URL of htmx (used by autocomplete); <code dir="auto">false</code> or <code dir="auto">null</code> disables it</td> </tr> <tr> <td><code dir="auto">css</code></td> <td><code dir="auto">[]</code></td> <td>Extra stylesheets on every admin page</td> </tr> <tr> <td><code dir="auto">js</code></td> <td><code dir="auto">[]</code></td> <td>Extra deferred scripts on every admin page</td> </tr> </tbody> </table> <p>The admin’s own stylesheet and script are served at <code dir="auto"><admin>/static/admin.css</code> and <code dir="auto"><admin>/static/admin.js</code> with long-lived immutable caching (their URLs carry the version).</p> <div class="sl-heading-wrapper level-h2"><h2 id="users-and-groups">Users and groups</h2><a class="sl-anchor-link" href="#users-and-groups"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Users and groups”</span></a></div> <p>When <code dir="auto">auth</code> is installed, <code dir="auto">UserAdmin</code> and <code dir="auto">GroupAdmin</code> are registered on <code dir="auto">admin.site</code>, unless you register your own or <code dir="auto">AUTH_USER_MODEL</code> swaps the user model (then register yours). Like Django’s:</p> <ul> <li>the add form asks for the username and the password twice (password validators apply), stores a hash, then continues to the full form;</li> <li>the change form shows the hash summary (algorithm, iterations, masked salt and hash) and links to <code dir="auto"><id>/password/</code> (<code dir="auto">admin:auth_user_password_change</code>) to set a new password;</li> <li><code dir="auto">groups</code>, <code dir="auto">userPermissions</code> and a group’s <code dir="auto">permissions</code> use the filter widget.</li> </ul> <p><code dir="auto">admin.site.unregister(User); admin.site.register(User, MyUserAdmin)</code> replaces it (subclass <code dir="auto">UserAdmin</code>).</p> <div class="sl-heading-wrapper level-h2"><h2 id="url-names">URL names</h2><a class="sl-anchor-link" href="#url-names"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “URL names”</span></a></div> <p>All live in the site’s namespace (<code dir="auto">admin:</code> for <code dir="auto">admin.site</code>):</p> <table> <thead> <tr> <th>Name</th> <th>URL</th> </tr> </thead> <tbody> <tr> <td><code dir="auto">index</code></td> <td><code dir="auto">/admin/</code></td> </tr> <tr> <td><code dir="auto">login</code>, <code dir="auto">logout</code></td> <td><code dir="auto">login/</code>, <code dir="auto">logout/</code> (POST only)</td> </tr> <tr> <td><code dir="auto">password_change</code>, <code dir="auto">password_change_done</code></td> <td><code dir="auto">password_change/</code>, <code dir="auto">password_change/done/</code></td> </tr> <tr> <td><code dir="auto">app_list</code> (<code dir="auto">app_label</code>)</td> <td><code dir="auto"><app_label>/</code></td> </tr> <tr> <td><code dir="auto"><app>_<model>_changelist</code></td> <td><code dir="auto"><app>/<model>/</code></td> </tr> <tr> <td><code dir="auto"><app>_<model>_add</code></td> <td><code dir="auto"><app>/<model>/add/</code></td> </tr> <tr> <td><code dir="auto"><app>_<model>_change</code> / <code dir="auto">_delete</code> / <code dir="auto">_history</code> (<code dir="auto">object_id</code>)</td> <td><code dir="auto"><app>/<model>/<id>/change/</code>, …</td> </tr> <tr> <td><code dir="auto">auth_user_password_change</code></td> <td><code dir="auto">auth/user/<id>/password/</code></td> </tr> <tr> <td><code dir="auto">autocomplete</code></td> <td><code dir="auto">autocomplete/</code></td> </tr> <tr> <td><code dir="auto">static</code> (<code dir="auto">path</code>)</td> <td><code dir="auto">static/admin.css</code>, <code dir="auto">static/admin.js</code></td> </tr> </tbody> </table> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { quote } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/admin</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#82AAFF;--1:#3B61B0">reverse</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">admin:blog_post_change</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, { object_id: </span><span style="--0:#82AAFF;--1:#3B61B0">quote</span><span style="--0:#D6DEEB;--1:#403F53">(post</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#7FDBCA;--1:#096E72">pk</span><span style="--0:#D6DEEB;--1:#403F53">) })</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { quote } from '@ghuri/admin'reverse('admin:blog_post_change', { object_id: quote(post.pk) })"><div></div></button></div></figure></div> <p>Primary keys in URLs are escaped with Django’s <code dir="auto">quote()</code> / <code dir="auto">unquote()</code>, both exported.</p> <div class="sl-heading-wrapper level-h2"><h2 id="testing">Testing</h2><a class="sl-anchor-link" href="#testing"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Testing”</span></a></div> <div class="expressive-code"><figure class="frame not-content"><figcaption class="header"></figcaption><pre data-language="ts"><code><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">import</span><span style="--0:#D6DEEB;--1:#403F53"> { createTestClient } </span><span style="--0:#C792EA;--1:#8844AE">from</span><span style="--0:#D6DEEB;--1:#403F53"> </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">@ghuri/core/testing</span><span style="--0:#D9F5DD;--1:#111111">'</span></div></div><div class="ec-line"><div class="code"> </div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">const </span><span style="--0:#82AAFF;--1:#3B61B0">client</span><span style="--0:#C792EA;--1:#8844AE"> = </span><span style="--0:#82AAFF;--1:#3B61B0">createTestClient</span><span style="--0:#D6DEEB;--1:#403F53">(app</span><span style="--0:#C792EA;--1:#8844AE">, { </span><span style="--0:#D6DEEB;--1:#403F53">env</span><span style="--0:#C792EA;--1:#8844AE"> }</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">await</span><span style="--0:#D6DEEB;--1:#403F53"> client</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">forceLogin</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#C792EA;--1:#8844AE">await</span><span style="--0:#D6DEEB;--1:#403F53"> User</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#FAF39F;--1:#111111">objects</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">createSuperuser</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">admin</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">a@example.com</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">pw</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#D6DEEB;--1:#403F53">))</span></div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">const </span><span style="--0:#82AAFF;--1:#3B61B0">res</span><span style="--0:#C792EA;--1:#8844AE"> = await </span><span style="--0:#D6DEEB;--1:#403F53">client</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">post</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">/admin/blog/post/add/</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">, {</span></div></div><div class="ec-line"><div class="code"><span class="indent"><span style="--0:#C792EA;--1:#8844AE"> </span></span><span style="--0:#C792EA;--1:#8844AE">form: { title: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">Hi</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">, slug: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">hi</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">comments-TOTAL_FORMS</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">0</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">, </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">comments-INITIAL_FORMS</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE">: </span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#ECC48D;--1:#984E4D">0</span><span style="--0:#D9F5DD;--1:#111111">'</span><span style="--0:#C792EA;--1:#8844AE"> },</span></div></div><div class="ec-line"><div class="code"><span style="--0:#C792EA;--1:#8844AE">}</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div><div class="ec-line"><div class="code"><span style="--0:#82AAFF;--1:#3B61B0">expect</span><span style="--0:#D6DEEB;--1:#403F53">(res</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#7FDBCA;--1:#096E72">status</span><span style="--0:#D6DEEB;--1:#403F53">)</span><span style="--0:#C792EA;--1:#8844AE">.</span><span style="--0:#82AAFF;--1:#3B61B0">toBe</span><span style="--0:#D6DEEB;--1:#403F53">(</span><span style="--0:#F78C6C;--1:#AA0982">302</span><span style="--0:#D6DEEB;--1:#403F53">)</span></div></div></code></pre><div class="copy"><div aria-live="polite"></div><button title="Copy to clipboard" data-copied="Copied!" data-code="import { createTestClient } from '@ghuri/core/testing'const client = createTestClient(app, { env })await client.forceLogin(await User.objects.createSuperuser('admin', 'a@example.com', 'pw'))const res = await client.post('/admin/blog/post/add/', { form: { title: 'Hi', slug: 'hi', 'comments-TOTAL_FORMS': '0', 'comments-INITIAL_FORMS': '0' },})expect(res.status).toBe(302)"><div></div></button></div></figure></div> <div class="sl-heading-wrapper level-h2"><h2 id="differences-from-django">Differences from Django</h2><a class="sl-anchor-link" href="#differences-from-django"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 1 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 0 0-1.42-1.42m8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 1 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 0 0 0 1.42 1 1 0 0 0 1.42 0l3.88-3.89a4.49 4.49 0 0 0 0-6.33M8.83 15.17a1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.92-4.92a1 1 0 1 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42"></path></svg></span><span class="sr-only" data-pagefind-ignore>Section titled “Differences from Django”</span></a></div> <ul> <li>Views are async and receive the Hono context <code dir="auto">c</code> instead of <code dir="auto">request</code>.</li> <li>No <code dir="auto">ModelForm</code> classes: override <code dir="auto">getFormFields()</code>, <code dir="auto">formfieldForDbField()</code> or <code dir="auto">cleanForm()</code>. <code dir="auto">formfieldOverrides</code> is keyed by the field’s <code dir="auto">internalType</code>.</li> <li>Dates and times use native <code dir="auto">date</code>, <code dir="auto">time</code> and <code dir="auto">datetime-local</code> inputs, in UTC; display uses Django’s default formats in <code dir="auto">TIME_ZONE</code>.</li> <li>Templates are JSX components, not overridable template files. Customise through options, hooks, <code dir="auto">ADMIN_ASSETS.css</code> and custom views.</li> <li>No “+” related-object popups, no <code dir="auto">jsi18n</code>, no <code dir="auto">view_on_site</code> redirect view (links go straight to <code dir="auto">getAbsoluteUrl()</code>), no “show facets”, and no <code dir="auto">@</code> full-text search (it is treated as <code dir="auto">icontains</code>).</li> <li>Autocomplete is a search box and select powered by htmx, not Select2.</li> <li>Delete confirmations do not list auto-created many-to-many through rows.</li> <li>Logout is POST-only, as in Django 5.</li> </ul> </div><footer class="sl-flex astro-ddtxxk7k"><div class="meta sl-flex astro-ddtxxk7k"><a href="https://github.com/ghurijs/docs/edit/main/src/content/docs/topics/admin-reference.md" class="sl-flex print:hidden astro-qlekgd3o"><svg aria-hidden="true" class="astro-qlekgd3o astro-hkc32dio" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.2em;"><path d="M22 7.24a1 1 0 0 0-.29-.71l-4.24-4.24a1 1 0 0 0-1.1-.22 1 1 0 0 0-.32.22l-2.83 2.83L2.29 16.05a1 1 0 0 0-.29.71V21a1 1 0 0 0 1 1h4.24a1 1 0 0 0 .76-.29l10.87-10.93L21.71 8c.1-.1.17-.2.22-.33a1 1 0 0 0 0-.24v-.14l.07-.05ZM6.83 20H4v-2.83l9.93-9.93 2.83 2.83L6.83 20ZM18.17 8.66l-2.83-2.83 1.42-1.41 2.82 2.82-1.41 1.42Z"/></svg>Edit page</a><p>Last updated: <time datetime="2026-11-20T17:09:50.000Z">Nov 20, 2026</time></p></div><div class="pagination-links print:hidden astro-b5raizh3" dir="ltr"><a href="/docs/topics/admin/" rel="prev" class="astro-b5raizh3"><svg aria-hidden="true" class="astro-b5raizh3 astro-hkc32dio" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg><span class="astro-b5raizh3">Previous<br class="astro-b5raizh3"><span class="link-title astro-b5raizh3">The admin</span></span></a><a href="/docs/topics/rest/" rel="next" class="astro-b5raizh3"><svg aria-hidden="true" class="astro-b5raizh3 astro-hkc32dio" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17.92 11.62a1.001 1.001 0 0 0-.21-.33l-5-5a1.003 1.003 0 1 0-1.42 1.42l3.3 3.29H7a1 1 0 0 0 0 2h7.59l-3.3 3.29a1.002 1.002 0 0 0 .325 1.639 1 1 0 0 0 1.095-.219l5-5a1 1 0 0 0 .21-.33 1 1 0 0 0 0-.76Z"/></svg><span class="astro-b5raizh3">Next<br class="astro-b5raizh3"><span class="link-title astro-b5raizh3">REST framework</span></span></a></div></footer></div></div></main></div></div></div></div></body></html>