Lynx Config Reference

Auto-generated documentation for Lynx Configs.

Summary

ConfigDescription
absoluteInContentBoundWhen set to true, the containing block of absolute/fixed elements is the content area; otherwise, it is the padding area
asyncRedirectEnable Android Lynx Image URL asynchronous redirect
autoExposeif this flag is true, onShow/onHide will be automatically triggered by attachToView/detachFromWindow calls
CSSAlignWithLegacyW3CWhen set to true, for compatibility, some layout behaviors are consistent with the previous incorrect behaviors.
customCSSInheritanceListCustom Inheritable CSS Properties
dataStrictModeReactLynx cannot opt top_level_variables used in lepus. So we cannot forbid updateData when variable not in top_level_variables. User can use this config to close the check.
debugInfoOutsideNA
defaultDisplayLinearNA
defaultOverflowVisibleNA
disableLongpressAfterScrollPrevent the long press event from being triggered during inertial scrolling.
disableMultipleCascadeCSSNA
disableQuickTracingGCDisable tracing gc mode in quick context.
enableA11yEnable Android A11y
enableAccessibilityElementIndicates whether all ui enable a11y
enableAsyncInitVideoEngineWhether to enable asynchronous initialization of videoEngine
enableAsyncRequestImageIf true, supports initiating image requests in asynchronous threads.
enableAsyncResolveSubtreeFE Framework use this config to notify Engine that resolve subtree binding will be triggered when render DOM (Not exposed to normal user)
enableCheckExposureOptimizeEnable exposure detection optimization so that exposure detection is not performed when the page is static.
enableCheckLocalImageDetermine whether redirection is needed for local image resources.
enableCircularDataCheckIf this flag is true, circular data check will enable when convert js value to other vale.
enableComponentAsyncDecodeEnable dynamic components to be decoded in child threads before they are delivered into tasm in async-loading.
enableComponentConfigNA
enableComponentNullPropSupport component can be passed null props, null props only supported in LepusNG now. Open this switch to support lepus use null prop.
enableCreateViewAsyncCreate Android platform UIs in lynx built-in thread-pool to optimize UI Operation Execution
enableCSSAsyncDecodeNA
enableCSSClassMergeNA
enableCSSEngineNA
enableCSSExternalClassNA
enableCSSInheritanceEnable CSS inheritance
enableCSSInlineVariablesEnable CSS inline variables.
enableCSSInvalidationIf enable CSS invalidation we use RuleInvalidationSet to gather the selector invalidation.
enableCSSLazyDecodeNA
enableCSSLazyImportUnder scoped CSS, the imported CSS declarations by import rules are lazily decoded at the first time the scope takes effect.
enableCSSSelectorThis switch will enable the css module in blink standard mode.
enableCSSStrictModeCSS Length should be <number> follows a unit. Under strict mode, invalid <length> values are dropped.
enableCSSVariableNA
enableDisexposureWhenLynxHiddenEnables the disexposure event to fire when LynxView is in the hidden state.
enableEndGestureAtLastFingerUpEnable the Lynx touch event to be triggered normally after the last finger is lifted in a multi-finger scenario.
enableEventHandleRefactorEnable new event processing logic to support dynamic registration of event listeners, interception of events, etc.
enableEventRefactorNA
enableEventThroughEnable the client-slide touch event penetrate Lynx when touching the root node area of the Lynx page.
enableExposureUIMarginEnable exposure-ui-margin-* properties to take effect.
enableExposureWhenLayoutEnable exposure check when LynxView is layoutRequest
enableExposureWhenReloadEnables exposure and disexposure events to be triggered when reloading the Lynx page.
enableFiberArchNA
enableFixedNewA better and stable position fixed handling.
enableFlexibleTemplateIf enable this value, the template will be encoded as flexible template.
enableHarmonyNewOverlayEnable harmony new overlay based overlayManager to handle events pass through.
enableHarmonyVisibleAreaChangeForExposureEnable Harmony to detect exposure with visible area change event.
enableICUEnable Bind PRIMJS-ICU
enableImageDownsamplingIf true, downsampling will be enabled for all images on this LynxView
enableJsBindingApiThrowExceptionEnable js binding api throw exception
enableJSDataProcessorEnable data processor on JS thread
enableKeepPageDataNA
enableListMoveOperationDoes diffResult have moveAction
enableListNewArchitectureIndicates whether to use new architecture for the platform list
enableListPlugIndicates whether to use list plug
enableLynxScrollFluencyForce report lynx scroll fluency event. When setting pageConfig.enableLynxScrollFluency to a double value in the range [0, 1], we will monitor the fluency metrics for this LynxUI based on this probability. The probability indicates the likelihood of enabling fluency monitoring, and the metrics will be reported unconditionally through the applogService.
enableMicrotaskPromisePolyfillThis configuration item enableMicrotaskPromisePolyfill is used to determine whether to enable the micro - task Promise polyfill. Its value type is TernaryBool, and the default value is TernaryBool::UNDEFINE_VALUE.
enableMTSPreExecuteEnable MTS VM pre execute code.
enableMultiTouchEnable support multi-finger events so that event parameters can contain information about multiple fingers.
enableMultiTouchParamsCompatibleEnable the parameters of multi-finger events compatible with single-finger events
enableNativeListIndicates whether use c++ list.
enableNewAnimatorIf this flag is false, will use platform animation ability.
enableNewClipModeWhether enable new clip mode.
enableNewGestureif want to use gesture handler api, you need to set true
enableNewImageEnable load image from image service
enableNewIntersectionObserverEnable the new IntersectionObserver detection logic so that observe can be triggered normally without binding to scroll events.
enableNewListContainerImplement the platform-level list based on scrollView on the IOS platform
enableNewTransformOriginIf this flag is true, new transform origin algorithm will apply.
enablePlatformGestureEnable shadow platform gesture to handle gesture conflict.
enablePropertyBasedSimpleStyleSimpleStyle mode will incrementally update styles based on properties if this config set to TRUE. Otherwise it will incrementally update based on StyleObjects. The StyleObject based updating has a better performance but not allow StyleObjects bound to the same element has intersect properties.
enableQueryComponentSyncEnable query component sync in background runtime
enableReactOnlyPropsIdIf we got propsId, we could only pass propsId and a flag to JS thread. JS thread will use a propsMap to get correct props
enableReduceInitDataCopyIf this flag is true, do not copy init data, instead copy Object.keys of init data for efficiency.
enableReloadLifecycleEnable LynxUI onNodeReload lifecycle.
enableRemoveComponentExtraDataIf this flag is true, remove the globalProps & systemInfo from component data for efficiency.
enableRemoveCSSScopeNA
enableReuseLoadScriptExportsEnable reuse loadScript's result.
enableSignalAPIEnable using native signal API
enableSimpleStylingUsing the simplified styling module.
enableSimultaneousTapEnable the client's tap gesture to be triggered simultaneously with Lynx's tap gesture.
enableTextBoringLayoutEnable using BoringLayout on Android.
enableTextGradientOptEnable text gradient optimization for iOS.
enableTextLanguageAlignmentEnable a more accurate text alignment judgment method, but it will increase the time taken for text layout.
enableTextLayerRenderEnable using text layer render on iOS.
enableTextLayoutCacheWhether enable text layout cache.
enableTextNonContiguousLayoutWhether enable text noncontiguous layout
enableTextOverflowSet text overflow as visible if true.
enableTextRefactorEnable text refactor, with behavior more aligned with web.
enableTouchRefactorEnable Lynx's touchend event to be triggered normally.
enableUIOperationOptimizeEnable the optimization about UIOperation batching and CreateViewAsync at Android.
enableUnifiedPipelineEnable the unified pixel pipeline for Lynx Engine.
enableUnifyFixedBehaviorUnify behavior between old-fixed and new-fixed
enableUseContextPoolEnable Use Context Pool For LepusNG VM creation.
enableUseMapBufferEnable the mapbuffer structure for LynxProps.
enableViewReceiveTouchEnable touchesBegan and other methods to be triggered when touching the client-slide custom components.
enableVsyncAlignedFlushDrive the execution of UI tasks in the pipeline according to the VSync signal, bringing a certain progressive rendering effect. It is suitable for scenarios where JS-driven updates are frequent. Turn it on as needed.
enableXTextLayoutReusedWhether enable x-text layout reused.
experimental_encodeQuickjsBytecodeAllow encoding quickjs bytecode instead of source code in template.
extendedLayoutOnlyOptA config to force make some special properties can be used to layout only (such as direction&text-align,etc.).
extraInfouser defined extraInfo.
flattenControl whether the node requires creating a corresponding Android View. Default is true.
fontScaleEffectiveOnlyOnSpMake font scale only apply to sp units.
forceCalcNewStyleNA
implicitControl whether implicit animations are allowed on the iOS platform.
implicitAnimationNA
includeFontPaddingControl the top and bottom padding of text on Android, which affects the text's height and vertical centering effect.
keyboardCallbackPassRelativeHeightThe outer decor view that wraps lynx view may change due to that virtual navigation bar is shielded or drawn. Change the returning value of keyboard event to return absolute keyboard height and the offset from keyboard to to lynx view bottom
longPressDurationSpecify the interval for triggering the long press event.
observerFrameRateSpecifies the frequency of exposure detection.
pipelineSchedulerConfigScheduler config for pipeline, including enableParallelElement/list-framework batch render and other scheduler config.
preferredFpsControl the frame rate of CSS animations
quirksModeSupports string value. It is equal to TargetSDKVersion by default. The mode is for compatibility with old pages that do not conform to CSS layout specifications produced.
removeCSSParserLogNA
removeDescendantSelectorScopeIf false, descendant selector only works in component scope.
strictPropTypeif this flag is true, if component's prop type mismatch, will use default value.
tapSlopSpecify the sliding distance threshold at which the tap event is not triggered.
targetSdkVersionNA
templateDebugUrlNA
trailNewImageEnable the iOS image refactor
unifyVWVHBehaviorControl whether the vw and vh units dynamically adjust with the viewport in properties like font-size; enabled by default for targetSdkVersion >= 2.3
useImagePostProcessorWhether use image post processor
useNewSwiperIndicates whether to use new swiper
autoResumeAnimation Deprecateddeprecated
cli Deprecatedcli version
compileRender DeprecatedNone
customData DeprecatedNone
enableA11yIDMutationObserver DeprecatedEnable MutationObserver for accessibility.
enableAsyncDisplay DeprecatedGlobally enable async rendering for software rendering contents on iOS, this can largely optimize the frame rate and reduce janks.
enableBackgroundShapeLayer DeprecatedEnable iOS background manager to apply shape layer optimization. Deprecated and to be removed since this optimization becomes a fixed setting.
enableCascadePseudo DeprecatedDeprecated, this is for legacy CSS selector to enable a cascading.
enableCheckDataWhenUpdatePage DeprecatedNone
enableComponentLayoutOnly DeprecatedNone
enableGlobalComponentMap DeprecatedNone
enableNativeScheduleCreateViewAsync DeprecatedEnable create ui async form C++ PaintingContext
enableNewAccessibility DeprecatedNone
enableNewLayoutOnly DeprecatedNone
enableOptPushStyleToBundle DeprecatedEnable using PropBundleStyleWriter to write style to PropBundle.
enableOverlapForAccessibilityElement DeprecatedNone
fixCSSImportRuleOrder DeprecatedNone
forceCalcNewStyle DeprecatedNone
reactVersion DeprecatedNone
redBoxImageSizeWarningThreshold DeprecatedNone
removeComponentElement Deprecateddeprecated
syncImageAttach DeprecatedIf true and on the main thread, image requests will be initiated immediately; otherwise, image requests will be posted after the next frame of the main thread to delay the requests.
useNewImage DeprecatedNone
version DeprecatedNone

