New Feature for developers: Copyable cells in grids

[kiatng]

Description (*)

Add copyable property to grid column. When the property is set to true, render the clickable copy icon in the cell:

Related Pull Requests

See the main PR #3960 that renders the copy icon and the js that copies the target text. See the enhanced PR #4019 that copies text in the grid without navigating to the edit/view page.

Manual testing scenarios (*)

On any grid class, set 'copyable' => true,`; for example

class Company_Module_Block_Adminhtml_Sales_Order_Grid extends Mage_Adminhtml_Block_Sales_Order_Grid
{
    protected function _prepareColumns()
    {
        // ...
        parent::_prepareColumns();
        $this->getColumn('real_order_id')->setCopyable(true); // Using setter.

        $this->addColumnAfter('ext_order_id', [
            'header'    => $this->__('STARS Order#'),
            'index'     => 'ext_order_id',
            'copyable'  => true, // Normal use.
        ], 'store_id');
       // ...

Comments

In order for the legacy theme to work, I copy the related CSS from the openmage theme to the default/boxes.css.

[kiatng]

Question: should the js be moved from js\varien\js.js to js\mage\adminhtml\tools.js since it's only available in backend.

[fballiano]

@kiatng probably yes, I don't see that function be helpful on the frontend :-)

[luigifab]

Beautiful!

[fballiano]

don't know if i'm seing this right but, at it is now, what was implemented in https://github.com/OpenMage/magento-lts/pull/3960 doesn't seem to work anymore, I don't see any copy-icons in the sales-order page

[fballiano]

my fault, sorry, without HTTPS navigator.clipboard is disabled so the whole thing doesn't work.

I don't remember how I tested this feature previously :-\

[kiatng]

Modern browsers require https to access the clipboard. For insecure http, you need to use Chrome. In the address bar, enter "chrome://flags/#Insecure-origins-treated-as-secure". Then input the URLs separated with a space in the box of Insecure origins treated as secure

[fballiano]

tested, working perfectly

[fballiano]

since we didn't get any more feedback I'll merge