Metadata Exports Bundle

BooleanColumn

Renders a column for a BOOLEAN type field.

BulkUpdateStatusColumn

Renders a column specifically for the BulkUpdatesGrid status.

ColorPickerColumn

This column is responsible for rendering a ColorPickerField in columnar form, such as for Entity Grids. The value should be either a HEX RGB code or any valid CSS color name.

DynamicColumn

Dynamically renders a column type based on the metadata, and if no matching column type is found, a StringColumn is rendered by default.

DateColumn

Renders a column for a DATE type field.

EmbeddedListColumn

Renders a column for an EMBEDDED_LIST type field.

EnumColumn

Renders a column for an ENUM type field.

EnumArrayColumn

Renders a column for an ENUM_ARRAY type field.

HTMLColumn

Renders a column for an HTML type field.

KeyValueMapColumn

Renders a column for a KEY_VALUE_MAP type field to display a key-value map. This is used primarily for rendering the set of option values for a Variant.

LargeContentColumn

Renders a column for a LARGE_CONTENT type field with large contents like embedded collections. In the table, these will be represented as truncated strings. However, this field will also be clickable, expanding to show a modal with the full contents pretty-printed similar to YAML style.

LinkColumn

Renders a column for a LINK type field with a link. The link contains a back-reference to the previous location.

MoneyColumn

Renders a column for a MONEY type field.

NumericColumn

Renders a column for DECIMAL, INTEGER, or LONG type fields.

ProgressColumn

Renders a column for a PROGRESS type field with a progress bar.

SpelRuleColumn

Renders a column for a SPEL_RULE type field.

StringArrayVerticalColumn

Renders a column for a VERTICAL_STRING_ARRAY type field.

StringColumn

Renders a column for a STRING type field.

TagsArrayColumn

Renders a column for a TAGS_ARRAY type field.

ThumbnailColumn

Renders a column for a THUMBNAIL type field.

TimeSinceColumn

Renders a column for a TIME_SINCE type date field.

CampaignCodesGridCollection

Renders an extension to ExternalGridCollection that is used specifically for the Campaign Codes sub-resource on the Campaign form. This extends the external grid by providing a special handler for generating codes.

ExternalAssetBrowser

Renders a component typically used for managing relationships between an entity and an Asset. This utilizes ItemBrowser for the user interface in order to allow the user to manage the asset data in various ways.

ExternalAssetDropzone

Renders a component that handles uploading an Asset and viewing a preview of it.

ExternalFieldGroup

Renders an external read-only form group of fields.

ExternalGridCollection

Renders a component that renders a configured ActionListGrid for external collection within a form.

ExternalLink

Renders an external component to render the HTML hyperlinks.

ProductPriceDataGridCollection

Renders an extension to ExternalGridCollection that is used specifically for the Product Price Data sub-resource on the Product form. This extends the external grid by providing a special handler for displaying and creating product price data.

RuleBasedCustomerSegmentTargetsGridCollection

Renders an extension to ExternalGridCollection that is used specifically for the Customer sub-resource on the Customer Segment form. This extends the external grid by providing a special handler for processing a rule-based Segment.

TreeViewCollection

Renders a component that initializes the TreeViewProvider and renders the TreeViewContainer component for displaying a hierarchical view of information.

VariantsExternalGridCollection

Extension to ExternalGridCollection that is used specifically for the Variants sub-resource on the Products form. This extends the external grid by providing a special handler for generating SKUs, as well as some action extensions that insert option-value fields into the create/edit forms.

AssetBrowserLookupField

A field component that renders an ItemBrowser to allow selection of an asset and inserts its data into the form state.

AssetDropzoneField

A field component that handles uploading an Asset and sets its URL in the form state. It also allows a user to target a specific URL as text.

BooleanField

Renders a toggle switch field for a BOOLEAN field type.

BusinessTypeFields

Renders the toggle switch that opens/closes the slide-over panel for Business Type field maintenance.

BusinessTypeWrapper

Renders the wrapper component that displays a Business Type field to be edited in the field maintenance view.

ColorPickerField

Renders a text input for a COLOR_PICKER field component with a color pallete shown on focus.

CustomAttributesCollection

Renders an ActionListGrid specifically for maintenance of custom attributes.

DateField

Renders a date picker field for the DATE field type.

DecimalField

Renders a number input for a DECIMAL field type.