Config Reference


absoluteInContentBound

Android
Harmony
iOS
3.2

When set to true, the containing block of absolute/fixed elements is the content area; otherwise, it is the padding area

absoluteInContentBound?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


asyncRedirect

Android
3.2

Enable Android Lynx Image URL asynchronous redirect

asyncRedirect?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


autoExpose

Android
Harmony
iOS
3.2

if this flag is true, onShow/onHide will be automatically triggered by attachToView/detachFromWindow calls

autoExpose?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


CSSAlignWithLegacyW3C

Android
Harmony
iOS
3.2

When set to true, for compatibility, some layout behaviors are consistent with the previous incorrect behaviors.

CSSAlignWithLegacyW3C?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


customCSSInheritanceList

Android
Harmony
iOS
3.2

Custom Inheritable CSS Properties

customCSSInheritanceList?: string[] | undefined;
  • valueType: string[] | undefined

  • defaultValue: undefined


dataStrictMode

Android
Harmony
iOS
3.2

ReactLynx cannot opt top_level_variables used in lepus. So we cannot forbid updateData when variable not in top_level_variables. User can use this config to close the check.

dataStrictMode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


debugInfoOutside

Android
iOS
Harmony
3.2

NA

debugInfoOutside?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


defaultDisplayLinear

Android
iOS
Harmony
3.2

