Replace Wikit Textarea with Codex Textarea component #771
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| <template> | ||
| <cdx-field | ||
| :status="validationError ? validationError.type : 'default'" | ||
| :messages="validationError ? validationError.message : null" | ||
| > | ||
| <div class="progress-bar-wrapper"> | ||
| <cdx-progress-bar v-if="loading" :aria-label="$i18n('item-form-progress-bar-aria-label')" /> | ||
| </div> | ||
| <cdx-text-area | ||
| :label="$i18n('item-form-id-input-label')" | ||
| :placeholder="$i18n('item-form-id-input-placeholder')" | ||
| :rows="8" | ||
| :status="validationError ? validationError.type : 'default'" | ||
| v-model="textareaInputValue" | ||
| /> | ||
| </cdx-field> | ||
| </template> | ||
|
|
||
| <script lang="ts"> | ||
| import { defineComponent, ref } from 'vue'; | ||
| import { useStore } from '../store'; | ||
| import { MAX_NUM_IDS } from '../Pages/Home.vue'; | ||
guergana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| import { CdxTextArea, CdxField, CdxProgressBar } from "@wikimedia/codex"; | ||
|
|
||
| // Run it with compat mode | ||
| // https://v3-migration.vuejs.org/breaking-changes/v-model.html | ||
| CdxTextArea.compatConfig = { | ||
guergana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ...CdxTextArea.compatConfig, | ||
| COMPONENT_V_MODEL: false, | ||
| }; | ||
|
|
||
| export default defineComponent({ | ||
| components: { | ||
| CdxField, | ||
| CdxProgressBar, | ||
| CdxTextArea, | ||
| }, | ||
| setup() { | ||
| const store = useStore(); | ||
|
There was a problem hiding this comment. I wonder if we even need to rely on the state store here, if this is to be rally made reusable, we would get the IDs from a prop. |
||
| const textareaInputValue = ref(store.lastSearchedIds); | ||
|
|
||
| return { | ||
| textareaInputValue | ||
| }; | ||
| }, | ||
| props: { | ||
| loading: { | ||
| type: Boolean, | ||
| default: false | ||
| } | ||
| }, | ||
| methods: { | ||
| splitInput: function(): Array<string> { | ||
| return this.textareaInputValue.split( '\n' ); | ||
| }, | ||
| sanitizeArray: function(): Array<string> { | ||
| // this filter function removes all falsy values | ||
| // see: https://stackoverflow.com/a/281335/1619792 | ||
| return this.splitInput().filter(x => x); | ||
| }, | ||
| serializeInput: function(): string { | ||
| return this.sanitizeArray().join('|'); | ||
| }, | ||
| validate(): void { | ||
| this.validationError = null; | ||
|
|
||
| const typeError = 'error'; | ||
|
|
||
| const rules = [{ | ||
| check: (ids: Array<string>) => ids.length < 1, | ||
| type: typeError, | ||
| message: { [typeError]: this.$i18n('item-form-error-message-empty') } | ||
| }, | ||
| { | ||
| check: (ids: Array<string>) => ids.length > MAX_NUM_IDS, | ||
| type: 'error', | ||
| message: { [typeError]: this.$i18n('item-form-error-message-max', MAX_NUM_IDS) } | ||
| }, | ||
| { | ||
| check: (ids: Array<string>) => !ids.every(value => /^[Qq]\d+$/.test( value.trim() )), | ||
| type: 'error', | ||
| message: { [typeError]: this.$i18n('item-form-error-message-invalid') } | ||
| }]; | ||
|
|
||
| const sanitized = this.sanitizeArray(); | ||
|
|
||
| for(const {check, type, message} of rules){ | ||
| if(check(sanitized)){ | ||
| this.validationError = { type, message }; | ||
| return; | ||
| } | ||
| } | ||
| }, | ||
| }, | ||
| data() { | ||
| return { | ||
| validationError: null | ||
| } | ||
| }, | ||
| }); | ||
| </script> | ||
|
|
||
| <style lang="scss"> | ||
|
|
||
| .cdx-field__control { | ||
| position: relative; | ||
| width: 100%; | ||
|
|
||
| .progress-bar-wrapper { | ||
| position: absolute; | ||
| top: 50%; | ||
| width: 100%; | ||
|
|
||
| .cdx-progress-bar { | ||
| width: 50%; | ||
| margin: auto; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| </style> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,13 +78,9 @@ | |
| </cdx-button> | ||
| </div> | ||
| <form id="items-form" @submit.prevent="send"> | ||
| <textarea-home | ||
|
There was a problem hiding this comment. I am not so sure about calling the component
Since the component is in charge of providing a search field for Item IDs, I think a better name for it would be something like There was a problem hiding this comment. Yes, wasn't sure what name to give it. Suggestions always come up faster in the review :D Thanks for the name. I still want to make sure it is clear that this is the textarea. I will call it |
||
| :loading="loading" | ||
| ref="textarea" | ||
| /> | ||
| <div class="form-buttons"> | ||
| <cdx-button | ||
|
|
@@ -106,18 +102,15 @@ | |
| import { Head as InertiaHead } from '@inertiajs/inertia-vue3'; | ||
| import { mapState } from 'pinia'; | ||
| import { useStore } from '../store'; | ||
| import { CdxDialog, CdxButton, CdxIcon, CdxMessage } from "@wikimedia/codex"; | ||
| import TextareaHome from '../Components/TextareaHome.vue'; | ||
| import { cdxIconDie, cdxIconInfo } from '@wikimedia/codex-icons'; | ||
| import { defineComponent, ref } from 'vue'; | ||
|
|
||
| interface HomeState { | ||
| validationError: null|{ | ||
| type: string, | ||
| message: object | ||
| }, | ||
| faqDialog: boolean | ||
| } | ||
|
|
@@ -138,64 +131,31 @@ | |
| CdxButton, | ||
| CdxIcon, | ||
| CdxMessage, | ||
| TextareaHome, | ||
| InertiaHead | ||
| }, | ||
| setup() { | ||
| const store = useStore(); | ||
| const textareaInputValue = ref(store.lastSearchedIds); | ||
guergana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return { | ||
| cdxIconDie, | ||
| cdxIconInfo, | ||
| textareaInputValue | ||
| }; | ||
| }, | ||
| methods: { | ||
| send(): void { | ||
| (this.$refs.textarea as InstanceType<typeof TextareaHome>).validate(); | ||
|
|
||
| if((this.$refs.textarea as InstanceType<typeof TextareaHome>).validationError) { | ||
| return; | ||
| } | ||
| const store = useStore(); | ||
| store.saveSearchedIds( this.textareaInputValue ); | ||
| this.$inertia.get( '/results', | ||
| { ids: (this.$refs.textarea as InstanceType<typeof TextareaHome>).serializeInput() } | ||
|
There was a problem hiding this comment. I'd prefer it if we didn't directly call component methods. While this can be done with composition API using |
||
| ); | ||
| }, | ||
| showRandom(): void { | ||
| this.$inertia.get( '/random' ); | ||
|
|
@@ -216,11 +176,7 @@ | |
| ...mapState(useStore, ['loading']), | ||
| }, | ||
| data(): HomeState { | ||
| return { | ||
| validationError: null, | ||
| faqDialog: false | ||
| } | ||
|
|
@@ -272,5 +228,21 @@ | |
| .form-buttons { | ||
| text-align: end; | ||
| } | ||
|
|
||
| .cdx-field__control { | ||
| position: relative; | ||
| width: 100%; | ||
|
|
||
| .progress-bar-wrapper { | ||
| position: absolute; | ||
| top: 50%; | ||
| width: 100%; | ||
|
|
||
| .cdx-progress-bar { | ||
| width: 50%; | ||
| margin: auto; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| </style> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a new component, I think we should use the composition API instead of the options API already. That is, we can use
<script setup lang="ts">here and not usedefineComponent. See: