Magento 2: How to add optgroup to select dropdown

Question

In my ui-select fields I want to sort my options by different optgroups like: enter image description here

Source model location is Vendor/Model/Source/Model.php and it has the function for options as below

public function getAllOptions()
{
 if (empty($this->options)) {
 $options = [];
 $searchCriteria = $this->searchCriteriaBuilder->create();
 $searchResults = $this->ghscategoryRepository->getList($searchCriteria);
 foreach ($searchResults->getItems() as $ghscategory) {
 $options[] = [
 'value' => $ghscategory->getGhscategoryId(),
 'label' => $ghscategory->getGhs_category_code(),
 ];
 }
 $this->options = $options;
 }
 return $this->options;
}

Can I edit the options array and add optgroups?

If not here, which file/files I have to edit to add my optgroups?

• Suman Singh: Vendor/Model/Source/Model.php path is incomplete, there should be a module name
• Dr. Christian Kusche: Sorry, you are right. Vendor/Modulename/Source/Modulename.php
• Dr. Christian Kusche: But my question is still the same

Answer 1

In same file create your option array like this

$optionGroup = [
 [
 'label' => 'Option group1 lable',
 'value' => [
 [
 'label' => 'group 1 option 1',
 'value' => 'group1-value1'
 ],
 [
 'label' => 'group 1 option2',
 'value' => 'group 1 value2'
 ],
 ],
 ],
 [
 'label' => 'Option group2 lable',
 'value' => [
 [
 'label' => 'group 2 option 1',
 'value' => 'group2-value1'
 ],
 [
 'label' => 'group 2 option2',
 'value' => 'group2-value2'
 ],
 ],
 ]
];

and return this array it will create drop down with option group.

• Dr. Christian Kusche: Hi,thank you for your awnser. I am not sure, where I have to add this code.Do I have to replace the array "options" by the new array "optionGroup"???
• Rakesh Varma: You have to just modify your area structure of $options like I have in my $optionGroup.
• Rakesh Varma: You can also use the my $optionGroup array and return it instead of $options for testing if it will give you perfect output then change the values as you want.
• Dr. Christian Kusche: Thank, the sample is allways working. Now I will try with my values.
• Rakesh Varma: Okay if it's work with your values too then accept the answer so it will help others

Answer 2

Just to complete the answer: if you want to add a "Choose" line you only have to add a line at the beginning of your $optionGroup array, like this:

$optionGroup = [
 ['value' => "Choose", 'label' => __("Choose...")],
 [
 'label' => 'Option group1 lable',
 'value' => [
 [
 'label' => 'group 1 option 1',
 'value' => 'group1-value1'
 ],
 [
 'label' => 'group 1 option2',
 'value' => 'group 1 value2'
 ],
 ],
 ],
 ...
];