NA

defaultDisplayLinear?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


defaultOverflowVisible

Android
iOS
Harmony
3.2

NA

defaultOverflowVisible?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


disableLongpressAfterScroll

iOS
3.2

Prevent the long press event from being triggered during inertial scrolling.

disableLongpressAfterScroll?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


disableMultipleCascadeCSS

Android
iOS
Harmony
3.2

NA

disableMultipleCascadeCSS?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


disableQuickTracingGC

Android
Harmony
iOS
3.2

Disable tracing gc mode in quick context.

disableQuickTracingGC?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableA11y

Android
3.2

Enable Android A11y

enableA11y?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableAccessibilityElement

Android
3.2

Indicates whether all ui enable a11y

enableAccessibilityElement?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableAsyncInitVideoEngine

Android
3.2

Whether to enable asynchronous initialization of videoEngine

enableAsyncInitVideoEngine?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableAsyncRequestImage

Android
3.2

If true, supports initiating image requests in asynchronous threads.

enableAsyncRequestImage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableAsyncResolveSubtree

Android
iOS
3.4

FE Framework use this config to notify Engine that resolve subtree binding will be triggered when render DOM (Not exposed to normal user)

enableAsyncResolveSubtree?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableCheckExposureOptimize

iOS
3.2

