feat: added i18n translation to postMessage fields (#244)

Author: bflorian

docs/classes/_pages_decimal_setting_d_.decimalsetting.md

@@ -153,7 +153,9 @@ ___
 ▸ **postMessage**(`value`: string): *[DecimalSetting](_pages_decimal_setting_d_.decimalsetting.md)*
 
 A string to be shown after the text input field. One common use for this field is to
-specify a unit of measure.
+specify a unit of measure. Omitting the value and calling `postMessage()` will set the
+value to the default i18n string, allowing translations to be defines in the locale
+file in the usual way.
 
 **Parameters:**
 

docs/classes/_pages_number_setting_d_.numbersetting.md

@@ -161,7 +161,9 @@ ___
 ▸ **postMessage**(`value`: string): *[NumberSetting](_pages_number_setting_d_.numbersetting.md)*
 
 A string to be shown after the text input field. One common use for this field is to
-specify a unit of measure.
+specify a unit of measure. Omitting the value and calling `postMessage()` will set the
+value to the default i18n string, allowing translations to be defines in the locale
+file in the usual way.
 
 **Parameters:**
 
@@ -195,7 +197,7 @@ ___
 
 ▸ **step**(`value`: number): *[NumberSetting](_pages_number_setting_d_.numbersetting.md)*
 
-The step between values values. If the style is not set to slider then setting a step will
+The step between values. If the style is not set to slider then setting a step will
 cause up and down arrows to appear next to the input box that increment or decrement the value
 by the value of the step.
 

lib/pages/decimal-setting.d.ts

@@ -32,8 +32,10 @@ export class DecimalSetting extends SectionSetting<DecimalSetting> {
 
 	/**
 	* A string to be shown after the text input field. One common use for this field is to
-	* specify a unit of measure.
+	* specify a unit of measure. Omitting the value and calling `postMessage()` will set the
+	* value to the default i18n string, allowing translations to be defines in the locale
+	* file in the usual way.
 	* @param value Max length 10 characters
 	*/
-	postMessage(value: string): DecimalSetting
+	postMessage(value?: string): DecimalSetting
 }

lib/pages/decimal-setting.js

@@ -7,7 +7,6 @@ module.exports = class DecimalSetting extends SectionSetting {
 		super(section, id)
 		this._type = 'DECIMAL'
 		this._description = 'Tap to set'
-		this._postMessage = this.i18nKey('postMessage')
 	}
 
 	max(value) {
@@ -26,7 +25,12 @@ module.exports = class DecimalSetting extends SectionSetting {
 	}
 
 	postMessage(value) {
-		this._postMessage = value
+		if (value === undefined) {
+			this._postMessage = this.i18nKey('postMessage')
+		} else {
+			this._postMessage = value
+		}
+
 		return this
 	}
 
@@ -45,7 +49,7 @@ module.exports = class DecimalSetting extends SectionSetting {
 		}
 
 		if (this._postMessage) {
-			result.postMessage = this._postMessage
+			result.postMessage = this.translate(this._postMessage)
 		}
 
 		return result

lib/pages/number-setting.d.ts

@@ -42,13 +42,15 @@ export class NumberSetting extends SectionSetting<NumberSetting> {
 
 	/**
 	* A string to be shown after the text input field. One common use for this field is to
-	* specify a unit of measure.
+	* specify a unit of measure. Omitting the value and calling `postMessage()` will set the
+	* value to the default i18n string, allowing translations to be defines in the locale
+	* file in the usual way.
 	* @param value Max length 10 characters
 	*/
-	postMessage(value: string): NumberSetting
+	postMessage(value?: string): NumberSetting
 
 	/**
-	* The step between values values. If the style is not set to slider then setting a step will
+	* The step between values. If the style is not set to slider then setting a step will
 	* cause up and down arrows to appear next to the input box that increment or decrement the value
 	* by the value of the step.
 	*/

lib/pages/number-setting.js

@@ -73,7 +73,12 @@ module.exports = class NumberSetting extends SectionSetting {
 	 * @returns {NumberSetting} Number Setting instance
 	 */
 	postMessage(value) {
-		this._postMessage = value
+		if (value === undefined) {
+			this._postMessage = this.i18nKey('postMessage')
+		} else {
+			this._postMessage = value
+		}
+
 		return this
 	}
 
@@ -100,7 +105,7 @@ module.exports = class NumberSetting extends SectionSetting {
 		}
 
 		if (this._postMessage) {
-			result.postMessage = this._postMessage
+			result.postMessage = this.translate(this._postMessage)
 		}
 
 		return result