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

97.77% Statements 220/225
95.45% Branches 21/22
91.66% Functions 11/12
97.77% Lines 220/225

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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 2261x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 15x 15x 15x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 89x 1x 1x 1x 1x 1x 1x 1x 1x 81x 1x 1x 1x 1x 1x 1x 1x 1x 83x 83x 83x 1x 1x 1x 1x 1x 1x 1x 15x 15x 15x 1x 1x 1x 1x 1x 1x 1x 15x 1x 1x 1x 1x 1x 1x 1x 15x 1x 1x 1x 1x 1x 1x 1x 15x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x     1x 1x 1x 1x 1x 1x 1x 9x 9x 6x 1x 6x 5x 5x 5x 5x 5x 5x 5x 5x 5x 9x 3x 3x 3x 3x 3x 3x 3x 3x       3x 3x 3x 3x 3x 3x 3x 3x 9x 6x 6x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 1x 1x 15x 15x 15x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
<!--
	WikiLambda Vue component for setting the name of a ZFunction in the Function editor.
 
	@copyright 2020– Abstract Wikipedia team; see AUTHORS.txt
	@license MIT
-->
<template>
	<div class="ext-wikilambda-function-definition-name">
		<div class="ext-wikilambda-function-block__label">
			<label :for="nameFieldId">
				{{ nameLabel }}
				<span>{{ nameOptional }}</span>
			</label>
		</div>
		<div class="ext-wikilambda-function-block__body">
			<cdx-text-input
				:id="nameFieldId"
				:model-value="name"
				class="ext-wikilambda-function-definition-name__input"
				:aria-label="nameLabel"
				:placeholder="nameFieldPlaceholder"
				:maxlength="maxLabelChars"
				@input="updateRemainingChars"
				@change="persistName"
			></cdx-text-input>
			<div class="ext-wikilambda-function-definition-name__counter">
				{{ remainingChars }}
			</div>
		</div>
	</div>
</template>
 
<script>
const { defineComponent } = require( 'vue' );
const Constants = require( '../../../Constants.js' ),
	mapGetters = require( 'vuex' ).mapGetters,
	mapActions = require( 'vuex' ).mapActions,
	CdxTextInput = require( '@wikimedia/codex' ).CdxTextInput;
 
module.exports = exports = defineComponent( {
	name: 'wl-function-editor-name',
	components: {
		'cdx-text-input': CdxTextInput
	},
	props: {
		/**
		 * zID of item label language
		 *
		 * @example Z1014
		 */
		zLanguage: {
			type: String,
			required: true
		},
		isMainLanguageBlock: {
			type: Boolean,
			default: false
		}
	},
	data: function () {
		return {
			maxLabelChars: Constants.LABEL_CHARS_MAX,
			remainingChars: Constants.LABEL_CHARS_MAX
		};
	},
	computed: Object.assign( mapGetters( [
		'getZPersistentName',
		'getZMonolingualTextValue',
		'getRowByKeyPath'
	] ), {
		/**
		 * Returns the Name (Z2K3) row for the given language.
		 * If the language is not set, returns undefined
		 *
		 * @return {Object|undefined}
		 */
		nameObject: function () {
			return this.zLanguage ? this.getZPersistentName( this.zLanguage ) : undefined;
		},
		/**
		 * Returns whether this function has a name object
		 * for the given language.
		 *
		 * @return {boolean}
		 */
		hasName: function () {
			return !!this.nameObject;
		},
		/**
		 * Returns the Name value for the given language.
		 * If value is not available, returns empty string
		 *
		 * @return {string}
		 */
		name: function () {
			return this.hasName ?
				this.getZMonolingualTextValue( this.nameObject.rowId ) :
				'';
		},
		/**
		 * Returns the label for the name field
		 *
		 * @return {string}
		 */
		nameLabel: function () {
			// TODO (T335583): Replace i18n message with key label
			// return this.getLabelData( Constants.Z_PERSISTENTOBJECT_LABEL );
			return this.$i18n( 'wikilambda-function-definition-name-label' ).text();
		},
		/**
		 * Returns the i18n message for the name field placeholder
		 *
		 * @return {string}
		 */
		nameFieldPlaceholder: function () {
			return this.$i18n( 'wikilambda-function-definition-name-placeholder' ).text();
		},
		/**
		 * Returns the "optional" caption for the name field
		 *
		 * @return {string}
		 */
		nameOptional: function () {
			return this.$i18n( 'parentheses', [ this.$i18n( 'wikilambda-optional' ).text() ] ).text();
		},
		/**
		 * Returns the id for the input field
		 *
		 * @return {string}
		 */
		nameFieldId: function () {
			return `ext-wikilambda-function-definition-name__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.maxLabelChars - length;
		},
		/**
		 * Persist the new name value in the globally stored object
		 *
		 * @param {Object} event
		 */
		persistName: function ( event ) {
			const value = event.target.value;
			if ( this.hasName ) {
				if ( value === '' ) {
					this.removeItemFromTypedList( { rowId: this.nameObject.rowId } );
				} else {
					this.setValueByRowIdAndPath( {
						rowId: this.nameObject.rowId,
						keyPath: [
							Constants.Z_MONOLINGUALSTRING_VALUE,
							Constants.Z_STRING_VALUE
						],
						value
					} );
				}
			} else {
				// If this.nameObject 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_LABEL,
					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
				} );
			}
			if ( this.isMainLanguageBlock ) {
				this.setPageTitle( value );
			}
			this.$emit( 'updated-name' );
		},
 
		/**
		 * If this is the main language represented in the page,
		 * sets the page title to the new Function Name
		 *
		 * @param {string} name
		 */
		setPageTitle: function ( name ) {
			const pageTitleSelector = '#firstHeading .ext-wikilambda-editpage-header-title--function-name';
			$( pageTitleSelector ).first().text( name );
		}
	} ),
	mounted: function () {
		this.$nextTick( function () {
			this.remainingChars = this.maxLabelChars - this.name.length;
		} );
	}
} );
</script>
 
<style lang="less">
@import '../../../ext.wikilambda.edit.variables.less';
 
.ext-wikilambda-function-definition-name {
	&__counter {
		color: @color-subtle;
		margin-left: @spacing-50;
		align-self: center;
		float: right;
	}
}
</style>