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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
<template>
<NcSettingsSection
class="declarative-settings-section"
:name="t(formApp, form.title)"
:description="t(formApp, form.description)"
:doc-url="form.doc_url || ''">
<div v-for="formField in formFields"
:key="formField.id"
class="declarative-form-field"
:aria-label="t('settings', '{app}\'s declarative setting field: {name}', { app: formApp, name: t(formApp, formField.title) })"
:class="{
'declarative-form-field-text': isTextFormField(formField),
'declarative-form-field-select': formField.type === 'select',
'declarative-form-field-multi-select': formField.type === 'multi-select',
'declarative-form-field-checkbox': formField.type === 'checkbox',
'declarative-form-field-multi_checkbox': formField.type === 'multi-checkbox',
'declarative-form-field-radio': formField.type === 'radio'
}">
<template v-if="isTextFormField(formField)">
<div class="input-wrapper">
<NcInputField
:type="formField.type"
:label="t(formApp, formField.title)"
:value.sync="formFieldsData[formField.id].value"
:placeholder="t(formApp, formField.placeholder)"
@update:value="onChangeDebounced(formField)"
@submit="updateDeclarativeSettingsValue(formField)"/>
</div>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
<template v-if="formField.type === 'select'">
<label :for="formField.id + '_field'">{{ t(formApp, formField.title) }}</label>
<div class="input-wrapper">
<NcSelect
:id="formField.id + '_field'"
:options="formField.options"
:placeholder="t(formApp, formField.placeholder)"
:label-outside="true"
:value="formFieldsData[formField.id].value"
@input="(value) => updateFormFieldDataValue(value, formField, true)"/>
</div>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
<template v-if="formField.type === 'multi-select'">
<label :for="formField.id + '_field'">{{ t(formApp, formField.title) }}</label>
<div class="input-wrapper">
<NcSelect
:id="formField.id + '_field'"
:options="formField.options"
:placeholder="t(formApp, formField.placeholder)"
:multiple="true"
:label-outside="true"
:value="formFieldsData[formField.id].value"
@input="(value) => {
formFieldsData[formField.id].value = value
updateDeclarativeSettingsValue(formField, JSON.stringify(formFieldsData[formField.id].value))
}
"/>
</div>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
<template v-if="formField.type === 'checkbox'">
<label :for="formField.id + '_field'">{{ t(formApp, formField.title) }}</label>
<NcCheckboxRadioSwitch
:id="formField.id + '_field'"
:checked="Boolean(formFieldsData[formField.id].value)"
@update:checked="(value) => {
formField.value = value
updateFormFieldDataValue(+value, formField, true)
}
">
{{ t(formApp, formField.label) }}
</NcCheckboxRadioSwitch>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
<template v-if="formField.type === 'multi-checkbox'">
<label :for="formField.id + '_field'">{{ t(formApp, formField.title) }}</label>
<NcCheckboxRadioSwitch
v-for="option in formField.options"
:id="formField.id + '_field_' + option.value"
:key="option.value"
:checked="formFieldsData[formField.id].value[option.value]"
@update:checked="(value) => {
formFieldsData[formField.id].value[option.value] = value
// Update without re-generating initial formFieldsData.value object as the link to components are lost
updateDeclarativeSettingsValue(formField, JSON.stringify(formFieldsData[formField.id].value))
}
">
{{ t(formApp, option.name) }}
</NcCheckboxRadioSwitch>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
<template v-if="formField.type === 'radio'">
<label :for="formField.id + '_field'">{{ t(formApp, formField.title) }}</label>
<NcCheckboxRadioSwitch
v-for="option in formField.options"
:key="option.value"
:value="option.value"
type="radio"
:checked="formFieldsData[formField.id].value"
@update:checked="(value) => updateFormFieldDataValue(value, formField, true)">
{{ t(formApp, option.name) }}
</NcCheckboxRadioSwitch>
<span class="hint">{{ t(formApp, formField.description) }}</span>
</template>
</div>
</NcSettingsSection>
</template>
<script>
import axios from '@nextcloud/axios'
import { generateOcsUrl } from '@nextcloud/router'
import { showError } from '@nextcloud/dialogs'
import debounce from 'debounce'
import NcSettingsSection from '@nextcloud/vue/dist/Components/NcSettingsSection.js'
import NcInputField from '@nextcloud/vue/dist/Components/NcInputField.js'
import NcSelect from '@nextcloud/vue/dist/Components/NcSelect.js'
import NcCheckboxRadioSwitch from '@nextcloud/vue/dist/Components/NcCheckboxRadioSwitch.js'
export default {
name: 'DeclarativeSection',
components: {
NcSettingsSection,
NcInputField,
NcSelect,
NcCheckboxRadioSwitch,
},
props: {
form: {
type: Object,
required: true,
},
},
data() {
return {
formFieldsData: {},
}
},
beforeMount() {
this.initFormFieldsData()
},
computed: {
formApp() {
return this.form.app || ''
},
formFields() {
return this.form.fields || []
},
},
methods: {
initFormFieldsData() {
this.form.fields.forEach((formField) => {
if (formField.type === 'checkbox') {
// convert bool to number using unary plus (+) operator
this.$set(formField, 'value', +formField.value)
}
if (formField.type === 'multi-checkbox') {
if (formField.value === '') {
// Init formFieldsData from options
this.$set(formField, 'value', {})
formField.options.forEach(option => {
this.$set(formField.value, option.value, false)
})
} else {
this.$set(formField, 'value', JSON.parse(formField.value))
// Merge possible new options
formField.options.forEach(option => {
if (!formField.value.hasOwnProperty(option.value)) {
this.$set(formField.value, option.value, false)
}
})
// Remove options that are not in the form anymore
Object.keys(formField.value).forEach(key => {
if (!formField.options.find(option => option.value === key)) {
delete formField.value[key]
}
})
}
}
if (formField.type === 'multi-select') {
if (formField.value === '') {
// Init empty array for multi-select
this.$set(formField, 'value', [])
} else {
// JSON decode an array of multiple values set
this.$set(formField, 'value', JSON.parse(formField.value))
}
}
this.$set(this.formFieldsData, formField.id, {
value: formField.value,
})
})
},
updateFormFieldDataValue(value, formField, update = false) {
this.formFieldsData[formField.id].value = value
if (update) {
this.updateDeclarativeSettingsValue(formField)
}
},
updateDeclarativeSettingsValue(formField, value = null) {
try {
return axios.post(generateOcsUrl('settings/api/declarative/value'), {
app: this.formApp,
formId: this.form.id.replace(this.formApp + '_', ''), // Remove app prefix to send clean form id
fieldId: formField.id,
value: value === null ? this.formFieldsData[formField.id].value : value,
});
} catch (err) {
console.debug(err)
showError(t('settings', 'Failed to save setting'))
}
},
onChangeDebounced: debounce(function(formField) {
this.updateDeclarativeSettingsValue(formField)
}, 1000),
isTextFormField(formField) {
return ['text', 'password', 'email', 'tel', 'url', 'number'].includes(formField.type)
},
},
}
</script>
<style lang="scss" scoped>
.declarative-form-field {
margin: 20px 0;
padding: 10px 0;
.input-wrapper {
width: 100%;
max-width: 400px;
}
&:last-child {
border-bottom: none;
}
.hint {
display: inline-block;
color: var(--color-text-maxcontrast);
margin-left: 8px;
padding-top: 5px;
}
&-radio, &-multi_checkbox {
max-height: 250px;
overflow-y: auto;
}
&-multi-select, &-select {
display: flex;
flex-direction: column;
label {
margin-bottom: 5px;
}
}
}
</style>
|