Enable exposure detection optimization so that exposure detection is not performed when the page is static.

enableCheckExposureOptimize?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCheckLocalImage

Android
3.2

Determine whether redirection is needed for local image resources.

enableCheckLocalImage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableCircularDataCheck

Android
Harmony
iOS
3.2

If this flag is true, circular data check will enable when convert js value to other vale.

enableCircularDataCheck?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableComponentAsyncDecode

Android
Harmony
iOS
3.2

Enable dynamic components to be decoded in child threads before they are delivered into tasm in async-loading.

enableComponentAsyncDecode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableComponentConfig

Android
iOS
Harmony
3.2

NA

enableComponentConfig?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableComponentNullProp

Android
Harmony
iOS
3.2

Support component can be passed null props, null props only supported in LepusNG now. Open this switch to support lepus use null prop.

enableComponentNullProp?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCreateViewAsync

Android
3.2

Create Android platform UIs in lynx built-in thread-pool to optimize UI Operation Execution

enableCreateViewAsync?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableCSSAsyncDecode

Android
iOS
Harmony
3.2

NA

enableCSSAsyncDecode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableCSSClassMerge

Android
iOS
Harmony
3.2

NA

enableCSSClassMerge?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSEngine

Android
iOS
Harmony
3.2

NA

enableCSSEngine?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableCSSExternalClass

Android
iOS
Harmony
3.2

NA

enableCSSExternalClass?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableCSSInheritance

Android
Harmony
iOS
3.2

Enable CSS inheritance

enableCSSInheritance?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSInlineVariables

Android
iOS
Harmony
3.6

Enable CSS inline variables.

enableCSSInlineVariables?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSInvalidation

Android
iOS
Harmony
3.2

If enable CSS invalidation we use RuleInvalidationSet to gather the selector invalidation.

enableCSSInvalidation?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSLazyDecode

Android
iOS
Harmony
3.2

NA

enableCSSLazyDecode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableCSSLazyImport

Android
Harmony
iOS
3.2

Under scoped CSS, the imported CSS declarations by import rules are lazily decoded at the first time the scope takes effect.

enableCSSLazyImport?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableCSSSelector

Android
iOS
Harmony
3.2

This switch will enable the css module in blink standard mode.

enableCSSSelector?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSStrictMode

Android
Harmony
iOS
3.2

CSS Length should be <number> follows a unit. Under strict mode, invalid <length> values are dropped.

enableCSSStrictMode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCSSVariable

Android
iOS
Harmony
3.2

NA

enableCSSVariable?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableDisexposureWhenLynxHidden

Android
3.2

Enables the disexposure event to fire when LynxView is in the hidden state.

