Convert gr-editable-content to TypeScript

Change-Id: I7f234744d892a61d6853a629da07c70cbf1ab266
This commit is contained in:
Ben Rohlfs
2020-08-07 16:48:42 +02:00
parent 79d105b078
commit f5620e90c9

View File

@@ -14,26 +14,40 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea.js'; import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
import '../../../styles/shared-styles.js'; import '../../../styles/shared-styles';
import '../gr-storage/gr-storage.js'; import '../gr-storage/gr-storage';
import '../gr-button/gr-button.js'; import '../gr-button/gr-button';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners.js'; import {GrStorage} from '../gr-storage/gr-storage';
import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin.js'; import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners';
import {PolymerElement} from '@polymer/polymer/polymer-element.js'; import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin';
import {htmlTemplate} from './gr-editable-content_html.js'; import {PolymerElement} from '@polymer/polymer/polymer-element';
import {customElement, property} from '@polymer/decorators/lib/decorators';
import {htmlTemplate} from './gr-editable-content_html';
const RESTORED_MESSAGE = 'Content restored from a previous edit.'; const RESTORED_MESSAGE = 'Content restored from a previous edit.';
const STORAGE_DEBOUNCE_INTERVAL_MS = 400; const STORAGE_DEBOUNCE_INTERVAL_MS = 400;
/** declare global {
* @extends PolymerElement interface HTMLElementTagNameMap {
*/ 'gr-editable-content': GrEditableContent;
class GrEditableContent extends GestureEventListeners( }
LegacyElementMixin(PolymerElement)) { }
static get template() { return htmlTemplate; }
export interface GrEditableContent {
$: {
storage: GrStorage;
};
}
@customElement('gr-editable-content')
export class GrEditableContent extends GestureEventListeners(
LegacyElementMixin(PolymerElement)
) {
static get template() {
return htmlTemplate;
}
static get is() { return 'gr-editable-content'; }
/** /**
* Fired when the save button is pressed. * Fired when the save button is pressed.
* *
@@ -52,39 +66,32 @@ class GrEditableContent extends GestureEventListeners(
* @event show-alert * @event show-alert
*/ */
static get properties() { @property({type: String, notify: true, observer: '_contentChanged'})
return { content?: string;
content: {
notify: true,
type: String,
observer: '_contentChanged',
},
disabled: {
reflectToAttribute: true,
type: Boolean,
value: false,
},
editing: {
observer: '_editingChanged',
type: Boolean,
value: false,
},
removeZeroWidthSpace: Boolean,
// If no storage key is provided, content is not stored.
storageKey: String,
_saveDisabled: {
computed: '_computeSaveDisabled(disabled, content, _newContent)',
type: Boolean,
value: true,
},
_newContent: {
type: String,
observer: '_newContentChanged',
},
};
}
_contentChanged(content) { @property({type: Boolean, reflectToAttribute: true})
disabled = false;
@property({type: Boolean, observer: '_editingChanged'})
editing = false;
@property({type: Boolean})
removeZeroWidthSpace?: boolean;
// If no storage key is provided, content is not stored.
@property({type: String})
storageKey?: string;
@property({
type: Boolean,
computed: '_computeSaveDisabled(disabled, content, _newContent)',
})
_saveDisabled!: boolean;
@property({type: String, observer: '_newContentChanged'})
_newContent?: string;
_contentChanged() {
/* A changed content means that either a different change has been loaded /* A changed content means that either a different change has been loaded
* or new content was saved. Either way, let's reset the component. * or new content was saved. Either way, let's reset the component.
*/ */
@@ -93,27 +100,32 @@ class GrEditableContent extends GestureEventListeners(
} }
focusTextarea() { focusTextarea() {
this.shadowRoot.querySelector('iron-autogrow-textarea').textarea.focus(); this.shadowRoot!.querySelector('iron-autogrow-textarea')!.textarea.focus();
} }
_newContentChanged(newContent, oldContent) { _newContentChanged(newContent: string) {
if (!this.storageKey) { return; } if (!this.storageKey) return;
const storageKey = this.storageKey;
this.debounce('store', () => { this.debounce(
'store',
() => {
if (newContent.length) { if (newContent.length) {
this.$.storage.setEditableContentItem(this.storageKey, newContent); this.$.storage.setEditableContentItem(storageKey, newContent);
} else { } else {
// This does not really happen, because we don't clear newContent // This does not really happen, because we don't clear newContent
// after saving (see below). So this only occurs when the user clears // after saving (see below). So this only occurs when the user clears
// all the content in the editable textarea. But <gr-storage> cleans // all the content in the editable textarea. But <gr-storage> cleans
// up itself after one day, so we are not so concerned about leaving // up itself after one day, so we are not so concerned about leaving
// some garbage behind. // some garbage behind.
this.$.storage.eraseEditableContentItem(this.storageKey); this.$.storage.eraseEditableContentItem(storageKey);
} }
}, STORAGE_DEBOUNCE_INTERVAL_MS); },
STORAGE_DEBOUNCE_INTERVAL_MS
);
} }
_editingChanged(editing) { _editingChanged(editing: boolean) {
// This method is for initializing _newContent when you start editing. // This method is for initializing _newContent when you start editing.
// Restoring content from local storage is not perfect and has // Restoring content from local storage is not perfect and has
// some issues: // some issues:
@@ -128,21 +140,22 @@ class GrEditableContent extends GestureEventListeners(
// content from local storage when you enter editing mode for the first // content from local storage when you enter editing mode for the first
// time. Otherwise it is better to just keep the last editing state from // time. Otherwise it is better to just keep the last editing state from
// the same session. // the same session.
if (!editing || this._newContent) { if (!editing || this._newContent) return;
return;
}
let content; let content;
if (this.storageKey) { if (this.storageKey) {
const storedContent = const storedContent = this.$.storage.getEditableContentItem(
this.$.storage.getEditableContentItem(this.storageKey); this.storageKey
);
if (storedContent && storedContent.message) { if (storedContent && storedContent.message) {
content = storedContent.message; content = storedContent.message;
this.dispatchEvent(new CustomEvent('show-alert', { this.dispatchEvent(
new CustomEvent('show-alert', {
detail: {message: RESTORED_MESSAGE}, detail: {message: RESTORED_MESSAGE},
bubbles: true, bubbles: true,
composed: true, composed: true,
})); })
);
} }
} }
if (!content) { if (!content) {
@@ -150,33 +163,41 @@ class GrEditableContent extends GestureEventListeners(
} }
// TODO(wyatta) switch linkify sequence, see issue 5526. // TODO(wyatta) switch linkify sequence, see issue 5526.
this._newContent = this.removeZeroWidthSpace ? this._newContent = this.removeZeroWidthSpace
content.replace(/^R=\u200B/gm, 'R=') : ? content.replace(/^R=\u200B/gm, 'R=')
content; : content;
} }
_computeSaveDisabled(disabled, content, newContent) { _computeSaveDisabled(
disabled?: boolean,
content?: string,
newContent?: string
): boolean {
return disabled || !newContent || content === newContent; return disabled || !newContent || content === newContent;
} }
_handleSave(e) { _handleSave(e: Event) {
e.preventDefault(); e.preventDefault();
this.dispatchEvent(new CustomEvent('editable-content-save', { this.dispatchEvent(
new CustomEvent('editable-content-save', {
detail: {content: this._newContent}, detail: {content: this._newContent},
composed: true, bubbles: true, composed: true,
})); bubbles: true,
})
);
// It would be nice, if we would set this._newContent = undefined here, // It would be nice, if we would set this._newContent = undefined here,
// but we can only do that when we are sure that the save operation has // but we can only do that when we are sure that the save operation has
// succeeded. // succeeded.
} }
_handleCancel(e) { _handleCancel(e: Event) {
e.preventDefault(); e.preventDefault();
this.editing = false; this.editing = false;
this.dispatchEvent(new CustomEvent('editable-content-cancel', { this.dispatchEvent(
composed: true, bubbles: true, new CustomEvent('editable-content-cancel', {
})); composed: true,
bubbles: true,
})
);
} }
} }
customElements.define(GrEditableContent.is, GrEditableContent);