Home to-dos, setup steps and widgets

1. A to-doCopy Anchor Link

A TodoList item (pool todos) in etc/adminhtml/di.xml has a count, two labels, and where it links. The count comes from a counter class that implements CounterInterface, as the core to-dos do:

<item name="orders_to_ship" xsi:type="array">
    <item name="counter" xsi:type="object">Mrx\Home\Model\Todo\Counter\OrdersToShip</item>
    <item name="label_one" xsi:type="string" translate="true">%1 order to ship</item>
    <item name="label_many" xsi:type="string" translate="true">%1 orders to ship</item>

Or it names badge, a nav item key, and shows the nav counter's count, from the same cache (A nav item with a counter). The pilot's to-do does that:

<item name="label_many" xsi:type="string" translate="true">%1 account requests to review</item>

A counter that implements ChannelAwareCounterInterface counts per channel when the merchant filters Home by channel (Channels and store views).

The keys this recipe uses; Extension targets lists every key of todos:

2. A setup stepCopy Anchor Link

A SetupGuide item (pool setup_steps) has a title, a description, an action and a check class that implements SetupCheckInterface; the step disappears once the check says it is done:

<item name="check" xsi:type="object">Mrx\Home\Model\Setup\Check\HasProducts</item>

public function isComplete(): bool;

A step's link takes fallback_route, fragment (an anchor on the target page) and target.

A description that depends on the store (the names of the installed payment providers, say) comes from a description_provider object that implements SetupDescriptionInterface; when it returns '', the step shows its own description:

public function getDescription(): string;

3. A widgetCopy Anchor Link

A block in the container mrx.home.widgets, in your layout file for the handle light_home_index. Draw it as a .mrx-card, and render nothing when there is nothing to say. Cards for the Analytics page go in its container mrx.analytics.cards the same way:

<referenceContainer name="mrx.home.widgets">

The Home page has two containers. Pick by what the block is:

A banner goes in with <referenceContainer name="mrx.home.top"> in the same layout file, as a .mrx-card block with an aclResource. Home declares the container right after the setup guide:

<container name="mrx.home.top" as="top">
    <block class="Mrx\Light\Block\SlotOutline" name="mrx.home.top.outline"/>
</container>

Home draws no wrapper around the container and spaces its blocks with its own gap, so a banner that renders nothing leaves Home exactly as it was. Render nothing while your module has nothing to offer: its own module off, a setting not filled in.

Add ?mrx_slots=1 to Home's URL in developer mode to see both containers outlined.

4. A payment fee in the accountant exportCopy Anchor Link

"Export for your accountant" on Analytics lists every invoice and credit memo of a period. A payment module that adds its own fee to those documents (a column on sales_invoice and on sales_creditmemo, and a second column for the VAT on it) names both columns in the pool accountant_fee_columns, an argument feeColumns of Mrx\Home\Model\Accountant\DocumentSource, in etc/adminhtml/di.xml. The key is the fee column and the value the column with its VAT. Mrx_PaymentsMollie adds Mollie's:

<item name="base_mollie_payment_fee" xsi:type="string">base_mollie_payment_fee_tax</item>

The export adds up the fees of all pairs into one fee column and their VAT into fee_tax. A pair whose table lacks either column is skipped, and null as a value removes another module's pair.