Guide
APIs
Blog

English

简体中文
English

Frameworks

Built-in Macros

Import Attributes

Class: Component<P, S, SS>

Class: MainThreadRef<T>

Class: PureComponent<P, S, SS>

Function: cloneElement()

Function: createContext()

Function: createElement()

Function: createRef()

Function: ~~createRoot()~~

Function: forwardRef()

Function: Fragment()

Function: InitDataConsumer()

Function: InitDataProvider()

Function: isValidElement()

Function: lazy()

Function: memo()

Function: runOnBackground()

Function: runOnMainThread()

Function: Suspense()

Function: useCallback()

Function: useContext()

Function: useDebugValue()

Function: useEffect()

Function: useImperativeHandle()

Function: useInitData()

Function: useInitDataChanged()

Function: ~~useLayoutEffect()~~

Function: useLynxGlobalEventListener()

Function: useMainThreadRef()

Function: useMemo()

Function: useReducer()

Function: useRef()

Function: useState()

Function: useSyncExternalStore()

Function: withInitDataInState()

Interface: DataProcessorDefinition

Interface: DataProcessors

Interface: InitData

Interface: InitDataRaw

Interface: Lynx

Interface: Root

Compilation Toolchain

websocketTransport

exportLocalsConvention

~~intermediate~~

buildDependencies

transformImport

camelToDashComponentName

libraryDirectory

transformToDefaultImport

exportLocalsConvention

@lynx-js/react-rsbuild-plugin

pluginReactLynx

addComponentElement

additionalComponentAttributes

disableDeprecatedWarning

removeComponentAttrRegex

simplifyCtorLikeReactLynx2

customCSSInheritanceList

debugInfoOutside

defaultDisplayLinear

enableAccessibilityElement

enableCSSInheritance

enableCSSInvalidation

enableCSSSelector

enableNewGesture

enableParallelElement

enableRemoveCSSScope

experimental_isLazyBundle

firstScreenSyncTiming

pipelineSchedulerConfig

removeDescendantSelectorScope

removeCallParams

targetSdkVersion

@lynx-js/qrcode-rsbuild-plugin

CustomizedSchemaFn

@lynx-js/external-bundle-rsbuild-plugin

pluginExternalBundle

PluginExternalBundleOptions

@lynx-js/lynx-bundle-rslib-config

defaultExternalBundleLibConfig

defineExternalBundleRslibConfig

targetSdkVersion

ExternalBundleWebpackPlugin

ExternalBundleWebpackPluginOptions

targetSdkVersion

MainThreadRuntimeWrapperWebpackPlugin

MainThreadRuntimeWrapperWebpackPluginOptions

Elements

Builtin Elements

Styling

-x-auto-font-size-preset-sizes

-x-auto-font-size

-x-handle-color

animation-delay

animation-direction

animation-duration

animation-fill-mode

animation-iteration-count

animation-play-state

animation-timing-function

background-clip

background-color

background-image

background-origin

background-position

background-repeat

background-size

border-bottom-color

border-bottom-left-radius

border-bottom-right-radius

border-bottom-style

border-bottom-width

border-end-end-radius

border-end-start-radius

border-inline-end-color

border-inline-end-style

border-inline-end-width

border-inline-start-color

border-inline-start-style

border-inline-start-width

border-left-color

border-left-style

border-left-width

border-right-color

border-right-style

border-right-width

border-start-end-radius

border-start-start-radius

border-top-color

border-top-left-radius

border-top-right-radius

border-top-style

border-top-width

column-gap (grid-column-gap)

Custom properties (--*): CSS variables

font-feature-settings

font-optical-sizing

font-variation-settings

grid-auto-columns

grid-column-end

grid-column-span

grid-column-start

grid-template-columns

grid-template-rows

image-rendering

inset-inline-end

inset-inline-start

justify-content

linear-cross-gravity

linear-direction

linear-layout-gravity

linear-weight-sum

margin-inline-end

margin-inline-start

padding-inline-end

padding-inline-start

relative-align-bottom

relative-align-inline-end

relative-align-inline-start

relative-align-left

relative-align-right

relative-align-top

relative-bottom-of

relative-center

relative-inline-end-of

relative-inline-start-of

relative-layout-once

relative-left-of

relative-right-of

relative-top-of

row-gap (grid-row-gap)

text-decoration

text-stroke-color

text-stroke-width

transform-origin

transition-delay

transition-duration

transition-property

transition-timing-function

<fit-content>

<length-percentage>

<max-content>

Lynx APIs

Event

