Documentation
¶
Overview ¶
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
Index ¶
- func AllowListEdit(ctx context.Context) bool
- func AllowListRowSelect(ctx context.Context) bool
- func ExportCSV[T attrs.Definer](w http.ResponseWriter, r *http.Request, m *ListExportMixin[T], ...) error
- func ExportJSON[T attrs.Definer](w http.ResponseWriter, r *http.Request, m *ListExportMixin[T], ...) error
- func ExportText[T attrs.Definer](w http.ResponseWriter, r *http.Request, m *ListExportMixin[T], ...) error
- func PageFromContext[T any](ctx context.Context) pagination.PageObject[T]
- func PaginatorFromContext[T attrs.Definer](ctx context.Context) pagination.Pagination[T]
- func RenameColumn[T attrs.Definer](column ListColumn[T], fieldName string) *renamedColumn[T]
- func SetAllowListEdit(ctx context.Context, allow bool) context.Context
- func SetAllowListRowSelect(ctx context.Context, allow bool) context.Context
- type BoundBoolFunc
- type BoundView
- func (v *BoundView[T]) GetContext(r *http.Request, qs *queries.QuerySet[T], context ctx.Context) (ctx.Context, error)
- func (v *BoundView[T]) GetList(r *http.Request, pageObject pagination.PageObject[T], columns []ListColumn[T], ...) (list StringRenderer, err error)
- func (v *BoundView[T]) GetPaginator(req *http.Request, qs *queries.QuerySet[T]) (pagination.Pagination[T], pagination.PageObject[T], error)
- func (v *BoundView[T]) GetQuerySet(r *http.Request) (*queries.QuerySet[T], error)
- func (v *BoundView[T]) Mixins() []views.View
- func (v *BoundView[T]) ServeXXX(w http.ResponseWriter, req *http.Request)
- type ColumnGroup
- type EditableColumnConfig
- type Export
- type ExportColumn
- type FieldExportColumn
- type List
- type ListColumn
- func BooleanColumnFunc[T attrs.Definer](header func(ctx context.Context) string, ...) ListColumn[T]
- func BooleanFieldColumn[T attrs.Definer](header func(ctx context.Context) string, fieldName string) ListColumn[T]
- func ChangeColumnType[T1, T2 attrs.Definer](col ListColumn[T2], args ...any) ListColumn[T1]
- func Column[T attrs.Definer](header func(ctx context.Context) string, getter any) ListColumn[T]
- func DateTimeColumnFunc[T attrs.Definer](fmt string, header func(ctx context.Context) string, ...) ListColumn[T]
- func DateTimeFieldColumn[T attrs.Definer](fmt string, header func(ctx context.Context) string, fieldName string) ListColumn[T]
- func EditableColumn[T attrs.Definer](header func(ctx context.Context) string, config EditableColumnConfig) ListColumn[T]
- func FieldCheckbox[T attrs.Definer](header func(ctx context.Context) string, fieldName string, ...) ListColumn[T]
- func FieldColumn[T attrs.Definer](header func(ctx context.Context) string, fieldName string) ListColumn[T]
- func FuncColumn[T attrs.Definer](header func(ctx context.Context) string, ...) ListColumn[T]
- func HTMLColumn[T attrs.Definer](header func(ctx context.Context) string, ...) ListColumn[T]
- func HTMLFieldColumn[T attrs.Definer](header func(ctx context.Context) string, fieldName string) ListColumn[T]
- func LinkColumn[T attrs.Definer](header func(ctx context.Context) string, fieldName string, ...) ListColumn[T]
- func ProcessableFieldColumn[T attrs.Definer, VAL any](header func(ctx context.Context) string, fieldName string, ...) ListColumn[T]
- func RowSelectColumn[T attrs.Definer](formName string, isChecked BoundBoolFunc[T], ...) ListColumn[T]
- func TitleFieldColumn[T attrs.Definer](wraps ListColumn[T], ...) ListColumn[T]
- type ListColumnGroup
- func (c *ListColumnGroup[T]) AddColumn(column ListColumn[T])
- func (c *ListColumnGroup[T]) Component(r *http.Request, form *ListForm[T]) templ.Component
- func (c *ListColumnGroup[T]) Form(r *http.Request, opts ...func(forms.Form)) forms.Form
- func (c *ListColumnGroup[T]) GetAttrs(r *http.Request, definitions attrs.Definitions, instance T) map[string]any
- func (c *ListColumnGroup[T]) RenderColumns(r *http.Request, form *ListForm[T]) templ.Component
- func (c *ListColumnGroup[T]) Row() T
- type ListEditableColumn
- type ListExportMixin
- type ListForm
- func (lf *ListForm[T]) BoundErrors() *orderedmap.OrderedMap[string, []error]
- func (lf *ListForm[T]) CleanedData() map[any]map[string]any
- func (lf *ListForm[T]) Errors() []error
- func (lf *ListForm[T]) ForInstance(instance T) forms.Form
- func (lf *ListForm[T]) Forms() map[any]forms.Form
- func (lf *ListForm[T]) IsValid() bool
- type ListMediaColumn
- type ListObjectMixin
- func (m *ListObjectMixin[T]) GetContext(r *http.Request, view views.View, qs *queries.QuerySet[T], viewCtx ctx.Context) (ctx.Context, error)
- func (m *ListObjectMixin[T]) Hijack(w http.ResponseWriter, r *http.Request, view views.View, ...) (http.ResponseWriter, *http.Request, error)
- func (m *ListObjectMixin[T]) ServeXXX(w http.ResponseWriter, r *http.Request)
- type StringRenderer
- type View
- func (v *View[T]) Bind(w http.ResponseWriter, req *http.Request) (views.View, error)
- func (v *View[T]) Clone() *View[T]
- func (v *View[T]) GetContext(r *http.Request, qs *queries.QuerySet[T]) (ctx.Context, error)
- func (v *View[T]) GetListColumns(r *http.Request) ([]ListColumn[T], error)
- func (v *View[T]) GetPaginator(req *http.Request, qs *queries.QuerySet[T]) (pagination.Pagination[T], pagination.PageObject[T], error)
- func (v *View[T]) GetQuerySet(r *http.Request) (*queries.QuerySet[T], error)
- func (v *View[T]) GetTemplate(req *http.Request) string
- func (v *View[T]) Methods() []string
- func (v *View[T]) Render(w http.ResponseWriter, req *http.Request, templateName string, ...) error
- func (v *View[T]) ServeXXX(w http.ResponseWriter, req *http.Request)
- func (v *View[T]) TakeControl(w http.ResponseWriter, r *http.Request, view views.View)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AllowListEdit ¶ added in v1.7.2
func AllowListRowSelect ¶ added in v1.7.2
func ExportJSON ¶ added in v1.7.2
func ExportText ¶ added in v1.7.2
func PageFromContext ¶ added in v1.7.2
func PageFromContext[T any](ctx context.Context) pagination.PageObject[T]
func PaginatorFromContext ¶ added in v1.7.2
func PaginatorFromContext[T attrs.Definer](ctx context.Context) pagination.Pagination[T]
func RenameColumn ¶ added in v1.7.2
func RenameColumn[T attrs.Definer](column ListColumn[T], fieldName string) *renamedColumn[T]
func SetAllowListEdit ¶ added in v1.7.2
Types ¶
type BoundBoolFunc ¶ added in v1.7.2
type BoundView ¶ added in v1.7.2
type BoundView[T attrs.Definer] struct { View *View[T] Bases []views.View W http.ResponseWriter R *http.Request Context ctx.Context QuerySet *queries.QuerySet[T] Pagination pagination.Pagination[T] PageObject pagination.PageObject[T] Page int Amount int }
func NewBoundView ¶ added in v1.7.2
func (*BoundView[T]) GetContext ¶ added in v1.7.2
func (*BoundView[T]) GetList ¶ added in v1.7.2
func (v *BoundView[T]) GetList(r *http.Request, pageObject pagination.PageObject[T], columns []ListColumn[T], context ctx.Context) (list StringRenderer, err error)
func (*BoundView[T]) GetPaginator ¶ added in v1.7.2
func (v *BoundView[T]) GetPaginator(req *http.Request, qs *queries.QuerySet[T]) (pagination.Pagination[T], pagination.PageObject[T], error)
func (*BoundView[T]) GetQuerySet ¶ added in v1.7.2
type ColumnGroup ¶
type EditableColumnConfig ¶ added in v1.7.2
type ExportColumn ¶ added in v1.7.2
type FieldExportColumn ¶ added in v1.7.2
type FieldExportColumn[T attrs.Definer] struct { FieldName string HasPermission func(r *http.Request) bool Header func(c context.Context) string }
func (*FieldExportColumn[T]) ExportHeader ¶ added in v1.7.2
func (c *FieldExportColumn[T]) ExportHeader(r *http.Request) string
func (*FieldExportColumn[T]) ExportValue ¶ added in v1.7.2
func (c *FieldExportColumn[T]) ExportValue(r *http.Request, obj T) (interface{}, error)
func (*FieldExportColumn[T]) FieldNames ¶ added in v1.7.2
func (c *FieldExportColumn[T]) FieldNames() []string
func (*FieldExportColumn[T]) IsExportable ¶ added in v1.7.2
func (c *FieldExportColumn[T]) IsExportable(r *http.Request) bool
type List ¶
type List[T attrs.Definer] struct { Model T Columns []ListColumn[T] HideHeadings bool // contains filtered or unexported fields }
func NewListWithGroups ¶ added in v1.7.2
func NewListWithGroups[T attrs.Definer](r *http.Request, modelObj T, list []T, columns []ListColumn[T], newGroup func(r *http.Request, obj T, cols []ListColumn[T]) ColumnGroup[T]) *List[T]
type ListColumn ¶
type ListColumn[T attrs.Definer] interface { Header(r *http.Request) templ.Component FieldName() string Component(r *http.Request, defs attrs.Definitions, row T) templ.Component Attributes(r *http.Request, defs attrs.Definitions, row T, colIndex, colCount int) map[string]any }
func BooleanColumnFunc ¶ added in v1.7.2
func BooleanFieldColumn ¶ added in v1.7.2
func ChangeColumnType ¶ added in v1.7.2
func ChangeColumnType[T1, T2 attrs.Definer](col ListColumn[T2], args ...any) ListColumn[T1]
func DateTimeColumnFunc ¶ added in v1.7.2
func DateTimeFieldColumn ¶ added in v1.7.2
func EditableColumn ¶ added in v1.7.2
func EditableColumn[T attrs.Definer](header func(ctx context.Context) string, config EditableColumnConfig) ListColumn[T]
func FieldCheckbox ¶ added in v1.7.2
func FieldCheckbox[T attrs.Definer](header func(ctx context.Context) string, fieldName string, hasPermission BoundBoolFunc[T]) ListColumn[T]
func FieldColumn ¶
func FuncColumn ¶
func FuncColumn[T attrs.Definer](header func(ctx context.Context) string, data func(r *http.Request, defs attrs.Definitions, row T) interface{}) ListColumn[T]
func HTMLColumn ¶
func HTMLFieldColumn ¶ added in v1.7.2
func LinkColumn ¶
func ProcessableFieldColumn ¶ added in v1.7.2
func RowSelectColumn ¶ added in v1.7.2
func RowSelectColumn[T attrs.Definer](formName string, isChecked BoundBoolFunc[T], hasPermission func(r *http.Request) bool, wraps ListColumn[T], hdrAttrs, attrs map[string]any) ListColumn[T]
func TitleFieldColumn ¶
func TitleFieldColumn[T attrs.Definer](wraps ListColumn[T], getURL func(r *http.Request, defs attrs.Definitions, row T) string) ListColumn[T]
type ListColumnGroup ¶ added in v1.7.2
type ListColumnGroup[T attrs.Definer] struct { Definitions attrs.Definitions Columns []ListColumn[T] Instance T Attrs func(r *http.Request, definitions attrs.Definitions, instance T) map[string]any }
func NewColumnGroup ¶ added in v1.7.2
func NewColumnGroup[T attrs.Definer](r *http.Request, instance T, columns []ListColumn[T]) *ListColumnGroup[T]
func (*ListColumnGroup[T]) AddColumn ¶ added in v1.7.2
func (c *ListColumnGroup[T]) AddColumn(column ListColumn[T])
func (*ListColumnGroup[T]) GetAttrs ¶ added in v1.7.2
func (c *ListColumnGroup[T]) GetAttrs(r *http.Request, definitions attrs.Definitions, instance T) map[string]any
func (*ListColumnGroup[T]) RenderColumns ¶ added in v1.7.2
func (*ListColumnGroup[T]) Row ¶ added in v1.7.2
func (c *ListColumnGroup[T]) Row() T
type ListEditableColumn ¶ added in v1.7.2
type ListExportMixin ¶ added in v1.7.2
type ListExportMixin[T attrs.Definer] struct { Model T Columns []ExportColumn[T] GetFileName func(r *http.Request) string ChangeQuerySet func(r *http.Request, qs *queries.QuerySet[T]) (*queries.QuerySet[T], error) Export func(w http.ResponseWriter, r *http.Request, m *ListExportMixin[T], qs *queries.QuerySet[T], export *Export) error }
func (*ListExportMixin[T]) ServeXXX ¶ added in v1.7.2
func (m *ListExportMixin[T]) ServeXXX(w http.ResponseWriter, r *http.Request)
type ListForm ¶ added in v1.7.2
func NewListForm ¶ added in v1.7.2
func (*ListForm[T]) BoundErrors ¶ added in v1.7.2
func (lf *ListForm[T]) BoundErrors() *orderedmap.OrderedMap[string, []error]
func (*ListForm[T]) CleanedData ¶ added in v1.7.2
func (*ListForm[T]) ForInstance ¶ added in v1.7.2
type ListMediaColumn ¶ added in v1.7.2
type ListMediaColumn interface {
Media(defs attrs.StaticDefinitions) media.Media
}
type ListObjectMixin ¶ added in v1.7.2
type ListObjectMixin[T attrs.Definer] struct { ListView *View[T] List StringRenderer FormOptions []func(forms.Form) }
func (*ListObjectMixin[T]) GetContext ¶ added in v1.7.2
func (*ListObjectMixin[T]) ServeXXX ¶ added in v1.7.2
func (m *ListObjectMixin[T]) ServeXXX(w http.ResponseWriter, r *http.Request)
type StringRenderer ¶ added in v1.7.2
type StringRenderer interface {
Render() string
}
type View ¶
type View[T attrs.Definer] struct { Model T AllowedMethods []string BaseTemplateKey string TemplateName string AmountParam string PageParam string MaxAmount int DefaultAmount int ListColumns []ListColumn[T] Mixins func(r *http.Request, v *View[T]) []views.View TitleFieldColumn func(col ListColumn[T]) ListColumn[T] GetContextFn func(r *http.Request, qs *queries.QuerySet[T]) (ctx.Context, error) ChangeContextFn func(r *http.Request, qs *queries.QuerySet[T], ctx ctx.Context) (ctx.Context, error) List func(*http.Request, pagination.PageObject[T], []ListColumn[T], ctx.Context) (StringRenderer, error) QuerySet func(r *http.Request) *queries.QuerySet[T] OnError func(w http.ResponseWriter, r *http.Request, err error) }
func (*View[T]) GetContext ¶
func (*View[T]) GetListColumns ¶ added in v1.7.2
func (v *View[T]) GetListColumns(r *http.Request) ([]ListColumn[T], error)
func (*View[T]) GetPaginator ¶ added in v1.7.2
func (v *View[T]) GetPaginator(req *http.Request, qs *queries.QuerySet[T]) (pagination.Pagination[T], pagination.PageObject[T], error)
func (*View[T]) GetQuerySet ¶ added in v1.7.2
func (*View[T]) GetTemplate ¶ added in v1.7.2
func (*View[T]) ServeXXX ¶ added in v1.7.2
func (v *View[T]) ServeXXX(w http.ResponseWriter, req *http.Request)
func (*View[T]) TakeControl ¶ added in v1.7.2
Click to show internal directories.
Click to hide internal directories.