-
Notifications
You must be signed in to change notification settings - Fork 2
/
columns.json
212 lines (212 loc) · 6.84 KB
/
columns.json
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
{
"title": "JSON schema for OctoberCMS list",
"$schema": "http://json-schema.org/draft-07/schema",
"$comment": "https://octobercms.com/docs/backend/lists#list-columns",
"type": "object",
"definitions": {
"columns": {
"type": "object",
"patternProperties": {
"^[^\\s]*$": {
"description": "Model field name",
"$comment": "https://octobercms.com/docs/backend/lists#column-options",
"type": [
"object",
"string"
],
"properties": {
"label": {
"description": "a name when displaying the list column to the user",
"type": "string"
},
"type": {
"description": "defines how this column should be rendered",
"default": "text",
"anyOf": [
{
"type": "string",
"enum": [
"text",
"number",
"switch",
"datetime",
"date",
"time",
"timesince",
"timetense",
"partial",
"colorpicker"
]
},
{
"type": "string"
}
]
},
"default": {
"description": "specifies the default value for the column if value is empty"
},
"searchable": {
"description": "include this column in the list search results",
"type": "boolean",
"default": false
},
"invisible": {
"description": "specifies if this column is hidden by default",
"type": "boolean",
"default": false
},
"sortable": {
"description": "specifies if this column can be sorted",
"type": "boolean",
"default": true
},
"clickable": {
"description": "if set to false, disables the default click behavior when the column is clicked",
"type": "boolean",
"default": true
},
"select": {
"description": "defines a custom SQL select statement to use for the value",
"type": "string"
},
"valueFrom": {
"description": "defines a model attribute to use for the value",
"type": "string"
},
"relation": {
"description": "defines a model relationship column",
"type": "string"
},
"useRelationCount": {
"description": "use the count of the defined relation as the value for this column",
"type": "boolean",
"default": false
},
"cssClass": {
"description": "assigns a CSS class to the column container",
"type": "string"
},
"headCssClass": {
"description": "assigns a CSS class to the column header container",
"type": "string"
},
"width": {
"description": "sets the column width, can be specified in percents (10%) or pixels (50px). There could be a single column without width specified, it will be stretched to take the available space.",
"type": "string"
},
"align": {
"description": "specifies the column alignment. Possible values are left, right and center.",
"type": "string",
"enum": [
"left",
"right",
"center"
]
},
"permissions": {
"description": "the permissions that the current backend user must have in order for the column to be used. Supports either a string for a single permission or an array of permissions of which only one is needed to grant access.",
"type": [
"string",
"array"
]
}
},
"anyOf": [
{
"if": {
"properties": {
"type": {
"enum": [
"text",
"number"
]
}
}
},
"then": {
"properties": {
"format": {
"description": "specify a custom text format following the formatting rules of the PHP sprintf() function",
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"enum": [
"datetime",
"date",
"time",
"timesince",
"timetense"
]
}
}
},
"then": {
"properties": {
"ignoreTimezone": {
"description": "display datetime exactly as it is stored, ignores October's and the backend user's specified timezones",
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"type": {
"enum": [
"datetime",
"date",
"time"
]
}
}
},
"then": {
"properties": {
"format": {
"description": "specify a custom date format",
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"enum": [
"partial"
]
}
}
},
"then": {
"properties": {
"path": {
"description": "partial view. Inside the partial these variables are available: $value is the default cell value, $record is the model used for the cell and $column is the configured class object Backend\\Classes\\ListColumn",
"type": "string",
"examples": [
"~/plugins/acme/blog/models/comments/_content_column.htm"
]
}
}
}
}
]
}
}
}
},
"properties": {
"columns": {
"$ref": "#/definitions/columns"
}
}
}