clearInterval()

console

groupCollapsed()

IntersectionObserver

relativeToScreen()

relativeToViewport()

accessibilityAnnounce()

BeforePublishEvent

cancelAnimationFrame()

cancelResourcePrefetch()

createIntersectionObserver()

createSelectorQuery()

getElementById()

getSessionStorageItem

createObserver()

profileFlowId()

isProfileRecording()

queueMicrotask()

registerModule()

requestAnimationFrame()

requestResourcePrefetch()

requireModuleAsync()

requireModule()

resumeExposure()

setObserverFrameRate()

setSessionStorageItem

subscribeSessionStorage

unsubscribeSessionStorage

setNativeProps()

Element.animate()

Element.getComputedStyleProperty()

lynx.getTextInfo()

lynx.querySelector()

lynx.querySelectorAll()

lynx.requestAnimationFrame()

lynx.__globalProps

lynx.stopExposure()

lynx.resumeExposure()

lynx.getSessionStorageItem()

lynx.setSessionStorageItem()

lynx.subscribeSessionStorage()

lynx.unsubscribeSessionStorage()

selectUniqueID()

Performance APIs

Performance Entry

InitContainerEntry

InitLynxviewEntry

InitBackgroundRuntimeEntry

MetricAcutalFmpEntry

LoadBundleEntry

LazyBundleEntry

ReloadBundleEntry

Performance Observer

PerformanceObserver.observe()

PerformanceObserver.disconnect()

PerformanceMetric

FrameworkPipelineTiming

HostPlatformTiming

AndroidHostPlatformTiming

HarmonyHostPlatformTiming

IOSHostPlatformTiming

Lynx Native APIs

addLynxViewClient

enableAutoLayout

findUIByIdSelector

findViewByIdSelector

removeLynxViewClient

sendGlobalEvent

updateFontScale

LynxViewClient

onFirstLoadPerfReady

onLynxViewAndJSRuntimeDestroy

onModuleMethodInvoked

onPerformanceEvent

onReceivedError

onReceivedJavaError

onReceivedJSError

onReceivedNativeError

onReportComponentInfo

onTASMFinishedByNative

onTemplateBundleReady

onUpdateDataWithoutChange

onUpdatePerfReady

LynxBackgroundRuntime

addLynxBackgroundRuntimeClient

evaluateJavaScript

removeLynxBackgroundRuntimeClient

sendGlobalEvent

LynxBackgroundRuntimeClient

onEvaluateJavaScriptEnd

onModuleMethodInvoked

onReceivedError

LynxContext

sendGlobalEvent

updateFontScale

GenericResourceFetcher

fetchResourcePath

MediaResourceFetcher

isLocalResource

shouldRedirectUrl

TemplateResourceFetcher

fromTemplateAsyncWithOption

fromTemplateAsync

getErrorMessage

getTemplateSize

isElementBundleValid

postJsCacheGenerationTask

TemplateData

Lynx DevTool Native APIs

LynxBaseInspectorOwner

getConsoleObject

setLynxInspectorConsoleDelegate

LynxInspectorConsoleDelegate

Testing

@lynx-js/testing-environment

Class: LynxTestingEnv

Function: initElementTree()

Interface: LynxElement

Interface: LynxGlobalThis

Type Alias: ElementTree

Type Alias: ElementTreeGlobals

Type Alias: FilterUnderscoreKeys<T>

Type Alias: PickUnderscoreKeys<T>

@lynx-js/react/testing-library

Class: LynxTestingEnv

Function: buildQueries()

Function: cleanup()

Function: computeHeadingLevel()

Function: configure()

Function: createEvent()

Function: findAllByAltText()

Function: findAllByDisplayValue()

Function: findAllByLabelText()

Function: findAllByPlaceholderText()

Function: findAllByRole()

Function: findAllByTestId()

Function: findAllByText()

Function: findAllByTitle()

Function: findByAltText()

Function: findByDisplayValue()

Function: findByLabelText()

Function: findByPlaceholderText()

Function: findByRole()

Function: findByTestId()

Function: findByText()

Function: findByTitle()

Function: fireEvent()

Function: getAllByAltText()

Function: getAllByDisplayValue()

Function: getAllByLabelText()

Function: getAllByPlaceholderText()

Function: getAllByRole()

Function: getAllByTestId()

Function: getAllByText()

Function: getAllByTitle()

Function: getByAltText()

Function: getByDisplayValue()

Function: getByLabelText()

Function: getByPlaceholderText()

Function: getByRole()