enableDisexposureWhenLynxHidden?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableEndGestureAtLastFingerUp

iOS
3.2

Enable the Lynx touch event to be triggered normally after the last finger is lifted in a multi-finger scenario.

enableEndGestureAtLastFingerUp?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableEventHandleRefactor

Android
Harmony
iOS
3.5

Enable new event processing logic to support dynamic registration of event listeners, interception of events, etc.

enableEventHandleRefactor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableEventRefactor

Android
iOS
Harmony
3.2

NA

enableEventRefactor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableEventThrough

Android
Harmony
iOS
3.2

Enable the client-slide touch event penetrate Lynx when touching the root node area of the Lynx page.

enableEventThrough?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableExposureUIMargin

Android
iOS
3.2

Enable exposure-ui-margin-* properties to take effect.

enableExposureUIMargin?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableExposureWhenLayout

Android
3.2

Enable exposure check when LynxView is layoutRequest

enableExposureWhenLayout?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableExposureWhenReload

Android
Harmony
iOS
3.5

Enables exposure and disexposure events to be triggered when reloading the Lynx page.

enableExposureWhenReload?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableFiberArch

Android
iOS
Harmony
3.2

NA

enableFiberArch?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableFixedNew

Android
Harmony
iOS
3.2

A better and stable position fixed handling.

enableFixedNew?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableFlexibleTemplate

Android
iOS
Harmony
3.2

If enable this value, the template will be encoded as flexible template.

enableFlexibleTemplate?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableHarmonyNewOverlay

Harmony
3.6

Enable harmony new overlay based overlayManager to handle events pass through.

enableHarmonyNewOverlay?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableHarmonyVisibleAreaChangeForExposure

Harmony
3.4

Enable Harmony to detect exposure with visible area change event.

enableHarmonyVisibleAreaChangeForExposure?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableICU

Android
iOS
3.2

Enable Bind PRIMJS-ICU

enableICU?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableImageDownsampling

iOS
3.2

If true, downsampling will be enabled for all images on this LynxView

enableImageDownsampling?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableJsBindingApiThrowException

Android
Harmony
iOS
3.2

Enable js binding api throw exception

enableJsBindingApiThrowException?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableJSDataProcessor

Android
Harmony
iOS
3.2

Enable data processor on JS thread

enableJSDataProcessor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableKeepPageData

Android
iOS
Harmony
3.2

NA

enableKeepPageData?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableListMoveOperation

Android
Harmony
iOS
3.2

Does diffResult have moveAction

enableListMoveOperation?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableListNewArchitecture

Android
iOS
3.2

Indicates whether to use new architecture for the platform list

enableListNewArchitecture?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableListPlug

Android
iOS
3.2

Indicates whether to use list plug

enableListPlug?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableLynxScrollFluency

Android
Harmony
iOS
3.2

Force report lynx scroll fluency event. When setting pageConfig.enableLynxScrollFluency to a double value in the range [0, 1], we will monitor the fluency metrics for this LynxUI based on this probability. The probability indicates the likelihood of enabling fluency monitoring, and the metrics will be reported unconditionally through the applogService.

enableLynxScrollFluency?: boolean | number | undefined;
  • valueType: boolean | number | undefined

  • defaultValue: undefined


enableMicrotaskPromisePolyfill

Android
Harmony
iOS
3.2

This configuration item enableMicrotaskPromisePolyfill is used to determine whether to enable the micro - task Promise polyfill. Its value type is TernaryBool, and the default value is TernaryBool::UNDEFINE_VALUE.

enableMicrotaskPromisePolyfill?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableMTSPreExecute

Android
iOS
Harmony
3.7

Enable MTS VM pre execute code.

enableMTSPreExecute?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableMultiTouch

Android
Harmony
iOS
3.2

Enable support multi-finger events so that event parameters can contain information about multiple fingers.

enableMultiTouch?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableMultiTouchParamsCompatible

Android
Harmony
iOS
3.2

Enable the parameters of multi-finger events compatible with single-finger events

enableMultiTouchParamsCompatible?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNativeList

Android
Harmony
iOS
3.2

Indicates whether use c++ list.

enableNativeList?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableNewAnimator

Android
Harmony
iOS
3.2

If this flag is false, will use platform animation ability.

enableNewAnimator?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableNewClipMode

Android
iOS
3.2

Whether enable new clip mode.

enableNewClipMode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableNewGesture

Android
Harmony
iOS
3.2

if want to use gesture handler api, you need to set true

enableNewGesture?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNewImage

Android
iOS
3.2

Enable load image from image service

enableNewImage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableNewIntersectionObserver

Android
iOS
3.2

Enable the new IntersectionObserver detection logic so that observe can be triggered normally without binding to scroll events.

enableNewIntersectionObserver?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNewListContainer

iOS
3.2

Implement the platform-level list based on scrollView on the IOS platform

enableNewListContainer?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNewTransformOrigin

Android
Harmony
iOS
3.2

If this flag is true, new transform origin algorithm will apply.

enableNewTransformOrigin?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enablePlatformGesture

Android
iOS
3.6

Enable shadow platform gesture to handle gesture conflict.

enablePlatformGesture?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enablePropertyBasedSimpleStyle

Android
iOS
Harmony
3.5

SimpleStyle mode will incrementally update styles based on properties if this config set to TRUE. Otherwise it will incrementally update based on StyleObjects. The StyleObject based updating has a better performance but not allow StyleObjects bound to the same element has intersect properties.

enablePropertyBasedSimpleStyle?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableQueryComponentSync

Android
Harmony
iOS
3.2

Enable query component sync in background runtime

enableQueryComponentSync?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableReactOnlyPropsId

Android
Harmony
iOS
3.2

If we got propsId, we could only pass propsId and a flag to JS thread. JS thread will use a propsMap to get correct props

enableReactOnlyPropsId?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableReduceInitDataCopy

Android
Harmony
iOS
3.2

If this flag is true, do not copy init data, instead copy Object.keys of init data for efficiency.

enableReduceInitDataCopy?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableReloadLifecycle

Android
Harmony
iOS
3.2

Enable LynxUI onNodeReload lifecycle.

enableReloadLifecycle?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableRemoveComponentExtraData

Android
Harmony
iOS
3.2

If this flag is true, remove the globalProps & systemInfo from component data for efficiency.

enableRemoveComponentExtraData?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableRemoveCSSScope

Android
iOS
Harmony
3.2

NA

enableRemoveCSSScope?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableReuseLoadScriptExports

Android
Harmony
iOS
3.5

Enable reuse loadScript's result.

enableReuseLoadScriptExports?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableSignalAPI

Android
Harmony
iOS
3.2

Enable using native signal API

enableSignalAPI?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableSimpleStyling

Android
iOS
Harmony
3.3

Using the simplified styling module.

enableSimpleStyling?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableSimultaneousTap

iOS
3.2

Enable the client's tap gesture to be triggered simultaneously with Lynx's tap gesture.

enableSimultaneousTap?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableTextBoringLayout

Android
3.2

Enable using BoringLayout on Android.

enableTextBoringLayout?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableTextGradientOpt

iOS
3.5

Enable text gradient optimization for iOS.

enableTextGradientOpt?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableTextLanguageAlignment

iOS
3.2

Enable a more accurate text alignment judgment method, but it will increase the time taken for text layout.

enableTextLanguageAlignment?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableTextLayerRender

iOS
3.2

Enable using text layer render on iOS.

enableTextLayerRender?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableTextLayoutCache

Android
iOS
3.3

Whether enable text layout cache.

enableTextLayoutCache?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableTextNonContiguousLayout

iOS
3.2

Whether enable text noncontiguous layout

enableTextNonContiguousLayout?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableTextOverflow

Android
iOS
3.2

Set text overflow as visible if true.

enableTextOverflow?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableTextRefactor

Android
iOS
3.2

Enable text refactor, with behavior more aligned with web.

enableTextRefactor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableTouchRefactor

iOS
3.2

Enable Lynx's touchend event to be triggered normally.

enableTouchRefactor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableUIOperationOptimize

Android
Harmony
iOS
3.2

Enable the optimization about UIOperation batching and CreateViewAsync at Android.

enableUIOperationOptimize?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableUnifiedPipeline

Android
Harmony
iOS
3.4

Enable the unified pixel pipeline for Lynx Engine.

enableUnifiedPipeline?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableUnifyFixedBehavior

Android
Harmony
iOS
3.7

Unify behavior between old-fixed and new-fixed

