Light API 0.4.0 is a public beta: a minor release such as 0.5.0 may still break. What that means for your module
Light
Developer guideReference

Extension targets

Every pool, container, handle, form, JS module and event, generated by the doctor.

Pools

CodeClass :: argumentAreaKeysACLSimple or advancedSince
accountant_fee_columnsMrx\Home\Model\Accountant\DocumentSource::feeColumnsadminhtml(any)Magento_Reports::reportsimple: Analytics, Export for your accountant0.1.0
app_categoriesMrx\Apps\Model\Registry::categoriesadminhtmllabel sort_order iconnonesimple: the Apps page0.1.0
app_claimsMrx\Apps\Model\Registry::claimsadminhtmlmodule app menu_ids config_sections flags mode nav_key route label settings_routethe resources of the claimed menu screenssimple: the Apps page0.1.0
app_hiddenMrx\Apps\Model\Registry::hidden_modulesadminhtml(any)nonesimple: the Apps page0.1.0
app_pinsMrx\Apps\Model\Registry::pinned_by_defaultadminhtml(any)the pinned app'ssimple: the pins below the nav0.1.0
app_vendorsMrx\Apps\Model\Registry::vendorsadminhtml(any)nonesimple: the Apps page0.1.0
appsMrx\Apps\Model\Registry::appsadminhtmllabel category icon description labels module entry_route settings_page badgethe resources of its entry page and settings pagesimple: the Apps page, pins and the palette0.1.0
back_link_providersMrx\Light\ViewModel\AdvancedView::providersadminhtml(any) provider sort_order modulenoneadvanced: the banner's way back to Light0.1.0
back_link_sectionsMrx\Light\ViewModel\AdvancedView::sectionsadminhtmllabel route params match modulenoneadvanced: the banner's way back to Light0.1.0
brandsMrx\Light\Model\Branding\BrandPool::brandsadminhtmllabel 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 disablednoneboth, and the sign-in page0.1.0
carriersMrx\Orders\Model\Carrier\Carriers::carriersgloballabel patterns tracking_url sort_order select_order module disablednonesimple: the Ship items form, order pages and shipping emails0.1.0
checkouts_without_pickupMrx\Home\Model\Todo\Counter\PickupCheckoutMissing::checkoutsWithoutPickupadminhtml(any)nonesimple: Home0.2.0
config_sectionsMrx\Settings\Model\Redirect\ConfigSections::pagesadminhtml(any) page modulethe settings page'sadvanced: the stock section opens the Light page in simple mode0.1.0
country_rulesMrx\Settings\Model\Country\CountryRules::rulesglobalbusiness_id tax_id postcode modulenonesimple: Settings > Business details and Shipping, keyed by country code0.1.0
customer_timelineMrx\Customers\Model\Timeline::providersadminhtml(object)the provider's own checkssimple: the customer page0.1.0
document_sectionsMrx\Documents\Model\Pdf\Sections::sectionsglobalsection document position sort_order modulethe document type's getAclResource()simple: a block after the parties, items or totals of a PDF document0.1.0
documentsMrx\Documents\Model\Pdf\DocumentTypes::typesglobal(any) type module sort_orderthe type's getAclResource()simple: print buttons, bulk actions, attachments0.1.0
email_previewsMrx\Settings\Model\CustomerEmails\EmailPreview::providersadminhtml(object)the same as the email's entry in "emails"simple: Settings > Customer emails, keyed by email code0.1.0
emailsMrx\Settings\Model\CustomerEmails\Emails::emailsgloballabel description enabled identity template locked sort_order resource module placeholders subject intro preview_vars sender note button groupresourcesimple: Settings > Customer emails0.1.0
form_extensionsMrx\Light\Model\Form\ExtensionPool::extensionsadminhtml(nested) extension resourceresourcesimple: the Light editors0.1.0
formatsMrx\Documents\Model\Format\Formats::formatsgloballabel description email_inline_css pdf_css thumbnail sort_order modulenonesimple: Settings > Emails & documents0.1.0
header_actionsMrx\Light\Model\PageHeader\ActionPool::actionsadminhtml(nested) label route params icon resource module advanced sort_order condition targetresourcesimple: the page header; advanced opens the advanced view0.1.0
iconsMrx\Light\ViewModel\Icons::pathsadminhtml(any)nonesimple0.1.0
item_linesMrx\Documents\Model\Pdf\ItemLines::linesglobal(object)the document type's getAclResource()simple: the items table of order confirmation, invoice and credit memo PDFs0.1.0
legal_page_templatesMrx\Settings\Model\LegalPages\Templates::templatesadminhtml(nested) title identifier file placeholder variables moduleMagento_Config::configsimple: Settings > Legal pages0.1.0
legal_page_typesMrx\Settings\Model\LegalPages\LegalPageManager::typesadminhtmllabel description sort_order languages moduleMagento_Config::configsimple: Settings > Legal pages0.1.0
localesMrx\Light\Model\Locale\FormOfAddress::localesglobaldefault informal formal modulenoneboth: the channel page's Addressing column, and customer text, keyed by locale0.1.0
nav_badge_providersMrx\Light\Model\Navigation\BadgePool::providersadminhtmlitem provider resource module rollup ttl sort_orderthe provider's resource, else the nav item'ssimple: the Light shell0.1.0
nav_badgesMrx\Light\Model\Navigation\BadgePool::badgesadminhtml(any)the nav item's resourcesimple: the Light shell0.1.0
nav_itemsMrx\Light\Model\Navigation\Config::itemsadminhtmllabel route url params resource sort_order icon parent position shortcut match fallback_route fallback_params disabled module advancedresourcesimple: the Light shell; advanced opens the advanced view0.1.0
nav_providersMrx\Light\Model\Navigation\Config::providersadminhtml(object)the provider's own checkssimple: the Light shell0.1.0
order_actionsMrx\Orders\Model\Order\ActionPool::actionsadminhtmllabel route params id attributes icon tone resource module slot sort_order conditionresourcesimple: the order page0.1.0
order_timelineMrx\Orders\Model\Timeline::providersadminhtml(object)the provider's own checkssimple: the order page0.1.0
order_totalsMrx\Orders\Model\Order\TotalsPool::providersadminhtml(object)the provider's own checkssimple: the order page0.1.0
page_templatesMrx\Content\Model\Page\Template\TemplatePool::templatesadminhtmllabel title description icon file sort_order visible moduleMagento_Cms::pagesimple: Content > Pages, Add page0.1.0
palette_actionsMrx\Light\Model\Search\Group\Actions::actionsadminhtmllabel route params resource module keywords icon subtitle sort_order command advanced targetresource, and the ACL of the controller behind routesimple: the palette; advanced opens the advanced view, command runs a JS module instead of a page0.1.0
palette_destinationsMrx\Light\Model\Search\Group\Destinations::destinationsadminhtmllabel route params resource module keywords icon subtitle sort_order advancedresourcesimple: the palette; advanced opens the advanced view0.1.0
palette_groupsMrx\Light\Model\Search\GroupPool::groupsadminhtml(object)the group's own checkssimple: the palette0.1.0
payment_providersMrx\Settings\Model\Payments\ProviderDetector::providersadminhtmllabel prefix own_section state card logo description dashboard_url config_section advanced_section resource sort_order modulenonesimple: Settings > Payments and the order page0.1.0
payment_switchesMrx\Orders\Model\Payment\OnlineMethods::switchesglobal(any)none: a store settingsimple: Settings > Payments0.1.0
pick_locationsMrx\Documents\Model\Pdf\PickLocations::locationsglobal(object)Magento_Sales::actions_view, the picklist'ssimple: the picklist's Location column and sort; any object implementing PickLocationInterface0.1.0
prefer_phrasesMrx\Light\Plugin\Translation\PreferModulePhrases::phrasesglobal(nested) phrase modulenoneboth: the dictionary of every area, keyed by locale0.1.0
redirectsMrx\Light\Model\Redirect\Map::redirectsadminhtmlroute params query condition resolver one_way modulethe Light page's ownadvanced: a stock screen opens its Light page in simple mode0.1.0
role_areasMrx\Settings\Model\Users\RoleAreas::areasgloballabel description resources exclude sort_ordernone: it grants resourcessimple: Settings > Users0.1.0
role_presetsMrx\Settings\Model\Users\RolePresets::presetsglobalname description resources areas sort_ordernone: it grants resourcessimple: Settings > Users0.1.0
settings_cardsMrx\Settings\ViewModel\SettingsList::itemsadminhtmllabel description icon route params page resource module sort_order group section type advancedresourcesimple: Settings; advanced opens the advanced view0.1.0
settings_groupsMrx\Settings\ViewModel\SettingsList::sectionsadminhtmllabel sort_ordernonesimple: Settings0.1.0
settings_pagesMrx\Settings\Model\Page\Pool::pagesadminhtml(any) label section description icon simple advanced labels notes validator resource cache_types module developer_fixtureresource, and Magento_Config::configsimple: Settings and Settings > Apps0.1.0
setup_stepsMrx\Home\Model\Setup\SetupGuide::stepsadminhtmltitle description action_label route resource check sort_order fallback_route fragment target module description_providerthe step's own checkssimple: Home0.1.0
table_extensionsMrx\Light\Model\IndexTable\ExtensionPool::extensionsadminhtml(nested)the list provider's getAclResource()simple: the Light lists0.1.0
table_providersMrx\Light\Model\IndexTable\ProviderPool::providersadminhtml(object)getAclResource()simple: the Light lists0.1.0
themesMrx\Themes\Model\ThemePool::themesadminhtmllabel description scheme parent css fonts swatches preview sort_order platform module disablednoneboth: the admin's colours0.1.0
todosMrx\Home\Model\Todo\TodoList::itemsadminhtmlcounter badge label_one label_many route table query resource icon tone sort_order moduleresourcesimple: Home0.1.0

