@jblehm/super-list 1.0.38 → 1.0.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,23 +1,32 @@
|
|
|
1
|
-
# superlist V1.0.
|
|
2
|
-
|
|
1
|
+
# superlist V1.0.40
|
|
2
|
+
A minimally-styled, mobile supported searchable combobox for Vue.
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
|
|
7
|
+
Example styled component implementation in Vue:
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
6
12
|
Import the following style where the component is used:
|
|
7
13
|
```css
|
|
8
14
|
<style src="@jblehm/super-list/dist/index.css" />
|
|
9
15
|
```
|
|
10
16
|
|
|
17
|
+
|
|
11
18
|
The list component has the following Vue emits which can be used for v-model binding:
|
|
12
19
|
```js
|
|
13
20
|
const emit = defineEmits({ 'update:selected': null })
|
|
14
21
|
```
|
|
15
22
|
|
|
23
|
+
|
|
16
24
|
The list component can be passed a function or an array of options. If a function is passed, it should match the ListRequest type:
|
|
17
25
|
```ts
|
|
18
26
|
ListRequest = (maxNumItems: number, stringFilter?: string) => Promise<{ data: T[]; totalNum: number; modelName?: string }>
|
|
19
27
|
```
|
|
20
28
|
|
|
29
|
+
|
|
21
30
|
The list component has the following Vue properties:
|
|
22
31
|
```js
|
|
23
32
|
selected: {
|
|
@@ -60,7 +69,7 @@ The list component has the following Vue properties:
|
|
|
60
69
|
default: undefined
|
|
61
70
|
},
|
|
62
71
|
customPlaceHolderFunction: {
|
|
63
|
-
type: Function as PropType<Function | null>, // Display custom placeholder text in the filter input box
|
|
72
|
+
type: Function as PropType<Function | null>, // Display custom placeholder text in the filter input box regardless of how the selected item text appears elsewhere
|
|
64
73
|
default: null
|
|
65
74
|
},
|
|
66
75
|
scrollTextInputToTopOnMobile: {
|
|
@@ -70,11 +79,7 @@ The list component has the following Vue properties:
|
|
|
70
79
|
```
|
|
71
80
|
|
|
72
81
|
|
|
73
|
-
|
|
74
|
-
Example styled component implementation in Vue:
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
82
|
+
Example styled code:
|
|
78
83
|
```js
|
|
79
84
|
<template>
|
|
80
85
|
<SuperList
|