enableUnifyFixedBehavior?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableUseContextPool

Android
Harmony
iOS
3.2

Enable Use Context Pool For LepusNG VM creation.

enableUseContextPool?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableUseMapBuffer

Android
Harmony
iOS
3.2

Enable the mapbuffer structure for LynxProps.

enableUseMapBuffer?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableViewReceiveTouch

iOS
3.2

Enable touchesBegan and other methods to be triggered when touching the client-slide custom components.

enableViewReceiveTouch?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableVsyncAlignedFlush

Android
iOS
Android 3.2+
iOS 3.2+

Drive the execution of UI tasks in the pipeline according to the VSync signal, bringing a certain progressive rendering effect. It is suitable for scenarios where JS-driven updates are frequent. Turn it on as needed.

enableVsyncAlignedFlush?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableXTextLayoutReused

iOS
3.2

Whether enable x-text layout reused.

enableXTextLayoutReused?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


experimental_encodeQuickjsBytecode

Android
iOS
Harmony
3.2

Allow encoding quickjs bytecode instead of source code in template.

experimental_encodeQuickjsBytecode?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


extendedLayoutOnlyOpt

Android
Harmony
iOS
3.2

A config to force make some special properties can be used to layout only (such as direction&text-align,etc.).

extendedLayoutOnlyOpt?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


extraInfo

Android
Harmony
iOS
3.2

user defined extraInfo.

extraInfo?: Record<string, unknown> | undefined;
  • valueType: Record<string, unknown> | undefined

  • defaultValue: undefined


flatten

Android
3.2

Control whether the node requires creating a corresponding Android View. Default is true.

flatten?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


fontScaleEffectiveOnlyOnSp

Android
Harmony
iOS
3.2

Make font scale only apply to sp units.

fontScaleEffectiveOnlyOnSp?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


forceCalcNewStyle

Android
iOS
Harmony
3.2

NA

forceCalcNewStyle?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


implicit

iOS
3.2

Control whether implicit animations are allowed on the iOS platform.

implicit?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


implicitAnimation

Android
iOS
Harmony
3.2

NA

implicitAnimation?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


includeFontPadding

Android
3.2

Control the top and bottom padding of text on Android, which affects the text's height and vertical centering effect.

includeFontPadding?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


keyboardCallbackPassRelativeHeight

Android
3.2

The outer decor view that wraps lynx view may change due to that virtual navigation bar is shielded or drawn. Change the returning value of keyboard event to return absolute keyboard height and the offset from keyboard to to lynx view bottom

keyboardCallbackPassRelativeHeight?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


longPressDuration

Android
Harmony
iOS
3.2

Specify the interval for triggering the long press event.

longPressDuration?: number | undefined;
  • valueType: number | undefined

  • defaultValue: undefined


observerFrameRate

Android
Harmony
iOS
3.2

Specifies the frequency of exposure detection.

observerFrameRate?: number | undefined;
  • valueType: number | undefined

  • defaultValue: undefined


pipelineSchedulerConfig

Android
iOS
3.2

Scheduler config for pipeline, including enableParallelElement/list-framework batch render and other scheduler config.

pipelineSchedulerConfig?: number | undefined;
  • valueType: number | undefined

  • defaultValue: undefined


preferredFps

Android
Harmony
iOS
3.2

Control the frame rate of CSS animations

preferredFps?: string | undefined;
  • valueType: string | undefined

  • defaultValue: "auto"


quirksMode

Android
Harmony
iOS
3.2

Supports string value. It is equal to TargetSDKVersion by default. The mode is for compatibility with old pages that do not conform to CSS layout specifications produced.

quirksMode?: boolean | string | undefined;
  • valueType: boolean | string | undefined

  • defaultValue: undefined


removeCSSParserLog

Android
iOS
Harmony
3.2

NA

removeCSSParserLog?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


removeDescendantSelectorScope

Android
Harmony
iOS
3.2

If false, descendant selector only works in component scope.

removeDescendantSelectorScope?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


strictPropType

Android
Harmony
iOS
3.2

if this flag is true, if component's prop type mismatch, will use default value.

strictPropType?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


tapSlop

Android
Harmony
3.2

Specify the sliding distance threshold at which the tap event is not triggered.

tapSlop?: string | undefined;
  • valueType: string | undefined

  • defaultValue: "50px"