DerivedField

Renders a text input for a DERIVED field type.

DerivedEnumField

Renders a select input for a DERIVED_ENUM field type.

DerivedUrlField

Renders a text input for a DERIVED_URL field type.

DynamicField

This component provides a way to configure a dynamic field whose metadata changes based on the form state.

EnumField

Renders a select input for each ENUM option.

EnumSelectField

Renders an enumerated select input field.

EnumSwitchField

Renders an enumerated toggle switch field.

FieldArrayBlock

Renders a controllable field array form group that can manage duplicating its components.

FieldArrayGrid

This collection type is used for rendering collections of type FIELD_ARRAY_GRID. This type of collection is most useful for collections that reside in the parent document, such as Product’s Attributes collection. This should not be used for collections with references to external documents.

FileInputField

Renders a text input for a FILE_INPUT field type.

HTMLField

Renders an HTML input for a HTML field type.

ImportHeadersField

A multi-select field that is used to specify which fields to import from the file. To specify the name of the file input, use the metadata attribute fileKey, which has a default value of file. This attribute is used to get the file from the Formik state (see Formik library to learn more about managing form state).

IntegerField

Renders a numeric input for an INTEGER field type. Only supports 32-bit integer values.

LongField

Renders a numeric input for a LONG field type. Only supports 64-bit integer values.

LookupField

Renders a select input for a LOOKUP field type. This component allows the user to search and/or create options.

MoneyField

Renders a text input for a MONEY field type. Applies currency and numerical formatting to input.

QueryBuilderField

Renders a QueryBuilder for a field with type QUERY_BUILDER. This field helps build RSQL rules —— use RuleBuilderField for SpEL rules.

ResidentGridCollection

Renders a collection of resident grid fields —— these are rendered as a list grid within a form, and allows the management of an embedded collection on the domain. For example, this is useful for managing a set of attributes or other simple objects.

ResidentMapField

Renders a field that represents map entries for an embedded collection on the domain —— for example, this can be used to manage a fulfillment flat rates map that maps fulfillment flat rates to products.

RuleBuilderField

Renders a rule builder for a field with type RULE_BUILDER. This field helps build SpEL rules —— use QueryBuilderField for RSQL rules.

StringArrayField

Renders a creatable select input for an ARRAY_STRING field type.

StringField

Renders a text input for a STRING field type.

TextAreaField

Renders a text area input for a TEXT_AREA field type.

BasicGroup

Renders a basic form group.

CollapsibleGroup

Renders a collapsible form group.

ControlGroup

Renders a controllable collapse form group.

InlineGroup

Renders an inline group as a container for displaying components "inline".

LinkGroup

Renders a collapsable form group that is controlled by a button.

Approvals

A view for rendering the list grids dealing with approving and scheduling sandbox change summaries. It also manages which grid is rendered based on the view parameter of the location search string.

AssetBrowserView

The view container component typically used for managing relationships between an entity and an Asset. This utilizes ItemBrowser for the user interface in order to allow the user to manage the asset data in various ways.

DefaultTreeView

A view with a TreeView component embedded in it, displaying a tree-like hierarchical view of information. Differs from TreeViewCollection in that this component is a complete view component that is expected to be rendered at the top-level, while TreeViewCollection can be rendered as an external component embedded in any other component.

Deployments

A view for rendering the list grids dealing with managing deployments of sandbox changes. It manages which grid is rendered based on the view parameter of the location search string.

EntityBrowseView

The default view container component for most entities browse view. This is typically responsible for rendering one or more grid sections, but is capable of rendering any section configured in the metadata.

EntityGrid

The view-type usually used for rendering the list view for an entity domain.

EntityView

The primary view component for rendering the create or edit form for managing the data for an entity.

EntityLongView

The long form view component for rendering the create or edit form for managing the data for an entity.

ExportMaintenance

The default view container component for rendering the export section tab.

ImportMaintenance

The default view container component for rendering the import screen. This is typically responsible for rendering ImportsGrid.

ImportsGrid

The view-type usually used for rendering the list of the import processes.

MyChanges

This is a view for rendering the list grids dealing with a user’s sandbox changes. It manages which grid is rendered based on the view parameter of the location search string.

SimpleForm

A view-type component used for simply rendering a set of form components. This is typically used as a replacement for ENTITY for simpler form submission use cases.