Developer guideReference
Extension targets
Every pool, container, handle, form, JS module and event, generated by the doctor.
Pools
| Code | Class :: argument | Area | Keys | ACL | Simple or advanced | Since |
|---|---|---|---|---|---|---|
accountant_fee_columns | Mrx\Home\Model\Accountant\DocumentSource::feeColumns | adminhtml | (any) | Magento_Reports::report | simple: Analytics, Export for your accountant | 0.1.0 |
app_categories | Mrx\Apps\Model\Registry::categories | adminhtml | label sort_order icon | none | simple: the Apps page | 0.1.0 |
app_claims | Mrx\Apps\Model\Registry::claims | adminhtml | module app menu_ids config_sections flags mode nav_key route label settings_route | the resources of the claimed menu screens | simple: the Apps page | 0.1.0 |
app_hidden | Mrx\Apps\Model\Registry::hidden_modules | adminhtml | (any) | none | simple: the Apps page | 0.1.0 |
app_pins | Mrx\Apps\Model\Registry::pinned_by_default | adminhtml | (any) | the pinned app's | simple: the pins below the nav | 0.1.0 |
app_vendors | Mrx\Apps\Model\Registry::vendors | adminhtml | (any) | none | simple: the Apps page | 0.1.0 |
apps | Mrx\Apps\Model\Registry::apps | adminhtml | label category icon description labels module entry_route settings_page badge | the resources of its entry page and settings page | simple: the Apps page, pins and the palette | 0.1.0 |
back_link_providers | Mrx\Light\ViewModel\AdvancedView::providers | adminhtml | (any) provider sort_order module | none | advanced: the banner's way back to Light | 0.1.0 |
back_link_sections | Mrx\Light\ViewModel\AdvancedView::sections | adminhtml | label route params match module | none | advanced: the banner's way back to Light | 0.1.0 |
brands | Mrx\Light\Model\Branding\BrandPool::brands | adminhtml | label short_name logo logo.on_light logo.on_dark logo.lockup_on_dark login login.lockup login.lockup_on_dark login.tagline favicon default_theme default_theme.mode default_theme.theme default_theme.light default_theme.dark platform priority module disabled | none | both, and the sign-in page | 0.1.0 |
carriers | Mrx\Orders\Model\Carrier\Carriers::carriers | global | label patterns tracking_url sort_order select_order module disabled | none | simple: the Ship items form, order pages and shipping emails | 0.1.0 |
checkouts_without_pickup | Mrx\Home\Model\Todo\Counter\PickupCheckoutMissing::checkoutsWithoutPickup | adminhtml | (any) | none | simple: Home | 0.2.0 |
config_sections | Mrx\Settings\Model\Redirect\ConfigSections::pages | adminhtml | (any) page module | the settings page's | advanced: the stock section opens the Light page in simple mode | 0.1.0 |
country_rules | Mrx\Settings\Model\Country\CountryRules::rules | global | business_id tax_id postcode module | none | simple: Settings > Business details and Shipping, keyed by country code | 0.1.0 |
customer_timeline | Mrx\Customers\Model\Timeline::providers | adminhtml | (object) | the provider's own checks | simple: the customer page | 0.1.0 |
document_sections | Mrx\Documents\Model\Pdf\Sections::sections | global | section document position sort_order module | the document type's getAclResource() | simple: a block after the parties, items or totals of a PDF document | 0.1.0 |
documents | Mrx\Documents\Model\Pdf\DocumentTypes::types | global | (any) type module sort_order | the type's getAclResource() | simple: print buttons, bulk actions, attachments | 0.1.0 |
email_previews | Mrx\Settings\Model\CustomerEmails\EmailPreview::providers | adminhtml | (object) | the same as the email's entry in "emails" | simple: Settings > Customer emails, keyed by email code | 0.1.0 |
emails | Mrx\Settings\Model\CustomerEmails\Emails::emails | global | label description enabled identity template locked sort_order resource module placeholders subject intro preview_vars sender note button group | resource | simple: Settings > Customer emails | 0.1.0 |
form_extensions | Mrx\Light\Model\Form\ExtensionPool::extensions | adminhtml | (nested) extension resource | resource | simple: the Light editors | 0.1.0 |
formats | Mrx\Documents\Model\Format\Formats::formats | global | label description email_inline_css pdf_css thumbnail sort_order module | none | simple: Settings > Emails & documents | 0.1.0 |
header_actions | Mrx\Light\Model\PageHeader\ActionPool::actions | adminhtml | (nested) label route params icon resource module advanced sort_order condition target | resource | simple: the page header; advanced opens the advanced view | 0.1.0 |
icons | Mrx\Light\ViewModel\Icons::paths | adminhtml | (any) | none | simple | 0.1.0 |
item_lines | Mrx\Documents\Model\Pdf\ItemLines::lines | global | (object) | the document type's getAclResource() | simple: the items table of order confirmation, invoice and credit memo PDFs | 0.1.0 |
legal_page_templates | Mrx\Settings\Model\LegalPages\Templates::templates | adminhtml | (nested) title identifier file placeholder variables module | Magento_Config::config | simple: Settings > Legal pages | 0.1.0 |
legal_page_types | Mrx\Settings\Model\LegalPages\LegalPageManager::types | adminhtml | label description sort_order languages module | Magento_Config::config | simple: Settings > Legal pages | 0.1.0 |
locales | Mrx\Light\Model\Locale\FormOfAddress::locales | global | default informal formal module | none | both: the channel page's Addressing column, and customer text, keyed by locale | 0.1.0 |
nav_badge_providers | Mrx\Light\Model\Navigation\BadgePool::providers | adminhtml | item provider resource module rollup ttl sort_order | the provider's resource, else the nav item's | simple: the Light shell | 0.1.0 |
nav_badges | Mrx\Light\Model\Navigation\BadgePool::badges | adminhtml | (any) | the nav item's resource | simple: the Light shell | 0.1.0 |
nav_items | Mrx\Light\Model\Navigation\Config::items | adminhtml | label route url params resource sort_order icon parent position shortcut match fallback_route fallback_params disabled module advanced | resource | simple: the Light shell; advanced opens the advanced view | 0.1.0 |
nav_providers | Mrx\Light\Model\Navigation\Config::providers | adminhtml | (object) | the provider's own checks | simple: the Light shell | 0.1.0 |
order_actions | Mrx\Orders\Model\Order\ActionPool::actions | adminhtml | label route params id attributes icon tone resource module slot sort_order condition | resource | simple: the order page | 0.1.0 |
order_timeline | Mrx\Orders\Model\Timeline::providers | adminhtml | (object) | the provider's own checks | simple: the order page | 0.1.0 |
order_totals | Mrx\Orders\Model\Order\TotalsPool::providers | adminhtml | (object) | the provider's own checks | simple: the order page | 0.1.0 |
page_templates | Mrx\Content\Model\Page\Template\TemplatePool::templates | adminhtml | label title description icon file sort_order visible module | Magento_Cms::page | simple: Content > Pages, Add page | 0.1.0 |
palette_actions | Mrx\Light\Model\Search\Group\Actions::actions | adminhtml | label route params resource module keywords icon subtitle sort_order command advanced target | resource, and the ACL of the controller behind route | simple: the palette; advanced opens the advanced view, command runs a JS module instead of a page | 0.1.0 |
palette_destinations | Mrx\Light\Model\Search\Group\Destinations::destinations | adminhtml | label route params resource module keywords icon subtitle sort_order advanced | resource | simple: the palette; advanced opens the advanced view | 0.1.0 |
palette_groups | Mrx\Light\Model\Search\GroupPool::groups | adminhtml | (object) | the group's own checks | simple: the palette | 0.1.0 |
payment_providers | Mrx\Settings\Model\Payments\ProviderDetector::providers | adminhtml | label prefix own_section state card logo description dashboard_url config_section advanced_section resource sort_order module | none | simple: Settings > Payments and the order page | 0.1.0 |
payment_switches | Mrx\Orders\Model\Payment\OnlineMethods::switches | global | (any) | none: a store setting | simple: Settings > Payments | 0.1.0 |
pick_locations | Mrx\Documents\Model\Pdf\PickLocations::locations | global | (object) | Magento_Sales::actions_view, the picklist's | simple: the picklist's Location column and sort; any object implementing PickLocationInterface | 0.1.0 |
prefer_phrases | Mrx\Light\Plugin\Translation\PreferModulePhrases::phrases | global | (nested) phrase module | none | both: the dictionary of every area, keyed by locale | 0.1.0 |
redirects | Mrx\Light\Model\Redirect\Map::redirects | adminhtml | route params query condition resolver one_way module | the Light page's own | advanced: a stock screen opens its Light page in simple mode | 0.1.0 |
role_areas | Mrx\Settings\Model\Users\RoleAreas::areas | global | label description resources exclude sort_order | none: it grants resources | simple: Settings > Users | 0.1.0 |
role_presets | Mrx\Settings\Model\Users\RolePresets::presets | global | name description resources areas sort_order | none: it grants resources | simple: Settings > Users | 0.1.0 |
settings_cards | Mrx\Settings\ViewModel\SettingsList::items | adminhtml | label description icon route params page resource module sort_order group section type advanced | resource | simple: Settings; advanced opens the advanced view | 0.1.0 |
settings_groups | Mrx\Settings\ViewModel\SettingsList::sections | adminhtml | label sort_order | none | simple: Settings | 0.1.0 |
settings_pages | Mrx\Settings\Model\Page\Pool::pages | adminhtml | (any) label section description icon simple advanced labels notes validator resource cache_types module developer_fixture | resource, and Magento_Config::config | simple: Settings and Settings > Apps | 0.1.0 |
setup_steps | Mrx\Home\Model\Setup\SetupGuide::steps | adminhtml | title description action_label route resource check sort_order fallback_route fragment target module description_provider | the step's own checks | simple: Home | 0.1.0 |
table_extensions | Mrx\Light\Model\IndexTable\ExtensionPool::extensions | adminhtml | (nested) | the list provider's getAclResource() | simple: the Light lists | 0.1.0 |
table_providers | Mrx\Light\Model\IndexTable\ProviderPool::providers | adminhtml | (object) | getAclResource() | simple: the Light lists | 0.1.0 |
themes | Mrx\Themes\Model\ThemePool::themes | adminhtml | label description scheme parent css fonts swatches preview sort_order platform module disabled | none | both: the admin's colours | 0.1.0 |
todos | Mrx\Home\Model\Todo\TodoList::items | adminhtml | counter badge label_one label_many route table query resource icon tone sort_order module | resource | simple: Home | 0.1.0 |
Containers
| Container | Handle | Context | ACL | Simple or advanced | Since |
|---|---|---|---|---|---|
mrx.advanced.user.menu | mrx_advanced | none: every admin | advanced: the stock admin's account menu | 0.1.0 | |
mrx.analytics.cards | light_analytics_index | Magento_Reports::salesroot_sales | simple: Analytics | 0.1.0 | |
mrx.category.form.aside.bottom | light_categories_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Catalog::categories | simple: the category editor | 0.1.0 |
mrx.category.form.main.bottom | light_categories_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Catalog::categories | simple: the category editor | 0.1.0 |
mrx.cms_block.form.main.bottom | mrx_content_block_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Cms::block | simple: the block editor | 0.1.0 |
mrx.cms_page.form.aside.bottom | mrx_content_page_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Cms::page | simple: the page editor | 0.1.0 |
mrx.cms_page.form.main.bottom | mrx_content_page_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Cms::page | simple: the page editor | 0.1.0 |
mrx.customer.aside.bottom | light_customers_view | Mrx\Customers\Api\CustomerPageContextInterface | Magento_Customer::manage | simple: the customer page | 0.1.0 |
mrx.customer.contact.form.bottom | light_customers_view | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Customer::manage | simple: the customer page's contact form | 0.1.0 |
mrx.customer.main.bottom | light_customers_view | Mrx\Customers\Api\CustomerPageContextInterface | Magento_Customer::manage | simple: the customer page | 0.1.0 |
mrx.customer.new.main.bottom | light_customers_new | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Customer::manage | simple: the new customer form | 0.1.0 |
mrx.discount.form.aside.bottom | mrx_discounts_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_SalesRule::quote | simple: the discount editor | 0.1.0 |
mrx.discount.form.main.bottom | mrx_discounts_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_SalesRule::quote | simple: the discount editor | 0.1.0 |
mrx.home.top | light_home_index | Magento_Backend::dashboard | simple: Home | 0.4.0 | |
mrx.home.widgets | light_home_index | Magento_Backend::dashboard | simple: Home | 0.1.0 | |
mrx.order.aside.bottom | light_orders_view | Mrx\Orders\Api\OrderPageContextInterface | Magento_Sales::actions_view | simple: the order page | 0.1.0 |
mrx.order.aside.top | light_orders_view | Mrx\Orders\Api\OrderPageContextInterface | Magento_Sales::actions_view | simple: the order page | 0.1.0 |
mrx.order.main.before_timeline | light_orders_view | Mrx\Orders\Api\OrderPageContextInterface | Magento_Sales::actions_view | simple: the order page | 0.1.0 |
mrx.order.main.top | light_orders_view | Mrx\Orders\Api\OrderPageContextInterface | Magento_Sales::actions_view | simple: the order page | 0.1.0 |
mrx.product.form.aside.bottom | light_products_form | Mrx\Catalog\Api\ProductPageContextInterface | Magento_Catalog::products | simple: the product editor | 0.1.0 |
mrx.product.form.main.after_pricing | light_products_form | Mrx\Light\Api\Form\CurrentFormInterface | Magento_Catalog::products | simple: the product editor | 0.1.0 |
mrx.product.form.main.bottom | light_products_form | Mrx\Catalog\Api\ProductPageContextInterface | Magento_Catalog::products | simple: the product editor | 0.1.0 |
mrx.return.view.aside.bottom | light_returns_view | MageOS_RMA::rma_manage | simple: the return page | 0.1.0 | |
mrx.settings.after | mrx_settings_page | Magento_Config::config | simple: every Settings page | 0.1.0 | |
mrx.settings.business.registration | light_settings_business | Magento_Config::config | simple: Settings > Business details, the Business address card, below the tax ID and registration number. Display cards only; the page saves only its own fields, so a card that needs input posts to its own controller (spec 6.1) or links to its own schema page | 0.1.0 | |
mrx.settings.payments.providers | light_settings_payments | Magento_Config::config | simple: Settings > Payments, in the Online payments band after the provider cards, outside the Payments form. Display cards only; a card that needs input posts to its own controller | 0.1.0 | |
mrx.settings.taxes.cross_border | light_settings_taxes | Magento_Tax::config_tax and Magento_Tax::manage_tax | simple: Settings > Taxes, first inside the form: cards on sales abroad. Display cards only; the page saves only its own fields, so a card that needs input posts to its own controller (spec 6.1) or links to its own schema page | 0.1.0 | |
mrx.settings.taxes.preset | light_settings_taxes | Magento_Tax::config_tax and Magento_Tax::manage_tax | simple: Settings > Taxes, above the form: a country's tax setup card. Display cards only; a card that needs input posts to its own controller (spec 6.1) or links to its own schema page | 0.1.0 | |
mrx.topbar.user.menu | mrx_simple | none: every admin | simple: the top bar's account menu | 0.1.0 |
Handles
| Handle | Since |
|---|---|
light_settings_app_{code} | 0.1.0 |
light_settings_{code} | 0.1.0 |
mrx_advanced | 0.1.0 |
mrx_orders_email_pickup | 0.1.0 |
mrx_settings_page | 0.1.0 |
mrx_simple | 0.1.0 |
Forms
| Form | Entity | Since |
|---|---|---|
category | Magento\Catalog\Api\Data\CategoryInterface | 0.1.0 |
cms_block | Magento\Cms\Api\Data\BlockInterface | 0.1.0 |
cms_page | Magento\Cms\Api\Data\PageInterface | 0.1.0 |
customer | Magento\Customer\Api\Data\CustomerInterface | 0.1.0 |
customer_new | Magento\Customer\Api\Data\CustomerInterface | 0.1.0 |
discount | Magento\SalesRule\Api\Data\RuleInterface | 0.1.0 |
product | Magento\Catalog\Api\Data\ProductInterface | 0.1.0 |
JS modules
| Module | Exports | #mrx-config keys | Since |
|---|---|---|---|
Mrx_Light/js/api | ApiError request get post | 0.1.0 | |
Mrx_Light/js/config | get url all | mode stockView apiVersion locale currency timezone storeName sender user canContact urls nav shortcuts channels icons | 0.1.0 |
Mrx_Light/js/form-hooks | register validate extend saved | 0.1.0 | |
Mrx_Light/js/format | money number parse date relative dateShort dateTime time hydrate | 0.1.0 | |
Mrx_Light/js/loader | during button skeleton spinner | 0.1.0 | |
Mrx_Light/js/modal | open confirm isOpen | 0.1.0 | |
Mrx_Light/js/save-bar | attach get | 0.1.0 | |
Mrx_Light/js/toast | show error | 0.1.0 |
Events
| Event | Kind | Detail | Since |
|---|---|---|---|
mrx:badges | dom | items | 0.1.0 |
mrx:channelschange | dom | ids level card | 0.1.0 |
mrx:customer-message-sent | dom | options response | 0.1.0 |
mrx:form-saved | dom | formCode entityId response | 0.1.0 |
mrx:languagebeforechange | dom | storeId previousStoreId option switcher | 0.1.0 |
mrx:languagechange | dom | storeId previousStoreId option switcher | 0.1.0 |
mrx:product-saved | dom | success message product entity_id ext | 0.1.0 |
mrx:ready | dom | 0.1.0 | |
mrx:tabchange | dom | tab panel | 0.1.0 |
mrx:themechange | dom | source state | 0.1.0 |
mrx:themepreference | dom | state | 0.1.0 |
mrx_return_resolved_after | server | return | 0.1.0 |
Last updated on