`lightning__FlowAction` Target

Enables a component to be used on flow screens in Flow Builder.

Syntax

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3  <apiVersion>58.0</apiVersion>
4  <isExposed>true</isExposed>
5  <targets>
6      <target>lightning__FlowAction</target>
7  </targets>
8</LightningComponentBundle>

targetConfigs

Configures the component for flow screens and defines component properties. The targetConfigs tag contains at least one targetConfig tag.

targetConfig

Configures a component for flow screens with these attributes.

Attribute	Description	Required
`targets`	Specify one or more page types in the `targets` attribute, such as `<targetConfig targets="lightning__FlowAction">` or `<targetConfig targets="lightning__FlowAction,lightning__AppPage">`. The `targets` attribute value must match one or more of the page types that you listed under `<targets>`.	Yes
`configurationEditor`	Registers a custom property editor for a flow action component. A custom property editor is a Lightning web component that provides a custom UI for configuring a custom flow action component’s input attributes. See Customize Action and Screen Component UI in Flow Builder.

The targetConfig tag includes at least one property tag.

property

Specifies a public property of a component that can be set in Flow Builder. The component author defines the property in the component’s JavaScript class using the @api decorator. See the Usage section.

Use the property tag with these attributes.

Attribute	Type	Description	Required
`name`	String	The attribute name. This value must match the property name in the component’s JavaScript class.	Yes
`type`	String	The attribute’s data type. The following values are valid for all targets. Make sure that this value matches the type assigned to the property in the component’s JavaScript module. If the types don’t match, the value in the configuration file takes precedence. `Boolean` `Integer` `String` `apex://namespace.Classname`—An Apex class used for an Apex-defined data type. If the class is in the same namespace as the component, don’t specify a namespace. If the class is in a managed package, specify the namespace of the managed package. `Date`—A date in ISO 8601 format. `DateTime`—A datetime in ISO 8601 format. `@salesforce/schema/namespace__Objectname` or `@salesforce/schema/Objectname`—An object. See `@salesforce` modules.	Yes
`default`	String	The default value for the attribute. This attribute doesn’t get populated at runtime. We recommend setting the default value in the JavaScript file.
`description`	String	Displays as an i-bubble for the attribute in Flow Builder.
`label`	String	Displays as a label for the attribute in Flow Builder.
`required`	Boolean	Specifies whether the attribute is required. The default value is `false`.
`role`	String	Specifies whether the attribute is `inputOnly` or `outputOnly`. If you don’t specify the `role` attribute, the default value allows input and output. If you don’t set the `role` attribute, the property is exposed in a custom property editor. If you set it to `outputOnly`, the property isn’t exposed in a custom property editor.

Usage

To expose a component property in Flow Builder, define the property in the component’s JavaScript class using the @api decorator.

1import { LightningElement, api } from "lwc";
2
3export default class Example extends LightningElement {
4  @api volume;
5}