How to make a dropdown config option for a Magento 2 extension?

dmitry_fedyuk · November 13, 2015, 11:00am

See an example from the core: «Catalog» → «Storefront» → «List Mode»

The field XML declaration is:

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Catalog/etc/adminhtml/system.xml#L39-L42


<field id="list_mode" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
    <label>List Mode</label>
    <source_model>Magento\Catalog\Model\Config\Source\ListMode</source_model>
</field>

Take note of:

type="select". It defined the dropdown control.
<source_model>Magento\Catalog\Model\Config\Source\ListMode</source_model>. It defined the dropdown items.

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Catalog/Model/Config/Source/ListMode.php#L8-L24


class ListMode implements \Magento\Framework\Option\ArrayInterface
{
/**
 * {@inheritdoc}
 *
 * @codeCoverageIgnore
 */
public function toOptionArray()
{
    return [
        ['value' => 'grid', 'label' => __('Grid Only')],
        ['value' => 'list', 'label' => __('List Only')],
        ['value' => 'grid-list', 'label' => __('Grid (default) / List')],
        ['value' => 'list-grid', 'label' => __('List (default) / Grid')]
    ];
}
}

Gabe · November 19, 2015, 1:04pm

RC2 and after this method doesn’t work.
Any ideas why?

To be honest for me M2 doesn’t recognize right now ANY class that I declare in my module.
Just like a model\source\ file, \Helper\Data.php also goes unrecognized.

Thanks in advance!

dmitry_fedyuk · November 19, 2015, 1:07pm

The method described in the article works well with the both Release Candidates and with the Release.