Function: getByTestId()

Function: getByText()

Function: getByTitle()

Function: getConfig()

Function: getDefaultNormalizer()

Function: getElementError()

Function: getNodeText()

Function: getQueriesForElement()

Function: getRoles()

Function: getSuggestedQuery()

Function: isInaccessible()

Function: logDOM()

Function: logRoles()

Function: prettyDOM()

Function: queryAllByAltText()

Function: queryAllByAttribute()

Function: queryAllByDisplayValue()

Function: queryAllByLabelText()

Function: queryAllByPlaceholderText()

Function: queryAllByRole()

Function: queryAllByTestId()

Function: queryAllByText()

Function: queryAllByTitle()

Function: queryByAltText()

Function: queryByAttribute()

Function: queryByDisplayValue()

Function: queryByLabelText()

Function: queryByPlaceholderText()

Function: queryByRole()

Function: queryByTestId()

Function: queryByText()

Function: queryByTitle()

Function: render()

Function: renderHook()

Function: waitFor()

Function: waitForElementToBeRemoved()

Function: waitSchedule()

Function: within()

Interface: ByRoleOptions

Interface: Config

Interface: ConfigFn()

Interface: DefaultNormalizerOptions

Interface: LogRolesOptions

Interface: MatcherOptions

Interface: NormalizerOptions

Interface: PrettyDOMOptions

Interface: Queries

Interface: QueryOptions

Interface: RenderHookOptions<Props>

Interface: RenderHookResult<Result, Props>

Interface: RenderOptions<Q>

Interface: Suggestion

Interface: waitForOptions

Type Alias: AllByAttribute()

Type Alias: AllByBoundAttribute()<T>

Type Alias: AllByRole()<T>

Type Alias: AllByText()<T>

Type Alias: BoundFunction<T>

Type Alias: BoundFunctions<Q>

Type Alias: BuiltQueryMethods<Arguments>

Type Alias: ByRoleMatcher

Type Alias: CreateFunction()

Type Alias: CreateObject

Type Alias: ElementTree

Type Alias: EventType

Type Alias: FindAllBy<Arguments>

Type Alias: FindAllByBoundAttribute()<T>

Type Alias: FindAllByRole()<T>

Type Alias: FindAllByText()<T>

Type Alias: FindBy<Arguments>

Type Alias: FindByBoundAttribute()<T>

Type Alias: FindByRole()<T>

Type Alias: FindByText()<T>

Type Alias: FireFunction()

Type Alias: FireObject

Type Alias: GetAllBy<Arguments>

Type Alias: GetBy<Arguments>

Type Alias: GetByBoundAttribute()<T>

Type Alias: GetByRole()<T>

Type Alias: GetByText()<T>

Type Alias: GetErrorFunction()<Arguments>

Type Alias: Match()

Type Alias: Matcher

Type Alias: MatcherFunction()

Type Alias: Method

Type Alias: NormalizerFn()

Type Alias: Query()

Type Alias: QueryArgs

Type Alias: QueryBy<Arguments>

Type Alias: QueryByAttribute()

Type Alias: RenderResult<Q>

Type Alias: Screen<Q>

Type Alias: Variant

Variable: prettyFormat

Variable: screen

Type Alias: QueryByBoundAttribute()<T>

Type Alias: QueryByRole()<T>

Type Alias: QueryByText()<T>

Interface: SelectorMatcherOptions

Type Alias: QueryMethod()<Arguments, Return>

Type Alias: WithSuggest

Lynx Engine Low-level APIs

__AddInlineStyle

__AppendElement

__CreateComponent

__CreateElement

__ElementIsEqual

__FirstElement

__GetAttributes

__GetChildren

__GetComponentID

__GetComputedStyleByKey

__GetDataByKey

__GetElementConfig

__GetElementUniqueID

__GetInlineStyles

__InsertElementBefore

__LastElement

__NextElement

__RemoveElement

__ReplaceElement

__ReplaceElements

__SetAttribute

__SetInlineStyles

__SwapElement

__UpdateComponentID

Errors in Lynx

Overview

Filter

TemplateBundle

fromTemplateAsyncWithOption

Syntax
Compatibility

fromTemplateAsync

Syntax
Compatibility

Syntax
Compatibility

getErrorMessage

Syntax
Compatibility

Syntax
Compatibility

getTemplateSize

Syntax
Compatibility

isElementBundleValid

Syntax
Compatibility

Syntax
Compatibility

postJsCacheGenerationTask

Syntax
Compatibility

Syntax
Compatibility

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.