From e20dd01710a93c7e784f5e7ff04fa6591cc81d5d Mon Sep 17 00:00:00 2001 From: Patrick Jentsch Date: Mon, 9 Oct 2023 14:21:31 +0200 Subject: [PATCH] Better auto initialization method for forms and resource displays --- .../js/forms/create-contribution-form.js | 7 +----- .../js/forms/create-corpus-file-form.js | 7 +----- app/static/js/forms/create-job-form.js | 7 +----- app/static/js/forms/index.js | 13 ++++++++--- .../js/resource-displays/corpus-display.js | 2 ++ app/static/js/resource-displays/index.js | 22 +++++++++++++++++++ .../js/resource-displays/job-display.js | 2 ++ app/templates/_scripts.html.j2 | 1 + app/templates/corpora/corpus.html.j2 | 4 +--- app/templates/jobs/job.html.j2 | 3 +-- 10 files changed, 42 insertions(+), 26 deletions(-) diff --git a/app/static/js/forms/create-contribution-form.js b/app/static/js/forms/create-contribution-form.js index 68003796..4474ff89 100644 --- a/app/static/js/forms/create-contribution-form.js +++ b/app/static/js/forms/create-contribution-form.js @@ -1,10 +1,5 @@ Forms.CreateContributionForm = class CreateContributionForm extends Forms.BaseForm { - static autoInit() { - let createContributionFormElements = document.querySelectorAll('.create-contribution-form'); - for (let createContributionFormElement of createContributionFormElements) { - new Forms.CreateContributionForm(createContributionFormElement); - } - } + static htmlClass = 'create-contribution-form'; constructor(formElement) { super(formElement); diff --git a/app/static/js/forms/create-corpus-file-form.js b/app/static/js/forms/create-corpus-file-form.js index 6cbc8a3a..beec4ee2 100644 --- a/app/static/js/forms/create-corpus-file-form.js +++ b/app/static/js/forms/create-corpus-file-form.js @@ -1,10 +1,5 @@ Forms.CreateCorpusFileForm = class CreateCorpusFileForm extends Forms.BaseForm { - static autoInit() { - let createCorpusFileFormElements = document.querySelectorAll('.create-corpus-file-form'); - for (let createCorpusFileFormElement of createCorpusFileFormElements) { - new Forms.CreateCorpusFileForm(createCorpusFileFormElement); - } - } + static htmlClass = 'create-corpus-file-form'; constructor(formElement) { super(formElement); diff --git a/app/static/js/forms/create-job-form.js b/app/static/js/forms/create-job-form.js index 0ee64e3a..6e6c7c01 100644 --- a/app/static/js/forms/create-job-form.js +++ b/app/static/js/forms/create-job-form.js @@ -1,10 +1,5 @@ Forms.CreateJobForm = class CreateJobForm extends Forms.BaseForm { - static autoInit() { - let createJobFormElements = document.querySelectorAll('.create-job-form'); - for (let createJobFormElement of createJobFormElements) { - new Forms.CreateJobForm(createJobFormElement); - } - } + static htmlClass = 'create-job-form'; constructor(formElement) { super(formElement); diff --git a/app/static/js/forms/index.js b/app/static/js/forms/index.js index b3bd9224..0e7529f6 100644 --- a/app/static/js/forms/index.js +++ b/app/static/js/forms/index.js @@ -3,15 +3,22 @@ var Forms = {}; Forms.autoInit = () => { for (let propertyName in Forms) { let property = Forms[propertyName]; - // Call the autoInit method of all properties that are subclasses of Forms.BaseForm + // Call autoInit of all properties that are subclasses of Forms.BaseForm. + // This does not include Forms.BaseForm itself. if (property.prototype instanceof Forms.BaseForm) { - property.autoInit(); + // Check if the static htmlClass property is defined. + if (property.htmlClass === undefined) {return;} + // Gather all HTML elements that have the `this.htmlClass` class + // and do not have the no-autoinit class. + let formElements = document.querySelectorAll(`.${property.htmlClass}:not(.no-autoinit)`); + // Create an instance of this class for each form element. + for (let formElement of formElements) {new property(formElement);} } } }; Forms.BaseForm = class BaseForm { - static autoInit() {throw 'Not implemented';} + static htmlClass; constructor(formElement) { this.formElement = formElement; diff --git a/app/static/js/resource-displays/corpus-display.js b/app/static/js/resource-displays/corpus-display.js index f68977c7..906b17ac 100644 --- a/app/static/js/resource-displays/corpus-display.js +++ b/app/static/js/resource-displays/corpus-display.js @@ -1,4 +1,6 @@ ResourceDisplays.CorpusDisplay = class CorpusDisplay extends ResourceDisplays.BaseDisplay { + static htmlClass = 'corpus-display'; + constructor(displayElement) { super(displayElement); this.corpusId = displayElement.dataset.corpusId; diff --git a/app/static/js/resource-displays/index.js b/app/static/js/resource-displays/index.js index 75c68987..4f52860a 100644 --- a/app/static/js/resource-displays/index.js +++ b/app/static/js/resource-displays/index.js @@ -1,6 +1,28 @@ var ResourceDisplays = {}; +ResourceDisplays.autoInit = () => { + console.log('ResourceDisplays.autoInit'); + for (let propertyName in ResourceDisplays) { + let property = ResourceDisplays[propertyName]; + // Call autoInit of all properties that are subclasses of `ResourceDisplays.BaseDisplay`. + // This does not include `ResourceDisplays.BaseDisplay` itself. + if (property.prototype instanceof ResourceDisplays.BaseDisplay) { + console.log(property); + // Check if the static `htmlClass` property is defined. + if (property.htmlClass === undefined) {return;} + // Gather all HTML elements that have the `this.htmlClass` class + // and do not have the `no-autoinit` class. + let displayElements = document.querySelectorAll(`.${property.htmlClass}:not(.no-autoinit)`); + console.log(displayElements); + // Create an instance of this class for each display element. + for (let displayElement of displayElements) {new property(displayElement);} + } + } +} + ResourceDisplays.BaseDisplay = class BaseDisplay { + static htmlClass; + constructor(displayElement) { this.displayElement = displayElement; this.userId = this.displayElement.dataset.userId; diff --git a/app/static/js/resource-displays/job-display.js b/app/static/js/resource-displays/job-display.js index d52f0b0e..4ab370e2 100644 --- a/app/static/js/resource-displays/job-display.js +++ b/app/static/js/resource-displays/job-display.js @@ -1,4 +1,6 @@ ResourceDisplays.JobDisplay = class JobDisplay extends ResourceDisplays.BaseDisplay { + static htmlClass = 'job-display'; + constructor(displayElement) { super(displayElement); this.jobId = this.displayElement.dataset.jobId; diff --git a/app/templates/_scripts.html.j2 b/app/templates/_scripts.html.j2 index de457973..6213e3df 100644 --- a/app/templates/_scripts.html.j2 +++ b/app/templates/_scripts.html.j2 @@ -140,6 +140,7 @@ document.querySelectorAll('#nav-more-dropdown-trigger'), {alignment: 'right', constrainWidth: false, coverTrigger: false} ); + ResourceDisplays.autoInit(); ResourceList.autoInit(); Forms.autoInit(); diff --git a/app/templates/corpora/corpus.html.j2 b/app/templates/corpora/corpus.html.j2 index 7539f420..b6e600b9 100644 --- a/app/templates/corpora/corpus.html.j2 +++ b/app/templates/corpora/corpus.html.j2 @@ -5,7 +5,7 @@ {% block page_content %}
-
+

{{ corpus.title }}

@@ -237,8 +237,6 @@ {% block scripts %} {{ super() }}