Skip to content

Commit 669814b

Browse files
author
Jessica Peng
committedFeb 5, 2022
update docs
1 parent 7d11123 commit 669814b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+429
-594
lines changed
 

‎src/components/MewInfoCard/MewInfoCard.vue

+2-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ export default {
8383
default: ''
8484
},
8585
/**
86-
* The link object. Takes a link title and the url, i.e. {title: '', url: ''}.
86+
* The link object. Takes a title and url, i.e. {title: '', url: ''}.
87+
* This is displayed below the description.
8788
*/
8889
link: {
8990
type: Object,

‎src/components/MewInput/MewInput.vue

+16-20
Original file line numberDiff line numberDiff line change
@@ -121,28 +121,28 @@ export default {
121121
},
122122
props: {
123123
/**
124-
* Error messages to display
124+
* Error messages to display at the bottom of the input.
125125
*/
126126
errorMessages: {
127127
type: [String, Array],
128128
default: '',
129129
},
130130
/**
131-
* input is read only
131+
* Input becomes read only.
132132
*/
133133
isReadOnly: {
134134
type: Boolean,
135135
default: false,
136136
},
137137
/**
138-
* Displays the blockie.
138+
* Prepends the blockie to the beginning of the input.
139139
*/
140140
showBlockie: {
141141
type: Boolean,
142142
default: false,
143143
},
144144
/**
145-
* Removes the border.
145+
* Removes the input border and adds a box shadow.
146146
*/
147147
hasNoBorder: {
148148
type: Boolean,
@@ -184,7 +184,7 @@ export default {
184184
default: null,
185185
},
186186
/**
187-
* Displays a label on the right side of the input.
187+
* Displays text on the right inner side of the input.
188188
*/
189189
rightLabel: {
190190
type: String,
@@ -198,7 +198,8 @@ export default {
198198
default: false,
199199
},
200200
/**
201-
* For validating your input - accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message.
201+
* For validating your input - accepts an array of functions that take an input value as an argument and returns either true / false
202+
* or a string containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) false or is a string.
202203
*/
203204
rules: {
204205
type: Array,
@@ -207,42 +208,35 @@ export default {
207208
},
208209
},
209210
/**
210-
* Resolved address
211+
* The resolved address.
211212
*/
212213
resolvedAddr: {
213214
type: String,
214215
default: '',
215216
},
216217
/**
217-
* Enables persistent hint
218+
* Enables persistent hint.
218219
*/
219220
persistentHint: {
220221
type: Boolean,
221222
default: false,
222223
},
223224
/**
224-
* Hint text
225+
* Hint text (will be displayed at the bottom of the input).
225226
*/
226227
hint: {
227228
type: String,
228229
default: '',
229230
},
230231
/**
231-
* Displays search input
232-
*/
233-
isSearch: {
234-
type: Boolean,
235-
default: false,
236-
},
237-
/**
238-
* Sets input type
232+
* Sets input type.
239233
*/
240234
type: {
241235
type: String,
242236
default: 'text',
243237
},
244238
/**
245-
* Prepends an image in the input
239+
* Prepends an image to the beginning of the input.
246240
*/
247241
image: {
248242
type: String,
@@ -256,7 +250,9 @@ export default {
256250
default: '',
257251
},
258252
/**
259-
* Object for max button, i.e. {title: 'Max', disabled: false, method: () => {}}
253+
* Displays a button to the right inner side of the input.
254+
* Takes an object.
255+
* i.e. {title: 'Max', disabled: false, method: () => {}}.
260256
*/
261257
maxBtnObj: {
262258
type: Object,
@@ -265,7 +261,7 @@ export default {
265261
},
266262
},
267263
/**
268-
* Autofocuses the input
264+
* Autofocuses the input.
269265
*/
270266
autofocus: {
271267
type: Boolean,

0 commit comments

Comments
 (0)
Please sign in to comment.