targetSdkVersion

Android
iOS
Harmony
3.2

NA

targetSdkVersion?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""


templateDebugUrl

Android
iOS
Harmony
3.2

NA

templateDebugUrl?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""


trailNewImage

iOS
3.2

Enable the iOS image refactor

trailNewImage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


unifyVWVHBehavior

Android
Harmony
iOS
3.2

Control whether the vw and vh units dynamically adjust with the viewport in properties like font-size; enabled by default for targetSdkVersion >= 2.3

unifyVWVHBehavior?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


useImagePostProcessor

Android
3.2

Whether use image post processor

useImagePostProcessor?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


useNewSwiper

Android
3.2

Indicates whether to use new swiper

useNewSwiper?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true

Deprecated Config


autoResumeAnimation Deprecated
3.5

Android
iOS
Harmony
3.2

deprecated

autoResumeAnimation?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


cli Deprecated
3.5

Android
Harmony
iOS
3.2

cli version

cli?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""


compileRender Deprecated
3.5

Android
iOS
Harmony
3.2
compileRender?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


customData Deprecated
3.5

Android
iOS
Harmony
3.2
customData?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""


enableA11yIDMutationObserver Deprecated
3.5

Android
iOS
Harmony
3.2

Enable MutationObserver for accessibility.

enableA11yIDMutationObserver?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableAsyncDisplay Deprecated
3.5

iOS
3.2

Globally enable async rendering for software rendering contents on iOS, this can largely optimize the frame rate and reduce janks.

enableAsyncDisplay?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableBackgroundShapeLayer Deprecated
3.5

iOS
3.2

Enable iOS background manager to apply shape layer optimization. Deprecated and to be removed since this optimization becomes a fixed setting.

enableBackgroundShapeLayer?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableCascadePseudo Deprecated
3.5

Android
Harmony
iOS
3.2

Deprecated, this is for legacy CSS selector to enable a cascading.

enableCascadePseudo?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableCheckDataWhenUpdatePage Deprecated
3.5

Android
Harmony
iOS
3.2
enableCheckDataWhenUpdatePage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableComponentLayoutOnly Deprecated
3.5

Android
Harmony
iOS
3.2
enableComponentLayoutOnly?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableGlobalComponentMap Deprecated
3.5

Android
iOS
Harmony
3.2
enableGlobalComponentMap?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNativeScheduleCreateViewAsync Deprecated
3.5

Android
3.2

Enable create ui async form C++ PaintingContext

enableNativeScheduleCreateViewAsync?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableNewAccessibility Deprecated
3.5

Android
3.2
enableNewAccessibility?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


enableNewLayoutOnly Deprecated
3.5

Android
Harmony
iOS
3.2
enableNewLayoutOnly?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


enableOptPushStyleToBundle Deprecated
3.5

Android
Harmony
iOS
3.2

Enable using PropBundleStyleWriter to write style to PropBundle.

enableOptPushStyleToBundle?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


enableOverlapForAccessibilityElement Deprecated
3.5

Android
3.2
enableOverlapForAccessibilityElement?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


fixCSSImportRuleOrder Deprecated
3.5

Android
Harmony
iOS
3.2
fixCSSImportRuleOrder?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


forceCalcNewStyle Deprecated
3.5

Android
iOS
Harmony
3.2
forceCalcNewStyle?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


reactVersion Deprecated
3.5

Android
Harmony
iOS
3.2
reactVersion?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""


redBoxImageSizeWarningThreshold Deprecated
3.5

Android
iOS
Harmony
3.2
redBoxImageSizeWarningThreshold?: number | undefined;
  • valueType: number | undefined

  • defaultValue: undefined


removeComponentElement Deprecated
3.5

Android
Harmony
iOS
3.2

deprecated

removeComponentElement?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: false


syncImageAttach Deprecated
3.5

Android
3.2

If true and on the main thread, image requests will be initiated immediately; otherwise, image requests will be posted after the next frame of the main thread to delay the requests.

syncImageAttach?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: true


useNewImage Deprecated
3.5

Android
iOS
3.2
useNewImage?: boolean | undefined;
  • valueType: boolean | undefined

  • defaultValue: undefined


version Deprecated
3.5

Android
Harmony
iOS
3.2
version?: string | undefined;
  • valueType: string | undefined

  • defaultValue: ""

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.