You are reading the documentation for version 2.2. Magento 2.3 is the latest version available. Ensure you are reading the documentation for your version of Magento.

InsertForm component

The InsertForm component inserts the Form component into other components.

Configuration options

Option Description Type Default
autoRender When set to true, the Form component is automatically rendered during Insertform initialization. Otherwise, insertListing's render method should be called to render the Form. Boolean false
component The path to the component’s JS constructor file in terms of RequireJS. String Magento_Ui/js/form/components/insert-form
  • imports
  • exports
Flags that enable linking between insertForm's externalValue (the object that stores Form information) and Form value.
  • Enable import from the inserted Form value to the insertForm's externalValue.
  • Enable export from the insertForm's externalValue to the inserted Form aggregated value.
  • Boolean
  • Boolean
externalProvider DataSource of the inserted Form. String ''
formSubmitType Expect that Form will save data using AJAX. Links responseData and responseStatus with form. Export to form submit type. Boolean false
ns Namespace of the inserted form. String ''
realTimeLink Enables link between insertForms's externalValue and value. Here 'link' means the two-way links property of UI components, which allows immediate update. Boolean false
render_url With default render_url(mui/index/render) form will be without form buttons. To get Form with buttons, url must be changed to mui/index/render_handle and next GET parameters:
  • buttons=1 (flag to get buttons)
  • handle=%layout namespace%/ (buttons scope)
Url mui/index/render
showSpinner Show spinner while the Form is rendered. Boolean true
toolbarContainer Path to component that has toolbarSection property with reference to HTML element. Component will insert Form buttons to this section. String ''