Add missing getTextLabel implementation for BaseDateTimeWidget, so th…

…e value is displayed if it is available instead of a JavaScript 'null'. (wagtail#12162) Fixes wagtail#12094
helenb · Jul 31, 2024 · 0dc233b · 0dc233b
1 parent aadad14
commit 0dc233b
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -5,6 +5,7 @@ Changelog
 ~~~~~~~~~~~~~~~~
 
  * Redirect to the last viewed listing page after deleting form submissions (Matthias Brück)
+ * Provide `getTextLabel` method on date / time StreamField blocks (Vaughn Dickson)
  * Docs: Upgrade Sphinx to 7.3 (Matt Westcott)
  * Maintenance: Removed support for Python 3.8 (Matt Westcott)
  * Maintenance: Drop pytz dependency in favour of `zoneinfo.available_timezones` (Sage Abdullah)

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -827,6 +827,7 @@
 * Romein van Buren
 * Chris Shenton
 * Nathanaël Jourdane
+* Vaughn Dickson
 
 ## Translators
 

diff --git a/client/src/entrypoints/admin/telepath/widgets.js b/client/src/entrypoints/admin/telepath/widgets.js
@@ -510,6 +510,9 @@ class BaseDateTimeWidget extends Widget {
         if (opts && opts.soft) return;
         element.focus();
       },
+      getTextLabel() {
+        return this.getValue() || '';
+      },
       idForLabel: id,
     };
     widget.setState(initialState);

diff --git a/client/src/entrypoints/admin/telepath/widgets.test.js b/client/src/entrypoints/admin/telepath/widgets.test.js
@@ -809,4 +809,8 @@ describe('telepath: wagtail.widgets.DateTimeInput', () => {
     boundWidget.focus();
     expect(document.activeElement).toBe(document.querySelector('input'));
   });
+
+  test('getTextLabel() returns the text of entered value', () => {
+    expect(boundWidget.getTextLabel()).toBe('2021-01-19 11:59');
+  });
 });
diff --git a/docs/releases/6.3.md b/docs/releases/6.3.md
@@ -14,6 +14,7 @@ depth: 1
 ### Other features
 
  * Redirect to the last viewed listing page after deleting form submissions (Matthias Brück)
+ * Provide `getTextLabel` method on date / time StreamField blocks (Vaughn Dickson)
 
 ### Bug fixes