Select
General
You need to use a fetchCallback property to format the data of the API callback, which will match the data structure of the component.
Normal (Single selection and Multiple selection)
|
Select
|
Select
Single selection (automatically trigger request)
|
Linkage value:Select
Single selection (manual trigger request)
Using "fetchTrigger" and "fetchTriggerForDefaultData" parameters
|
Search Options
Multiple selection (automatically trigger request)
Multiple selection (manual trigger request)
Using "fetchTrigger" and "fetchTriggerForDefaultData" parameters
Show Code
import React from "react";
import Select from 'funda-ui/Select';
import axios from 'axios';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getList()` must be a Promise Object
async getList(searchStr = '', limit = 0, otherParam = '') {
console.log('searchStr: ', searchStr);
console.log("limit: ", limit);
console.log("otherParam: ", otherParam);
return {
code: 0,
message: 'OK',
data: [
{item_name: 'foo', item_code: 'bar', kb_code: 'fb,foobar'},
{item_name: 'foo2', item_code: 'bar2', kb_code: 'fb2,foobar2'},
{item_name: 'foo3', item_code: 'bar3', kb_code: 'fb3,foobar3'}
]
};
}
async getListUseAxios(searchStr = '', limit = 0) {
let _data = null;
const res = await axios.get(`https://api`, {
params: {
s: searchStr,
limit: limit
},
headers: {
'Authorization': 'Bearer xxxx-xxxxxxxx-xxxxxxxx'
'Content-Type': 'application/json'
}
}).catch(function (error) {
console.log(error);
});
if (res && res.status == 200) _data = res.data;
// result
if (_data === null) {
return {
code: 0,
message: 'OK',
data: []
};
} else {
return {
code: 0,
message: 'OK',
data: _data
};
}
}
}
export default () => {
return (
<>
<h3>Normal (Single selection and Multiple selection)</h3>
{/* ================================================================== */}
<Select
cleanTrigger={{valid: true, cleanValueLabel: 'Clean'}}
value="value-2"
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth/2 + 'px'}
options={`
[
{"label": "Option 1","value": "value-1","queryString": "option1"},
{"label": "<del style=color:red>deprecate</del>Option 2","value": "value-2","queryString": "option2"},
{"label": "Option 3","value": "value-3","queryString": "option3"},
{"label": "Option 4","value": "value-4","queryString": "option4", "disabled":true}
]
`}
onChange={(e, e2, val) => {
console.log(e, e2, val);
/*
<input ... value="[Option 3][Option 2][Option 1]">
<input ... value="[value-3][value-2][value-1]">
{
items: [
{"label": "Option 3","value": "value-3"},
{"label": "<del style=color:red>deprecate</del>Option 2","value": "value-2"},
{"label": "Option 1","value": "value-1"}
],
labels: ['Option 3', '<del style=color:red>deprecate</del>Option 2', 'Option 1'],
values: ['value-3', 'value-2', 'value-1'],
labelsOfString: '[Option 3][<del style=color:red>deprecate</del>Option 2][Option 1]',
valuesOfString: '[value-3][value-2][value-1]'
}
*/
}}
/>
<Select
value="value-2"
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth/2 + 'px'}
options={`
[
{"label": "Option 1","listItemLabel":"Option 1 (No: 001)","value": "value-1","queryString": "option1"},
{"label": "Option 2","listItemLabel":"<del style=color:red>deprecate</del>Option 2 (No: 002)","value": "value-2","queryString": "option2"},
{"label": "Option 3","listItemLabel":"Option 3 (No: 003)","value": "value-3","queryString": "option3"},
{"label": "Option 4","listItemLabel":"Option 4 (No: 004)","value": "value-4","queryString": "option4", "disabled":true}
]
`}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
<Select
value="[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18][19][20]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
labels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
queryStrings: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => ''),
}
}}
placeholder="Select"
name="name"
options={Array.from({ length: 100 }).fill(0).map((v, i) => {
return { "label": `${i}`, "value": `${i}`, "queryString": "" }
})}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
<h3>Single selection (automatically trigger request)</h3>
{/* ================================================================== */}
<Select
value="bar2"
placeholder="Select"
name="name"
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['',0]}
fetchCallback={(res) => {
const formattedData = res.map((item, i) => {
return {
label: item.item_name,
value: item.item_code,
myOrder: i,
queryString: item.kb_code
}
});
console.log(formattedData);
/*
[
{"label": "foo","value": "bar","queryString": "fb,foobar","myOrder":0},
{"label": "foo2","value": "bar2","queryString": "fb2,foobar2","myOrder":1},
{"label": "foo3","value": "bar3","queryString": "fb3,foobar3","myOrder":2}
]
*/
return formattedData;
}}
onChange={((e: any, e2: any, val: any) => {
const addValue = (name: string, targetValueField: string = 'label') => {
[].slice.call(document.querySelectorAll(`[name="${name}"]`)).forEach((node: any) => {
node.value = val[targetValueField];
});
};
addValue('name-xxxxxx', 'label');
addValue('name-yyyyyy', 'myOrder');
})}
onFetch={(e, e2, value, res, data) => {
console.log('onFetch: ', e, e2, value, res, data);
const curItem = res.find((v: any) => v.value == value);
if (typeof curItem !== 'undefined') {
const addValue = (name: string, targetValueField: string = 'label') => {
[].slice.call(document.querySelectorAll(`[name="${name}"]`)).forEach((node: any) => {
if (typeof curItem[targetValueField] !== 'undefined') node.value = curItem[targetValueField];
});
};
addValue('name-xxxxxx', 'label');
addValue('name-yyyyyy', 'myOrder');
}
}}
/>
Linkage value:
<input name="name-xxxxxx" size={5} type="text" defaultValue="" />
<input name="name-yyyyyy" size={5} type="text" defaultValue="" />
<h3>Single selection (manual trigger request)</h3>
<p>Using "fetchTrigger" and "fetchTriggerForDefaultData" parameters</p>
{/* ================================================================== */}
<Select
value="bar2"
placeholder="Search Options"
name="name"
data="mydata"
fetchUpdate={true}
fetchTrigger={true}
fetchTriggerForDefaultData={{
values: ['bar2'],
labels: ['foo2'],
queryStrings: ['fb2,foobar2']
}}
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['$QUERY_STRING',0]}
fetchCallback={(res) => {
const formattedData = res.map((item) => {
return {
label: item.item_name,
value: item.item_code,
queryString: item.kb_code
}
});
return formattedData;
}}
onFetch={(e, e2, value, res, data) => {
console.log('onFetch: ', e, e2, value, res, data);
}}
/>
<h3>Multiple selection (automatically trigger request)</h3>
{/* ================================================================== */}
<Select
value="[bar2]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: ['bar2'],
labels: ['foo2'],
queryStrings: ['fb2,foobar2']
}
}}
name="target_user_id"
placeholder="Select"
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['',0]}
fetchCallback={(res) => {
const formattedData = res.map((item) => {
return {
label: item.item_name,
value: item.item_code,
queryString: item.kb_code
}
});
return formattedData;
}}
onFetch={(e, e2, value, res, data) => {
console.log('onFetch: ', e, e2, value, res, data);
}}
/>
<h3>Multiple selection (manual trigger request)</h3>
<p>Using "fetchTrigger" and "fetchTriggerForDefaultData" parameters</p>
{/* ================================================================== */}
<Select
value="[bar2]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: ['bar2'],
labels: ['foo2'],
queryStrings: ['fb2,foobar2']
}
// data: null
}}
name="target_user_id"
placeholder="Select"
fetchUpdate={true}
fetchTrigger={true}
fetchTriggerForDefaultData={{
values: ['bar2'],
labels: ['foo2'],
queryStrings: ['fb2,foobar2']
}}
// fetchTriggerForDefaultData={undefined}
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['$QUERY_STRING',0]}
fetchCallback={(res) => {
const formattedData = res.map((item) => {
return {
label: item.item_name,
value: item.item_code,
queryString: item.kb_code
}
});
return formattedData;
}}
onFetch={(e, e2, value, res, data) => {
console.log('onFetch: ', e, e2, value, res, data);
}}
/>
</>
);
}No spacing
|
Select
|
Select
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
...
wrapperClassName="position-relative"
...
/>
<Select
...
wrapperClassName=""
...
/>
</>
);
}Use the object as the default
You can specify an object as the default, and if the default value is not in the list of options, it will be displayed by default.
Note: Single selection only!!!
|
Select
|
Select
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
value={{"label": "Option 3","listItemLabel":"Option 3 (No: 003)","value": "value-3","queryString": "option3"}}
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth / 2 + 'px'}
options={[
{"label": "Option 1","listItemLabel":"Option 1 (No: 001)","value": "value-1","queryString": "option1"},
{"label": "Option 2","listItemLabel":"<del style=color:red>deprecate</del>Option 2 (No: 002)","value": "value-2","queryString": "option2"},
{"label": "Option 3","listItemLabel":"Option 3 (No: 003)","value": "value-3","queryString": "option3"},
{"label": "Option 4","listItemLabel":"Option 4 (No: 004)","value": "value-4","queryString": "option4", "disabled":true}
]}
/>
<Select
value={{ "label": "Option New", "value": "value-new", "queryString": "" }}
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth / 2 + 'px'}
options={[
{"label": "Option 1","listItemLabel":"Option 1 (No: 001)","value": "value-1","queryString": "option1"},
{"label": "Option 2","listItemLabel":"<del style=color:red>deprecate</del>Option 2 (No: 002)","value": "value-2","queryString": "option2"},
{"label": "Option 3","listItemLabel":"Option 3 (No: 003)","value": "value-3","queryString": "option3"},
{"label": "Option 4","listItemLabel":"Option 4 (No: 004)","value": "value-4","queryString": "option4", "disabled":true}
]}
/>
</>
);
}Click on the callback via option
Use the callback attribute of the option.
|
Select
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth / 2 + 'px'}
options={[
{"label": "Option 1","listItemLabel":"Option 1 (No: 001)","value": "value-1","queryString": "option1"},
{"label": "Option 2","listItemLabel":"<del style=color:red>deprecate</del>Option 2 (click on the callback)","value": "value-2","queryString": "option2"},
{"label": "Option 3","listItemLabel":"<span style='background:blue;color:white;padding:.3rem;margin:.5rem 0;border-radius:5px;'>More</span>","value": "value-3","queryString": "option3", "callback": () => {
alert('Option 3');
}},
]}
/>
</>
);
}Asynchronous requests are not executed by default
Set property firstRequestAutoExec to false. The first asynchronous request is not executed (saving bandwidth and improving performance). Trigger the first asynchronous request when the options area is expanded.
Valid when the series attribute
fetchXXXXis exist
|
Select
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getList()` must be a Promise Object
async getList(searchStr = '', limit = 0, otherParam = '') {
console.log('searchStr: ', searchStr);
console.log("limit: ", limit);
console.log("otherParam: ", otherParam);
return {
code: 0,
message: 'OK',
data: [
{item_name: 'foo', item_code: 'bar', kb_code: 'fb,foobar'},
{item_name: 'foo2', item_code: 'bar2', kb_code: 'fb2,foobar2'},
{item_name: 'foo3', item_code: 'bar3', kb_code: 'fb3,foobar3'}
]
};
}
}
export default () => {
return (
<>
<Select
placeholder="Select"
name="name"
firstRequestAutoExec={false}
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['',0]}
fetchCallback={(res) => {
const formattedData = res.map((item, i) => {
return {
label: item.item_name,
value: item.item_code,
myOrder: i,
queryString: item.kb_code
}
});
return formattedData;
}}
/>
</>
);
}The Option Group element
Specify the content in the optgroup attribute of options.
|
Select
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
value="value-2"
placeholder="Select"
name="name"
options={[
{ "label": "Option 0", "value": "value-0","queryString":"" },
{
"label": "Group 1", "value": "", "queryString":"", "optgroup": [
{ "label": "Option 1", "value": "value-1","queryString":"" },
{ "label": "Option 2", "value": "value-2","queryString":"" }
]
},
{
"label": "Group 2", "value": "", "queryString":"", "optgroup": [
{ "label": "Option 3", "value": "value-3","queryString":"" },
{ "label": "Option 4", "value": "value-4","queryString":"" },
{ "label": "Option 5", "value": "value-5","queryString":"" }
]
},
{ "label": "Option 6", "value": "value-6","queryString":"" },
]}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
);
}Render the selected value for multiple selection
Show Code
import React from "react";
import Select, { MultiSelectControlValConfig } from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
value="[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18][19][20]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
labels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
queryStrings: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => ''),
}
}}
renderSelectedValue={(selectedData: MultiSelectControlValConfig, removeFunc: (e: React.MouseEvent) => void) => (
<>
{selectedData.labels.map((item: string, index: number) => (
<li
key={'selected-item-' + index}
data-value={selectedData.values[index]}
data-label={item}
className="bg-transparent m-0"
style={{padding: '0.1rem 1.2rem .1rem .2rem'}}
>
{item}
<a
href="#"
tabIndex={-1}
onClick={removeFunc}
data-value={selectedData.values[index]}
><svg width="10px" height="10px" viewBox="0 0 1024 1024"><path style={{fill: '#f60'}} d="M195.2 195.2a64 64 0 0 1 90.496 0L512 421.504 738.304 195.2a64 64 0 0 1 90.496 90.496L602.496 512 828.8 738.304a64 64 0 0 1-90.496 90.496L512 602.496 285.696 828.8a64 64 0 0 1-90.496-90.496L421.504 512 195.2 285.696a64 64 0 0 1 0-90.496z" /></svg></a>
</li>
))}
</>
)}
placeholder="Select"
name="name"
options={Array.from({ length: 100 }).fill(0).map((v, i) => {
return { "label": `${i}`, "value": `${i}`, "queryString": "" }
})}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
);
}Multi-Level Cascading Select (Implemented using useState())
|
Select
|
Select
|
Select
Show Code
import React, { useState } from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getListFirst()` must be a Promise Object
async getListFirst(searchStr = '', limit = 0, otherParam = '') {
console.log('searchStr: ', searchStr);
console.log("limit: ", limit);
console.log("otherParam: ", otherParam);
const demoData = [
{
"parent_id": 0,
"item_code": 1,
"item_name": "Title 1",
"item_type": "web"
},
{
"parent_id": 0,
"item_code": 2,
"item_name": "Title 2",
"item_type": "dev"
}
];
return {
code: 0,
message: 'OK',
data: demoData
};
}
// `getListSecond()` must be a Promise Object
async getListSecond(searchStr = '', limit = 0, parentId = 0) {
console.log("parentId: ", parentId);
const demoData = [
{
"parent_id": 1,
"item_code": 3,
"item_name": "Title 3",
"item_type": "web/ui"
},
{
"parent_id": 1,
"item_code": 4,
"item_name": "Title 4",
"item_type": "web/ui"
},
{
"parent_id": 2,
"item_code": 5,
"item_name": "Title 5",
"item_type": "dev"
}
];
const res = demoData.filter( item => {
return item.parent_id == parentId;
} );
return {
code: 0,
message: 'OK',
data: res
};
}
// `getListThird()` must be a Promise Object
async getListThird(searchStr = '', limit = 0, parentId = 0) {
console.log("parentId: ", parentId);
const demoData = [
{
"parent_id": 5,
"item_code": 6,
"item_name": "Title 6",
"item_type": "dev"
},
{
"parent_id": 5,
"item_code": 7,
"item_name": "Title 7",
"item_type": "dev"
},
{
"parent_id": 3,
"item_code": 8,
"item_name": "Title 8",
"item_type": "web/ui"
}
];
const res = demoData.filter( item => {
return item.parent_id == parentId;
} );
return {
code: 0,
message: 'OK',
data: res
};
}
}
export default () => {
const service = new DataService;
const [secondValue, setSecondValue] = useState<string>('');
const [thirdValue, setThirdValue] = useState<string>('');
const [secondOptions, setSecondOptions] = useState<string>('');
const [thirdOptions, setThirdOptions] = useState<string>('');
function toSlug(str: string) {
return str
.toString()
.replace(/[^\w\s\-！￥【】\u4e00-\u9eff]/gi, '')
.replace(/\s/g, '-')
.replace(/(\-){2,}/g, '-')
.replace(/\-\s*$/, '')
.toLowerCase();
};
return (
<>
<Select
placeholder="Select"
name="name-1"
label="Level 1"
fetchFuncAsync={service}
fetchFuncMethod="getListFirst"
fetchFuncMethodParams={['', 0, 1]}
fetchCallback={(res) => {
const formattedData = res.map((item: any) => {
return {
label: item.item_name,
value: toSlug(item.item_name),
queryString: '',
queryId: item.item_code
}
});
return formattedData;
}}
onChange={(e: any, e2: any, val: any) => {
const queryId = val.queryId;
// value of "name-2" and "name-3"
setSecondValue('');
setThirdValue('');
setThirdOptions('');
// options of "name-2"
service.getListSecond('', 0, queryId).then((res: any) => {
const formattedData = res.data.map((item: any) => {
return {
label: item.item_name,
value: toSlug(item.item_name),
queryString: '',
queryId: item.item_code
}
});
setSecondOptions(JSON.stringify(formattedData));
});
}}
/>
<Select
value={secondValue}
placeholder="Select"
name="name-2"
label="Level 2"
options={secondOptions}
onChange={(e: any, e2: any, val: any) => {
const queryId = val.queryId;
// value of "name-3"
setThirdValue('');
// options of "name-3"
service.getListThird('', 0, queryId).then((res: any) => {
const formattedData = res.data.map((item: any) => {
return {
label: item.item_name,
value: toSlug(item.item_name),
queryString: '',
queryId: item.item_code
}
});
setThirdOptions(JSON.stringify(formattedData));
});
}}
/>
<Select
value={thirdValue}
placeholder="Select"
name="name-3"
label="Level 3"
options={thirdOptions}
/>
</>
);
}Multi-Level Cascading Select (Implemented using data-options of component)
It is usually used for complex cascading <Select /> components
|
Select
|
Select
Show Code
import React, { useState } from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getListFirst()` must be a Promise Object
async getListFirst(searchStr = '', limit = 0, otherParam = '') {
console.log('searchStr: ', searchStr);
console.log("limit: ", limit);
console.log("otherParam: ", otherParam);
const demoData = [
{
"parent_id": 0,
"item_code": 1,
"item_name": "Title 1",
"item_type": "web"
},
{
"parent_id": 0,
"item_code": 2,
"item_name": "Title 2",
"item_type": "dev"
}
];
return {
code: 0,
message: 'OK',
data: demoData
};
}
// `getListSecond()` must be a Promise Object
async getListSecond(searchStr = '', limit = 0, parentId = 0) {
console.log("parentId: ", parentId);
const demoData = [
{
"parent_id": 1,
"item_code": 3,
"item_name": "Title 3",
"item_type": "web/ui"
},
{
"parent_id": 1,
"item_code": 4,
"item_name": "Title 4",
"item_type": "web/ui"
},
{
"parent_id": 2,
"item_code": 5,
"item_name": "Title 5",
"item_type": "dev"
}
];
const res = demoData.filter( item => {
return item.parent_id == parentId;
} );
return {
code: 0,
message: 'OK',
data: res
};
}
}
export default () => {
const service = new DataService;
const [dynamicData, setDynamicData] = useState<string>('');
function toSlug(str: string) {
return str
.toString()
.replace(/[^\w\s\-！￥【】\u4e00-\u9eff]/gi, '')
.replace(/\s/g, '-')
.replace(/(\-){2,}/g, '-')
.replace(/\-\s*$/, '')
.toLowerCase();
};
return (
<>
<Select
placeholder="Select"
name="name-1"
label="Level 1"
fetchFuncAsync={service}
fetchFuncMethod="getListFirst"
fetchFuncMethodParams={['', 0, 1]}
fetchCallback={(res) => {
const formattedData = res.map((item: any) => {
return {
label: item.item_name,
value: toSlug(item.item_name),
queryString: '',
queryId: item.item_code
}
});
return formattedData;
}}
onChange={(e: any, e2: any, val: any) => {
const queryId = val.queryId;
// options of "name-2"
service.getListSecond('', 0, queryId).then((res: any) => {
const formattedData = res.data.map((item: any) => {
return {
label: item.item_name,
value: toSlug(item.item_name),
queryString: '',
queryId: item.item_code
}
});
setDynamicData(queryId);
document.querySelector(`#select-level-2`).dataset.options = JSON.stringify(formattedData);
});
}}
/>
<Select
id="select-level-2"
value={''}
data={dynamicData} // `data` attribute will trigger component update
placeholder="Select"
name="name-2"
label="Level 2"
options={''}
/>
</>
);
}Convert raw data into a tree structure
Set hierarchical categories ( with sub-categories ) to attribute options.
|
Select
Show Code
import React, { useEffect, useState } from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getList()` must be a Promise Object
async getList(searchStr: string = '', limit: number = 0, otherParam: string = '') {
const demoData = [
// level 1
{
"parent_id": 0,
"id": 1,
"label": "Top level 1",
"value": 'level-1',
"queryString": ""
},
{
"parent_id": 0,
"id": 2,
"label": "Top level 2",
"value": 'level-2',
"queryString": ""
},
{
"parent_id": 0,
"id": 3,
"label": "Top level 3",
"value": 'level-3',
"queryString": "",
},
// level 2
{
"parent_id": 3,
"id": 4,
"label": "Sub level 3_1",
"value": 'level-3_1',
"queryString": ""
},
{
"parent_id": 1,
"id": 5,
"label": "Sub level 3_2",
"value": 'level-3_2',
"queryString": "",
},
{
"parent_id": 2,
"id": 6,
"label": "Sub level 3_3",
"value": 'level-3_3',
"queryString": ""
},
// level 3
{
"parent_id": 5,
"id": 7,
"label": "Sub level 3_2_1",
"value": 'level-3_2_1',
"queryString": ""
},
];
return {
code: 0,
message: 'OK',
data: demoData
};
}
}
export default () => {
const [data, setData] = useState<any[]>([]);
/**
* Convert Tree
* @param {Array} arr - Input array to convert
* @param {?String | ?Number} parentId - Parent id
* @param {?String} keyId - Key value of id.
* @param {?String} keyParentId - Key value of parent id.
* @returns Array
*/
function convertTree(arr, parentId = '', keyId = 'id', keyParentId = 'parent_id') {
if( !parentId ) {
// If there is no parent id (when recursing for the first time), all parents will be queried
return arr.filter(item => !item[keyParentId]).map(item => {
// Query all child nodes by parent node ID
item.children = convertTree(arr, item[keyId], keyId, keyParentId);
return item;
})
} else {
return arr.filter(item => item[keyParentId] === parentId).map(item => {
// Query all child nodes by parent node ID
item.children = convertTree(arr, item[keyId], keyId, keyParentId);
return item;
})
}
}
useEffect(() => {
new DataService().getList('', 0, '').then((response: any) => {
const _data: any[] = response.data.map((item: any, i: number) => {
return {
id: item.id,
parent_id: item.parent_id,
label: `${item.label}`,
value: `${item.value}`,
queryString: `${item.queryString}`
}
});
const treeData = convertTree(_data);
/*
[{
label: "Top level 1",
value: 'level-1',
queryString: ""
},
{
label: "Top level 2",
value: 'level-2',
queryString: ""
},
{
label: "Top level 3",
value: 'level-3',
queryString: "",
children: [{
label: "Sub level 3_1",
value: 'level-3_1',
queryString: ""
},
{
label: "Sub level 3_2",
value: 'level-3_2',
queryString: "",
children: [{
label: "Sub level 3_2_1",
value: 'level-3_2_1',
queryString: ""
}]
},
{
label: "Sub level 3_3",
value: 'level-3_3',
queryString: ""
}]
}]
*/
setData(treeData);
// do something, such as update `<Scrollbar />`
// ...
});
}, []);
return (
<>
<Select
hierarchical={true}
value="level-3_2_1"
placeholder="Select"
name="name"
options={JSON.stringify(data)}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
<Select
hierarchical={true}
value="[level-1][level-3_1]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: ['level-1','level-3_1'],
labels: ['Top level 1','Sub level 3_1'],
queryStrings: ['','']
}
}}
placeholder="Select"
name="name"
options={JSON.stringify(data)}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
)
}Automatic fetch request:
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
class DataService {
// `getList()` must be a Promise Object
async getList(searchStr: string = '', limit: number = 0, otherParam: string = '') {
const demoData = [
// level 1
{
"parent_id": 0,
"id": 1,
"label": "Top level 1",
"value": 'level-1',
"queryString": ""
},
{
"parent_id": 0,
"id": 2,
"label": "Top level 2",
"value": 'level-2',
"queryString": ""
},
{
"parent_id": 0,
"id": 3,
"label": "Top level 3",
"value": 'level-3',
"queryString": "",
},
// level 2
{
"parent_id": 3,
"id": 4,
"label": "Sub level 3_1",
"value": 'level-3_1',
"queryString": ""
},
{
"parent_id": 1,
"id": 5,
"label": "Sub level 3_2",
"value": 'level-3_2',
"queryString": "",
},
{
"parent_id": 2,
"id": 6,
"label": "Sub level 3_3",
"value": 'level-3_3',
"queryString": ""
},
// level 3
{
"parent_id": 5,
"id": 7,
"label": "Sub level 3_2_1",
"value": 'level-3_2_1',
"queryString": ""
},
];
return {
code: 0,
message: 'OK',
data: demoData
};
}
}
export default () => {
/**
* Convert Tree
* @param {Array} arr - Input array to convert
* @param {?String | ?Number} parentId - Parent id
* @param {?String} keyId - Key value of id.
* @param {?String} keyParentId - Key value of parent id.
* @returns Array
*/
function convertTree(arr, parentId = '', keyId = 'id', keyParentId = 'parent_id') {
if( !parentId ) {
// If there is no parent id (when recursing for the first time), all parents will be queried
return arr.filter(item => !item[keyParentId]).map(item => {
// Query all child nodes by parent node ID
item.children = convertTree(arr, item[keyId], keyId, keyParentId);
return item;
})
} else {
return arr.filter(item => item[keyParentId] === parentId).map(item => {
// Query all child nodes by parent node ID
item.children = convertTree(arr, item[keyId], keyId, keyParentId);
return item;
})
}
}
return (
<>
<Select
hierarchical={true}
doubleIndent={true}
indentation="-"
value="[level-1][level-3_1]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: ['level-1','level-3_1'],
labels: ['Top level 1','Sub level 3_1'],
queryStrings: ['','']
}
}}
placeholder="Select"
name="name"
fetchFuncAsync={new DataService}
fetchFuncMethod="getList"
fetchFuncMethodParams={['', 0, '']}
fetchCallback={(res) => {
const formattedData = res.map((item: any) => {
return {
id: item.id,
parent_id: item.parent_id,
label: item.label,
value: item.value,
queryString: item.queryString
}
});
const treeData = convertTree(formattedData);
treeData.unshift({
id: 0,
parent_id: 0,
label: 'Root',
value: '0',
queryString: ''
});
return treeData;
}}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
);
}Only show the status of selected items for multiple selection
Set multiSelectSelectedItemOnlyStatus parameter.
- No items selected
Show Code
import React from "react";
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
return (
<>
<Select
value="[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18][19][20]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
labels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
queryStrings: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => ''),
}
}}
multiSelectSelectedItemOnlyStatus={{
itemsLabel: '{num} Selected',
allItemsLabel: 'All Content ({num})',
noneLabel: 'No items selected',
}}
placeholder="Select"
name="name"
options={Array.from({ length: 100 }).fill(0).map((v, i) => {
return { "label": `${i}`, "value": `${i}`, "queryString": "" }
})}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
);
}Use the exposed method to assign and empty
Lets you callback the handle exposed as attribute contentRef.
Set Empty Value | Set Custom Value | Active | Focus
|
Set Empty Value (multiple) | Set Custom Value (multiple) | Active (multiple) | Focus (multiple)Select
Show Code
import React, { useState, useRef } from 'react';
import Select from 'funda-ui/Select';
// component styles
import 'funda-ui/Select/index.css';
export default () => {
const conRef = useRef<any>(null);
const con2Ref = useRef<any>(null);
return (
<>
<a
href="#"
onClick={(e: React.MouseEvent) => {
e.preventDefault();
if (conRef.current) conRef.current.clear();
}}
>Set Empty Value</a>
|
<a
href="#"
onClick={(e: React.MouseEvent) => {
e.preventDefault();
if (conRef.current) conRef.current.set([{"label": "Option 1","listItemLabel":"Option 1 (No: 001)","value": "value-1","queryString": "option1"}], () => { console.log('callback') });
}}
>Set Custom Value</a>
<Select
contentRef={conRef}
value="value-2"
placeholder="Select"
name="name"
winWidth={typeof window === 'undefined' ? undefined : () => window.innerWidth/2 + 'px'}
options={`
[
{"label": "Option 1","value": "value-1","queryString": "option1"},
{"label": "<del style=color:red>deprecate</del>Option 2","value": "value-2","queryString": "option2"},
{"label": "Option 3","value": "value-3","queryString": "option3"},
{"label": "Option 4","value": "value-4","queryString": "option4", "disabled":true}
]
`}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
<hr />
<a
href="#"
onClick={(e: React.MouseEvent) => {
e.preventDefault();
if (con2Ref.current) con2Ref.current.clear();
}}
>Set Empty Value (multiple)</a>
|
<a
href="#"
onClick={(e: React.MouseEvent) => {
e.preventDefault();
if (con2Ref.current) con2Ref.current.set([{"label": "15","listItemLabel":"15","value": "15","queryString": ""},{"label": "25","listItemLabel":"25","value": "25","queryString": ""},{"label": "33","listItemLabel":"33","value": "33","queryString": ""}], () => { console.log('callback') });
}}
>Set Custom Value (multiple)</a>
<Select
contentRef={con2Ref}
value="[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18][19][20]"
multiSelect={{
valid: true,
selectAll: true,
selectAllLabel: "Select all options",
data: {
values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
labels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => v.toString()),
queryStrings: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20].map(v => ''),
}
}}
placeholder="Select"
name="name"
options={Array.from({ length: 100 }).fill(0).map((v, i) => {
return { "label": `${i}`, "value": `${i}`, "queryString": "" }
})}
onChange={(e, e2, val) => {
console.log(e, e2, val);
}}
/>
</>
)
}Globally disable real-time search functionality (only valid for non-dynamic requests)
[!WARNING] Globally disabling live search will be invalid when
fetchTriggerexists and true
Prevent the keyboard from popping up when input focus is entered on mobile devices. Just add the window global variable to any page, such as:
window['funda-ui__Select-disable-livesearch'] = 1;API
Select
import Select from 'funda-ui/Select';| Property | Type | Default | Description | Required |
|---|---|---|---|---|
ref | React.ForwardedRef | - | It is the return element of this component. | - |
contentRef | React.ForwardedRef | - | It exposes the following methods:
DO NOT USE it in the | - |
popupRef | React.ForwardedRef | - | It exposes the following methods when the component's popup opens or closes:
| - |
wrapperClassName | string | mb-3 position-relative | The class name of the control wrapper. | - |
controlClassName | string | form-control | The class name of the control. | - |
controlExClassName | string | - | The extended class name of controlClassName. | - |
exceededSidePosOffset | number | 15 | Offset px that exceeds the far right or left side of the screen | - |
options | JSON Object Literals | JSON Object | - | Set the default value using JSON string format for menu of options, like this: [{"label": "Option 1","value": "value-1","queryString": "option1"},{"label": "<del style=color:red>deprecate</del>Option 2","value": "value-2","queryString": "option2"},{"label": "Option 3","value": "value-3","queryString": "option3"},{"label": "Option 4","value": "value-4","queryString": "option4","disabled":true}] Note: Use API data if database query exists. That is, the attribute When the attribute | - |
cleanTrigger | JSON Object | {"valid": false, "cleanValueLabel": "Clean"} | Enable cleanTrigger. Parameters Description: | - |
lockBodyScroll | boolean | false | Enables body scroll locking (for iOS Mobile and Tablet, Android, desktop Safari/Chrome/Firefox) without breaking scrolling of a target element. | - |
hierarchical | boolean | false | Set hierarchical categories ( with sub-categories ) to attribute options. | - |
indentation | string | - | Set hierarchical indentation placeholders, valid when the hierarchical is true. | - |
doubleIndent | boolean | false | Set double indent effect, valid when the hierarchical is true. | - |
multiSelect | JSON Object | {"valid": false, "selectAll": true, "selectAllLabel": "Select all options"} | Enable multi-select. Parameters Description: | - |
multiSelectEntireAreaTrigger | boolean | true | The entire Text box area can be triggered. Valid when | - |
multiSelectSelectedItemOnlyStatus | JSON Object | {"itemsLabel":"{num} Selected","allItemsLabel":"All Content ({num})","noneLabel":"No items selected"} | Let the selected options only display the status without detailed options. It is not recommended for search to trigger request. The {num} is a placeholder which will be automatically replaced by a number. Valid when | - |
depth | number | 1055 | Set the depth value of the control to control the display of the pop-up layer appear above. Please set it when multiple controls are used at the same time. | - |
winWidth | number | function | auto | Set the container width of options. Such as: 500px or () => window.innerWidth/2 + 'px' | - |
extractValueByBrackets | boolean | true | Whether to use square brackets to save result and initialize default value. | - |
defaultValue | string | JSON Object | - | Specifies the default value. Use when the component is not controlled. It does not re-render the component because the incoming value changes. If it is a multi-select (the multiSelect property exists), the default value will be used like [value-1][value-2]. If If you use objects, you can default to values that do not exist in the option list. such as | - |
value | string | JSON Object | - | Set a default value for this control. If it is a multi-select (the multiSelect property exists), the default value will be used like [value-1][value-2]. If If you use objects, you can default to values that do not exist in the option list. such as | - |
label | string | ReactNode | - | It is used to specify a label for an element of a form.Support html tags | - |
name | string | - | Name is not deprecated when used with form fields. | - |
placeholder | string | - | Specifies a short hint that describes. | - |
autoComplete | string | off | The autocomplete attribute provides a hint to the user agent specifying how to, or indeed whether to, prefill a form control. | - |
autoCapitalize | string | off | The autocapitalize property of the HTMLElement interface represents the element's capitalization behavior for user input. | - |
spellCheck | boolean | false | The spellcheck global attribute is an enumerated attribute that defines whether the element may be checked for spelling errors. | - |
readOnly | boolean | false | When present, it specifies that this component field is read-only. | - |
disabled | boolean | false | Whether it is disabled | - |
required | boolean | false | When present, it specifies that a field must be filled out before submitting the form. | - |
controlArrow | ReactNode | <svg width="10px" height="10px" viewBox="0 -4.5 20 20"><g stroke="none" strokeWidth="1" fill="none"><g transform="translate(-180.000000, -6684.000000)" className="arrow-fill-g" fill="#a5a5a5"><g transform="translate(56.000000, 160.000000)"><path d="M144,6525.39 L142.594,6524 L133.987,6532.261 L133.069,6531.38 L133.074,6531.385 L125.427,6524.045 L124,6525.414 C126.113,6527.443 132.014,6533.107 133.987,6535 C135.453,6533.594 134.024,6534.965 144,6525.39"></path></g></g></g></svg> | Set an arrow of control | - |
data You could use key (opens in a new tab) instead of it | any | - | Incoming data, you can set the third parameter of onFetch. Changes in the !!!Note: Using | - |
firstRequestAutoExec | boolean | true | The first asynchronous request is automatically executed. If false, trigger the first asynchronous request when the options area is expanded. Valid when the series attribute | - |
fetchTrigger | boolean | false | Use buttons to trigger data queries. | - |
fetchTriggerForDefaultData | JSON Object | null | null | Sets a default data for control's values. (such as {values: ['value-1','value-3'], labels: ['Option 1','Option 3'], queryStrings: ['','']}) Valid when fetchTrigger is true and value is not empty. | - |
fetchNoneInfo | string | - | The text of the data not fetched. | - |
fetchUpdate | boolean | false | When the property is true, every time the input changes or the search button is clicked, a data request will be triggered. | - |
fetchFuncAsync | Constructor | - | A method as a string from the constructor. | - |
fetchFuncMethod | string | - | When the property is true, every time the select changes, a data request will be triggered. The methord must be a Promise Object. | - |
fetchFuncMethodParams | array | - | The parameter passed by the method, it is an array. Note: the first element is a query string, the second element is the number of queried data (usually a number), and then you can increase the third, or fourth, and more parameters. Such as ['',0], ['',99,'string 1','string 2'], ['',99,'string 1','$QUERY_STRING'] There should be at least one parameter which is the query string. | - |
fetchCallback | function | - | Return value from fetchCallback property to format the data of the API callback, which will match the data structure of the component. At the same time it returns the original data, you will use this function and use the return keyword to return a new value. | - |
renderSelectedValue | function | - | Render the selected value. It returns two callback values.
Valid when | - |
onFetch | function | - | Call a function when data is successfully fetched. It returns five callback values.
| - |
onLoad | function | - | Call a function when the component has been rendered completely. It returns three callback values.
| - |
onChange | function | - | Call a function when the value of an HTML element is changed. It returns three callback values.
| - |
onBlur | function | - | Call a function when a user leaves a form field. It returns only one callback value which is the Control Event (Event) | - |
onFocus | function | - | Call a function when an form field gets focus. It returns only one callback value which is the Control Event (Event) | - |
It accepts all props which this control support. Such as style, data-*, tabIndex, id, and so on.
JSON Object Literals configuration properties of the options and callback from fetchCallback:
| Property | Type | Default | Description | Required |
|---|---|---|---|---|
id | string | number | - | Item ID. Valid when the | - |
parent_id | string | number | - | Parent ID of item. Valid when the | - |
label | string | - | Specify the label text for each option. Support html tags. But must have at least a string other than the HTML Tag, because the HTML Tag in this field will be sanitized when assigning the value. such as | ✅ |
listItemLabel | string | - | Specify the label text for pop-up list items. Support html tags | - |
value | string | - | Specify the value for each option | ✅ |
optgroup | array | - | Creates a grouping of options. It will be displayed using the value of label. such as [{"label":"Option 0","value":"value-0","queryString":""},{"label":"Group 1","value":"","queryString":"","optgroup":[{"label":"Option 1","value":"value-1","queryString":""},{"label":"Option 2","value":"value-2","queryString":""}]}] | - |
queryString | string | - | Quick query string, such as Chinese pinyin or English initials | ✅ |
disabled | boolean | - | When present, it specifies that an option should be disabled. | - |
callback | function | - | Click on the callback function for this option. | - |
Create Callback
A successful response returns the details of the callback such as Sample Request Body:
Among them, id, parent_id, label, listItemLabel, value, optgroup, queryString, disabled and callback are attributes used by the system, and other attributes can be added freely.