Custom Component Parameters

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

ComponentOptions

Defines the custom component parameters used to configure whether component freezing is supported.

Widget capability: This API can be used in ArkTS widgets since API version 11.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Full

NOTE

Since API version 11, this parameter can be used to configure component freezing for @Component. For implementation examples, see Freezing a Custom Component.

Since API version 12, this parameter can be used to configure component freezing for @ComponentV2. For implementation examples, see Freezing a Custom Component.

Name	Type	Read-Only	Optional	Description
freezeWhenInactive	boolean	No	No	Whether to enable component freezing. The value true means to enable component freezing, and false means the opposite. If ComponentOptions is not specified, the default value false is used.