Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.
You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page
This ToggleColumn is used to display booleans, it will display an icon instead of the value. If the user clicks on it, this triggers a toggle of the boolean value.
Warning: the ajax call trigger is subordinated to the loading of the relative js extension (ColumnTogglingExtension). That is not automatic but have to be done manually if the grid does not have any other Toggle Column by default. You can use the global component to load the extension.
| Properties | Type | Expected value |
|---|---|---|
| field | string | required The record field name that the column displays. |
| primary_field | string | required The record field name that the column displays. |
| route | string | required The route used to generated link url. |
| route_param_name | string | required The parameter name used by the route to generate the url. |
<?php
use PrestaShop\PrestaShop\Core\Grid\Column\Type\Common\ToggleColumn;
use PrestaShop\PrestaShop\Core\Grid\Column\ColumnCollection;
$toggleColumn = new ToggleColumn('active');
$toggleColumn->setName('Enabled');
$toggleColumn->setOptions([
'field' => 'active',
'primary_field' => 'id_customer',
'route' => 'admin_customers_toggle_status',
'route_param_name' => 'customerId',
]);
$columns = new ColumnCollection();
$columns->add($toggleColumn);