123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 |
- <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>
|