blob: 32812dd8156cdadb32f72f732473692402bfaf66 [file] [log] [blame]
/**
* @license
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '@polymer/iron-input/iron-input';
import '@polymer/paper-toggle-button/paper-toggle-button';
import {formStyles} from '../../../styles/gr-form-styles';
import {sharedStyles} from '../../../styles/shared-styles';
import {subpageStyles} from '../../../styles/gr-subpage-styles';
import '../../shared/gr-icons/gr-icons';
import '../../shared/gr-select/gr-select';
import '../../shared/gr-tooltip-content/gr-tooltip-content';
import '../gr-plugin-config-array-editor/gr-plugin-config-array-editor';
import {LitElement, css, html} from 'lit';
import {customElement, property} from 'lit/decorators';
import {ConfigParameterInfoType} from '../../../constants/constants';
import {
ConfigParameterInfo,
PluginParameterToConfigParameterInfoMap,
} from '../../../types/common';
import {PaperToggleButtonElement} from '@polymer/paper-toggle-button/paper-toggle-button';
import {IronInputElement} from '@polymer/iron-input/iron-input';
import {
PluginConfigOptionsChangedEventDetail,
PluginOption,
} from './gr-repo-plugin-config-types';
const PLUGIN_CONFIG_CHANGED_EVENT_NAME = 'plugin-config-changed';
export interface ConfigChangeInfo {
_key: string; // parameterName of PluginParameterToConfigParameterInfoMap
info: ConfigParameterInfo;
notifyPath: string;
}
export interface PluginData {
name: string; // parameterName of PluginParameterToConfigParameterInfoMap
config: PluginParameterToConfigParameterInfoMap;
}
export interface PluginConfigChangeDetail {
name: string; // parameterName of PluginParameterToConfigParameterInfoMap
config: PluginParameterToConfigParameterInfoMap;
notifyPath: string;
}
@customElement('gr-repo-plugin-config')
export class GrRepoPluginConfig extends LitElement {
/**
* Fired when the plugin config changes.
*
* @event plugin-config-changed
*/
@property({type: Object})
pluginData?: PluginData;
static override get styles() {
return [
sharedStyles,
formStyles,
subpageStyles,
css`
.inherited {
color: var(--deemphasized-text-color);
margin-left: var(--spacing-m);
}
section.section:not(.ARRAY) .title {
align-items: center;
display: flex;
}
section.section.ARRAY .title {
padding-top: var(--spacing-m);
}
`,
];
}
override render() {
// Render can be called prior to pluginData being updated.
const pluginConfigOptions = this.pluginData
? this._computePluginConfigOptions(this.pluginData)
: [];
return html`
<div class="gr-form-styles">
<fieldset>
<h4>${this.pluginData?.name || ''}</h4>
${pluginConfigOptions.map(option => this.renderOption(option))}
</fieldset>
</div>
`;
}
private renderInherited(option: PluginOption) {
if (option.info.inherited_value) {
return html`
<span class="inherited">
(Inherited: ${option.info.inherited_value})
</span>
`;
} else {
return html``;
}
}
private renderOption(option: PluginOption) {
return html`
<section class="section ${option.info.type}">
<span class="title"> ${this.renderOptionTitle(option)} </span>
<span class="value">
${this.renderOptionDetail(option)} ${this.renderInherited(option)}
</span>
</section>
`;
}
private renderOptionTitle(option: PluginOption) {
const titleName = html`<span>${option.info.display_name}</span>`;
if (!option.info.description) return titleName;
return html` <gr-tooltip-content
has-tooltip
show-icon
title="${option.info.description}"
>
${titleName}
</gr-tooltip-content>`;
}
private renderOptionDetail(option: PluginOption) {
if (option.info.type === ConfigParameterInfoType.ARRAY) {
return html`
<gr-plugin-config-array-editor
@plugin-config-option-changed=${this._handleArrayChange}
.pluginOption="${option}"
></gr-plugin-config-array-editor>
`;
} else if (option.info.type === ConfigParameterInfoType.BOOLEAN) {
return html`
<paper-toggle-button
?checked=${this._computeChecked(option.info.value)}
@change=${this._handleBooleanChange}
data-option-key=${option._key}
?disabled=${!option.info.editable}
@click=${this._onTapPluginBoolean}
></paper-toggle-button>
`;
} else if (option.info.type === ConfigParameterInfoType.LIST) {
return html`
<gr-select
.bindValue=${option.info.value}
@change=${this._handleListChange}
>
<select
data-option-key=${option._key}
?disabled=${!option.info.editable}
>
${(option.info.permitted_values || []).map(
value => html`<option value="${value}">${value}</option>`
)}
</select>
</gr-select>
`;
} else if (
option.info.type === ConfigParameterInfoType.STRING ||
option.info.type === ConfigParameterInfoType.INT ||
option.info.type === ConfigParameterInfoType.LONG
) {
return html`
<iron-input
@input=${this._handleStringChange}
data-option-key="${option._key}"
>
<input
is="iron-input"
.value="${option.info.value ?? ''}"
@input=${this._handleStringChange}
data-option-key="${option._key}"
?disabled=${!option.info.editable}
/>
</iron-input>
`;
} else {
return html``;
}
}
_computePluginConfigOptions(pluginData: PluginData) {
const config = pluginData.config;
return Object.keys(config).map(_key => {
return {_key, info: config[_key]};
});
}
_computeChecked(value = 'false') {
return JSON.parse(value) as boolean;
}
_handleStringChange(e: Event) {
const el = e.target as IronInputElement;
// In the template, the data-option-key is assigned to each editor
const _key = el.getAttribute('data-option-key')!;
const configChangeInfo = this._buildConfigChangeInfo(el.value, _key);
this._handleChange(configChangeInfo);
}
_handleListChange(e: Event) {
const el = e.target as HTMLOptionElement;
// In the template, the data-option-key is assigned to each editor
const _key = el.getAttribute('data-option-key')!;
const configChangeInfo = this._buildConfigChangeInfo(el.value, _key);
this._handleChange(configChangeInfo);
}
_handleBooleanChange(e: Event) {
const el = e.target as PaperToggleButtonElement;
// In the template, the data-option-key is assigned to each editor
const _key = el.getAttribute('data-option-key')!;
const configChangeInfo = this._buildConfigChangeInfo(
JSON.stringify(el.checked),
_key
);
this._handleChange(configChangeInfo);
}
_buildConfigChangeInfo(
value: string | null | undefined,
_key: string
): ConfigChangeInfo {
// If pluginData is not set, editors are not created and this method
// can't be called
const info = this.pluginData!.config[_key];
info.value = value !== null ? value : undefined;
return {
_key,
info,
notifyPath: `${_key}.value`,
};
}
_handleArrayChange(e: CustomEvent<PluginConfigOptionsChangedEventDetail>) {
this._handleChange(e.detail);
}
_handleChange({_key, info, notifyPath}: ConfigChangeInfo) {
// If pluginData is not set, editors are not created and this method
// can't be called
const {name, config} = this.pluginData!;
/** @type {Object} */
const detail: PluginConfigChangeDetail = {
name,
config: {...config, [_key]: info},
notifyPath: `${name}.${notifyPath}`,
};
this.dispatchEvent(
new CustomEvent(PLUGIN_CONFIG_CHANGED_EVENT_NAME, {
detail,
bubbles: true,
composed: true,
})
);
}
/**
* Work around a issue on iOS when clicking turns into double tap
*/
_onTapPluginBoolean(e: Event) {
e.preventDefault();
}
}
declare global {
interface HTMLElementTagNameMap {
'gr-repo-plugin-config': GrRepoPluginConfig;
}
}