Containers

ContainerHandleContextACLSimple or advancedSince
mrx.advanced.user.menumrx_advancednone: every adminadvanced: the stock admin's account menu0.1.0
mrx.analytics.cardslight_analytics_indexMagento_Reports::salesroot_salessimple: Analytics0.1.0
mrx.category.form.aside.bottomlight_categories_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Catalog::categoriessimple: the category editor0.1.0
mrx.category.form.main.bottomlight_categories_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Catalog::categoriessimple: the category editor0.1.0
mrx.cms_block.form.main.bottommrx_content_block_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Cms::blocksimple: the block editor0.1.0
mrx.cms_page.form.aside.bottommrx_content_page_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Cms::pagesimple: the page editor0.1.0
mrx.cms_page.form.main.bottommrx_content_page_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Cms::pagesimple: the page editor0.1.0
mrx.customer.aside.bottomlight_customers_viewMrx\Customers\Api\CustomerPageContextInterfaceMagento_Customer::managesimple: the customer page0.1.0
mrx.customer.contact.form.bottomlight_customers_viewMrx\Light\Api\Form\CurrentFormInterfaceMagento_Customer::managesimple: the customer page's contact form0.1.0
mrx.customer.main.bottomlight_customers_viewMrx\Customers\Api\CustomerPageContextInterfaceMagento_Customer::managesimple: the customer page0.1.0
mrx.customer.new.main.bottomlight_customers_newMrx\Light\Api\Form\CurrentFormInterfaceMagento_Customer::managesimple: the new customer form0.1.0
mrx.discount.form.aside.bottommrx_discounts_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_SalesRule::quotesimple: the discount editor0.1.0
mrx.discount.form.main.bottommrx_discounts_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_SalesRule::quotesimple: the discount editor0.1.0
mrx.home.toplight_home_indexMagento_Backend::dashboardsimple: Home0.4.0
mrx.home.widgetslight_home_indexMagento_Backend::dashboardsimple: Home0.1.0
mrx.order.aside.bottomlight_orders_viewMrx\Orders\Api\OrderPageContextInterfaceMagento_Sales::actions_viewsimple: the order page0.1.0
mrx.order.aside.toplight_orders_viewMrx\Orders\Api\OrderPageContextInterfaceMagento_Sales::actions_viewsimple: the order page0.1.0
mrx.order.main.before_timelinelight_orders_viewMrx\Orders\Api\OrderPageContextInterfaceMagento_Sales::actions_viewsimple: the order page0.1.0
mrx.order.main.toplight_orders_viewMrx\Orders\Api\OrderPageContextInterfaceMagento_Sales::actions_viewsimple: the order page0.1.0
mrx.product.form.aside.bottomlight_products_formMrx\Catalog\Api\ProductPageContextInterfaceMagento_Catalog::productssimple: the product editor0.1.0
mrx.product.form.main.after_pricinglight_products_formMrx\Light\Api\Form\CurrentFormInterfaceMagento_Catalog::productssimple: the product editor0.1.0
mrx.product.form.main.bottomlight_products_formMrx\Catalog\Api\ProductPageContextInterfaceMagento_Catalog::productssimple: the product editor0.1.0
mrx.return.view.aside.bottomlight_returns_viewMageOS_RMA::rma_managesimple: the return page0.1.0
mrx.settings.aftermrx_settings_pageMagento_Config::configsimple: every Settings page0.1.0
mrx.settings.business.registrationlight_settings_businessMagento_Config::configsimple: 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 page0.1.0
mrx.settings.payments.providerslight_settings_paymentsMagento_Config::configsimple: 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 controller0.1.0
mrx.settings.taxes.cross_borderlight_settings_taxesMagento_Tax::config_tax and Magento_Tax::manage_taxsimple: 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 page0.1.0
mrx.settings.taxes.presetlight_settings_taxesMagento_Tax::config_tax and Magento_Tax::manage_taxsimple: 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 page0.1.0
mrx.topbar.user.menumrx_simplenone: every adminsimple: the top bar's account menu0.1.0

