aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files/src/models/Setting.js
blob: 1db1d818e6916734123b65f22bc71beffe4a0de6 (plain)
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
/**
 * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

export default class Setting {

	_close
	_el
	_name
	_open
	_order

	/**
	 * Create a new files app setting
	 *
	 * @since 19.0.0
	 * @param {string} name the name of this setting
	 * @param {object} component the component
	 * @param {Function} component.el function that returns an unmounted dom element to be added
	 * @param {Function} [component.open] callback for when setting is added
	 * @param {Function} [component.close] callback for when setting is closed
	 * @param {number} [component.order] the order of this setting, lower numbers are shown first
	 */
	constructor(name, { el, open, close, order }) {
		this._name = name
		this._el = el
		this._open = open
		this._close = close
		this._order = order || 0

		if (typeof this._open !== 'function') {
			this._open = () => {}
		}

		if (typeof this._close !== 'function') {
			this._close = () => {}
		}

		if (typeof this._el !== 'function') {
			throw new Error('Setting must have an `el` function that returns a DOM element')
		}

		if (typeof this._name !== 'string') {
			throw new Error('Setting must have a `name` string')
		}

		if (typeof this._order !== 'number') {
			throw new Error('Setting must have an `order` number')
		}
	}

	get name() {
		return this._name
	}

	get el() {
		return this._el
	}

	get open() {
		return this._open
	}

	get close() {
		return this._close
	}

	get order() {
		return this._order
	}

}