axum-admin 0.1.1

A modern admin dashboard framework for Axum
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use serde::Serialize;
use std::collections::HashMap;

/// A sidebar navigation entry — either a standalone entity link or a named
/// group containing child entity links.
#[derive(Serialize)]
#[serde(tag = "type", rename_all = "lowercase")]
pub enum NavItem {
    Entity(EntityRef),
    Group {
        label: String,
        entities: Vec<EntityRef>,
        /// true when any child entity is currently active — used to auto-open the accordion
        active: bool,
    },
}

#[derive(Serialize)]
pub struct EntityRef {
    pub name: String,
    pub label: String,
    pub icon: String,
    pub group: Option<String>,
}

#[derive(Serialize)]
pub struct FieldContext {
    pub name: String,
    pub label: String,
    pub field_type: String,
    pub readonly: bool,
    pub hidden: bool,
    pub list_only: bool,
    pub form_only: bool,
    pub required: bool,
    pub help_text: Option<String>,
    pub options: Vec<(String, String)>,
    /// Populated for ManyToMany fields: the IDs currently selected for this record.
    pub selected_ids: Vec<String>,
    /// Populated for File fields: the accepted MIME types (e.g. ["application/pdf"]).
    pub accept: Vec<String>,
}

#[derive(Serialize)]
pub struct RowContext {
    pub id: String,
    pub data: HashMap<String, String>,
}

#[derive(Serialize)]
pub struct ActionContext {
    pub name: String,
    pub label: String,
    pub target: String,
    pub confirm: Option<String>,
    pub icon: Option<String>,
    pub class: Option<String>,
}

#[derive(Serialize)]
pub struct ListContext {
    pub admin_title: String,
    pub admin_icon: String,
    pub entities: Vec<EntityRef>,
    pub nav: Vec<NavItem>,
    pub current_entity: String,
    pub entity_name: String,
    pub entity_label: String,
    pub columns: Vec<String>,
    pub column_types: HashMap<String, String>,
    pub rows: Vec<RowContext>,
    pub actions: Vec<ActionContext>,
    pub search: String,
    pub page: u64,
    pub total_pages: u64,
    pub order_by: String,
    pub order_dir: String,
    pub filter_fields: Vec<FieldContext>,
    pub active_filters: HashMap<String, String>,
    pub bulk_delete: bool,
    pub bulk_export: bool,
    pub export_columns: Vec<(String, String)>,  // (name, label)
    pub flash_success: Option<String>,
    pub flash_error: Option<String>,
    pub can_create: bool,
    pub can_edit: bool,
    pub can_delete: bool,
    pub show_auth_nav: bool,
}

#[derive(Serialize)]
pub struct FormContext {
    pub admin_title: String,
    pub admin_icon: String,
    pub entities: Vec<EntityRef>,
    pub nav: Vec<NavItem>,
    pub current_entity: String,
    pub entity_name: String,
    pub entity_label: String,
    pub fields: Vec<FieldContext>,
    pub values: HashMap<String, String>,
    pub errors: HashMap<String, String>,
    pub is_create: bool,
    pub record_id: String,
    pub csrf_token: String,
    pub flash_success: Option<String>,
    pub flash_error: Option<String>,
    pub can_save: bool,
    pub show_auth_nav: bool,
}

#[derive(Serialize)]
pub struct LoginContext {
    pub admin_title: String,
    pub error: Option<String>,
    pub csrf_token: String,
    pub next: Option<String>,
}

#[derive(Serialize)]
pub struct FlashContext {
    pub success: Option<String>,
    pub error: Option<String>,
}