All files / ext.wikilambda.edit/components/function/editor FunctionEditorDescription.vue

92.5% Statements 37/40
90% Branches 9/10
92.3% Functions 12/13
92.5% Lines 37/40

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204    18x 18x 18x 18x 18x 18x                       23x                         93x               93x                 93x                   23x               23x               23x               23x                                         5x 5x 2x 1x       1x                   3x 3x       3x               5x       23x 23x       18x   18x     18x 18x 18x     18x     18x 18x     18x       97x 97x                       18x                                                    
<!--
	WikiLambda Vue component for setting the description of a ZFunction in the Function editor.
 
	@copyright 2020– Abstract Wikipedia team; see AUTHORS.txt
	@license MIT
-->
<template>
	<div class="ext-wikilambda-function-definition-description">
		<div class="ext-wikilambda-function-block__label">
			<label :for="descriptionInputId">
				{{ descriptionLabel }}
				<span>{{ descriptionOptional }}</span>
			</label>
		</div>
		<div class="ext-wikilambda-function-block__body">
			<cdx-text-area
				:id="descriptionInputId"
				:model-value="description"
				class="ext-wikilambda-function-definition-description__input"
				:aria-label="descriptionLabel"
				:placeholder="descriptionInputPlaceholder"
				:max-chars="maxDescriptionChars"
				@input="updateRemainingChars"
				@change="persistDescription"
			></cdx-text-area>
			<div class="ext-wikilambda-function-definition-description__counter">
				{{ remainingChars }}
			</div>
		</div>
	</div>
</template>
 
<script>
const { defineComponent } = require( 'vue' );
const Constants = require( '../../../Constants.js' ),
	mapGetters = require( 'vuex' ).mapGetters,
	mapActions = require( 'vuex' ).mapActions,
	CdxTextArea = require( '@wikimedia/codex' ).CdxTextArea;
 
module.exports = exports = defineComponent( {
	name: 'wl-function-editor-description',
	components: {
		'cdx-text-area': CdxTextArea
	},
	props: {
		zLanguage: {
			type: String,
			required: true
		}
	},
	data: function () {
		return {
			maxDescriptionChars: Constants.LABEL_CHARS_MAX,
			remainingChars: Constants.LABEL_CHARS_MAX
		};
	},
	computed: Object.assign( mapGetters( [
		'getRowByKeyPath',
		'getZMonolingualTextValue',
		'getZPersistentDescription'
	] ), {
		/**
		 * Returns the Short Description (Z2K5) row for the
		 * appropriate language
		 *
		 * @return {Object|undefined}
		 */
		descriptionObject: function () {
			return this.zLanguage ?
				this.getZPersistentDescription( this.zLanguage ) :
				undefined;
		},
		/**
		 * Returns true if the current zObject has a description object
		 *
		 * @return {boolean}
		 */
		hasDescription: function () {
			return this.descriptionObject !== undefined;
		},
		/**
		 * Returns the description value for the given language.
		 * If value is not available, returns empty string
		 *
		 * @return {string}
		 */
		description: function () {
			return this.hasDescription ?
				this.getZMonolingualTextValue( this.descriptionObject.rowId ) :
				'';
		},
		/**
		 * Returns the label for the description field
		 *
		 * @return {string}
		 */
		descriptionLabel: function () {
			// TODO (T335583): Replace i18n message with key label
			// return this.getLabel( Constants.Z_PERSISTENTOBJECT_DESCRIPTION );
			return this.$i18n( 'wikilambda-function-definition-description-label' ).text();
		},
		/**
		 * Returns the i18n message for the description field placeholder
		 *
		 * @return {string}
		 */
		descriptionInputPlaceholder: function () {
			return this.$i18n( 'wikilambda-function-definition-description-placeholder' ).text();
		},
		/**
		 * Returns the "optional" caption for the description field
		 *
		 * @return {string}
		 */
		descriptionOptional: function () {
			return this.$i18n( 'parentheses', [ this.$i18n( 'wikilambda-optional' ).text() ] ).text();
		},
		/**
		 * Returns the id for the input field
		 *
		 * @return {string}
		 */
		descriIptionInputId: function () {
			return `ext-wikilambda-function-definition-description__input${ this.zLanguage }`;
		}
	} ),
	methods: Object.assign( mapActions( [
		'changeType',
		'removeItemFromTypedList',
		'setValueByRowIdAndPath'
	] ), {
		/**
		 * Updates the remainingChars data property as the user types into the Z2K5 field
		 *
		 * @param {Event} event - the event object that is automatically passed in on input
		 */
		updateRemainingChars: function ( event ) {
			const { length } = event.target.value;
			this.remainingChars = this.maxDescriptionChars - length;
		},
		/**
		 * Persist the new name value in the globally stored object
		 *
		 * @param {Object} event
		 */
		persistDescription: function ( event ) {
			const value = event.target.value;
			if ( this.hasDescription ) {
				if ( value === '' ) {
					this.removeItemFromTypedList( { rowId: this.descriptionObject.rowId } );
				} else {
					this.setValueByRowIdAndPath( {
						rowId: this.descriptionObject.rowId,
						keyPath: [
							Constants.Z_MONOLINGUALSTRING_VALUE,
							Constants.Z_STRING_VALUE
						],
						value
					} );
				}
			} else {
				// If this.descriptionObject is undefined, there's no monolingual string
				// for the given language, so we create a new monolingual string
				// with the new value and append to the parent list.
				const parentRow = this.getRowByKeyPath( [
					Constants.Z_PERSISTENTOBJECT_DESCRIPTION,
					Constants.Z_MULTILINGUALSTRING_VALUE
				] );
				if ( !parentRow ) {
					// This should never happen because all Z2Kn's are initialized
					return;
				}
				this.changeType( {
					id: parentRow.id,
					type: Constants.Z_MONOLINGUALSTRING,
					lang: this.zLanguage,
					value,
					append: true
				} );
			}
			this.$emit( 'updated-description' );
		}
	} ),
	mounted: function () {
		this.$nextTick( function () {
			this.remainingChars = this.maxDescriptionChars - this.description.length;
		} );
	}
} );
</script>
 
<style lang="less">
@import '../../../ext.wikilambda.edit.variables.less';
 
.ext-wikilambda-function-definition-description {
	&__counter {
		color: @color-subtle;
		margin-left: @spacing-50;
		align-self: center;
		float: right;
	}
}
</style>