Handles

HandleSince
light_settings_app_{code}0.1.0
light_settings_{code}0.1.0
mrx_advanced0.1.0
mrx_orders_email_pickup0.1.0
mrx_settings_page0.1.0
mrx_simple0.1.0

Forms

FormEntitySince
categoryMagento\Catalog\Api\Data\CategoryInterface0.1.0
cms_blockMagento\Cms\Api\Data\BlockInterface0.1.0
cms_pageMagento\Cms\Api\Data\PageInterface0.1.0
customerMagento\Customer\Api\Data\CustomerInterface0.1.0
customer_newMagento\Customer\Api\Data\CustomerInterface0.1.0
discountMagento\SalesRule\Api\Data\RuleInterface0.1.0
productMagento\Catalog\Api\Data\ProductInterface0.1.0

JS modules

ModuleExports#mrx-config keysSince
Mrx_Light/js/apiApiError request get post0.1.0
Mrx_Light/js/configget url allmode stockView apiVersion locale currency timezone storeName sender user canContact urls nav shortcuts channels icons0.1.0
Mrx_Light/js/form-hooksregister validate extend saved0.1.0
Mrx_Light/js/formatmoney number parse date relative dateShort dateTime time hydrate0.1.0
Mrx_Light/js/loaderduring button skeleton spinner0.1.0
Mrx_Light/js/modalopen confirm isOpen0.1.0
Mrx_Light/js/save-barattach get0.1.0
Mrx_Light/js/toastshow error0.1.0

Events

EventKindDetailSince
mrx:badgesdomitems0.1.0
mrx:channelschangedomids level card0.1.0
mrx:customer-message-sentdomoptions response0.1.0
mrx:form-saveddomformCode entityId response0.1.0
mrx:languagebeforechangedomstoreId previousStoreId option switcher0.1.0
mrx:languagechangedomstoreId previousStoreId option switcher0.1.0
mrx:product-saveddomsuccess message product entity_id ext0.1.0
mrx:readydom0.1.0
mrx:tabchangedomtab panel0.1.0
mrx:themechangedomsource state0.1.0
mrx:themepreferencedomstate0.1.0
mrx_return_resolved_afterserverreturn0.1.0

Last updated on

On this page