135 lines
3.7 KiB
JavaScript
135 lines
3.7 KiB
JavaScript
|
|
import EditorField from './editor-field.js';
|
|
|
|
class Editor
|
|
{
|
|
#alias;
|
|
#prefix;
|
|
|
|
/**
|
|
* Overrides the string generation for the label
|
|
*/
|
|
templateLabel = field => this.#prefix + field;
|
|
/**
|
|
* Overrides the string generation for the description
|
|
*/
|
|
templateDescription = field => this.#prefix + field + '_text';
|
|
|
|
tabs = [];
|
|
fields = [];
|
|
|
|
|
|
constructor(alias, prefix)
|
|
{
|
|
this.#alias = alias;
|
|
this.#prefix = prefix || '';
|
|
}
|
|
|
|
|
|
get alias()
|
|
{
|
|
return this.#alias;
|
|
}
|
|
|
|
|
|
/**
|
|
* A tab within an editor
|
|
* @typedef {object} EditorTab
|
|
* @param {string} alias - Alias for the tab
|
|
* @param {string} name - Name of the tab (can be a translation)
|
|
* @param {number|function} [count] - Output a count indicator
|
|
* @param {boolean|function} [disabled] - Conditionally disable the tab and its content
|
|
*/
|
|
|
|
/**
|
|
* Add a new tab to the editor
|
|
* @param {string} alias - Alias for the tab
|
|
* @param {string} name - Name of the tab (can be a translation)
|
|
* @param {number|function} [count] - Output a count indicator
|
|
* @param {boolean|function} [disabled] - Conditionally disable the tab and its content
|
|
* @returns {EditorTab}
|
|
*/
|
|
tab(alias, name, count, disabled)
|
|
{
|
|
if (typeof disabled !== 'undefined' && typeof disabled !== 'boolean' && typeof disabled !== 'function')
|
|
{
|
|
console.warn(`[zero] editor.tab: the disabled property has to be of type [boolean, function, undefined]`);
|
|
return;
|
|
}
|
|
|
|
if (typeof count !== 'undefined' && typeof count !== 'number' && typeof count !== 'function')
|
|
{
|
|
console.warn(`[zero] editor.tab: the count property has to be of type [number, function, undefined]`);
|
|
return;
|
|
}
|
|
|
|
if (this.tabs.find(x => x.alias === alias))
|
|
{
|
|
console.warn(`[zero] the editor ${this.#alias} does already have a tab with the alias ${alias}`);
|
|
return;
|
|
}
|
|
|
|
const tab = this._createTab(alias, name, disabled, count);
|
|
this.tabs.push(tab);
|
|
|
|
return tab;
|
|
}
|
|
|
|
|
|
/**
|
|
* Add a new tab to the editor
|
|
* @param {string} path - Model path
|
|
* @param {object} [options] - Custom options
|
|
* @param {string} [options.label] - A custom label for this field (otherwise it's generated via `onLabelCreate`)
|
|
* @param {string} [options.hideLabel] - Hide the field label and make the content full-width
|
|
* @param {string} [options.description] - A custom description for this field (otherwise it's generated via `onDescriptionCreate`)
|
|
* @param {string} [options.helpText] - Display a help text below the field
|
|
* @param {boolean|function} [options.condition] - Conditionally hide the field
|
|
* @param {boolean|function} [options.disabled=false] - Conditionally disable the field
|
|
* @param {string|object} [options.tab] - Add this field to a tab (by passing the alias or the tab instance)
|
|
* @param {string} [options.class] - Append HTML class to the generated property
|
|
* @returns {EditorField}
|
|
*/
|
|
field(path, options)
|
|
{
|
|
const field = new EditorField(path, options);
|
|
this.fields.push(field);
|
|
return field;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get fields for the specified tab
|
|
* @param {string|EditorTab} [tab] - Pass the tab or its alias
|
|
* @returns {EditorField[]}
|
|
*/
|
|
getFields(tab)
|
|
{
|
|
const alias = typeof tab === 'undefined' ? null : (typeof tab === 'string' ? tab : tab.alias);
|
|
return this.fields.filter(x => !alias ? true : x.options.tab === alias);
|
|
}
|
|
|
|
|
|
/**
|
|
* Create a new tab instance
|
|
* @returns {EditorTab}
|
|
*/
|
|
_createTab(alias, name, disabled, count)
|
|
{
|
|
return {
|
|
alias,
|
|
name,
|
|
disabled,
|
|
count,
|
|
field: (path, options) =>
|
|
{
|
|
options = options || {};
|
|
options.tab = alias;
|
|
return this.field(path, options);
|
|
}
|
|
};
|
|
}
|
|
|
|
};
|
|
|
|
export default Editor; |