English

English

Frameworks

@lynx-js/react

Built-in Macros

Class: Component<P, S, SS>

Class: MainThreadRef<T>

Class: PureComponent<P, S, SS>

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: InitData

Interface: InitDataRaw

Interface: Lynx

Interface: Root

Compilation Toolchain

lynx.config.js

Dev

assetPrefix

client

websocketTransport

watchFiles

writeToDisk

Output

assetPrefix

cleanDistPath

copy

cssModules

auto

exportGlobals

exportLocalsConvention

localIdentName

dataUriLimit

distPath

css

cssAsync

intermediate

js

jsAsync

root

filename

bundle

css

font

image

js

media

svg

template

filenameHash

legalComments

minify

css

cssOptions

js

jsOptions

sourceMap

js

Performance

chunkSplit

override

strategy

maxSize

minSize

splitChunks

removeConsole

Server

headers

host

port

Source

alias

assetsInclude

decorators

version

define

entry

exclude

include

transformImport

camelToDashComponentName

customName

libraryDirectory

libraryName

transformToDefaultImport

tsconfigPath

Tools

bundlerChain

cssExtract

loaderOptions

esModule

pluginOptions

ignoreOrder

pathinfo

cssLoader

importLoaders

modules

auto

exportLocalsConvention

localIdentName

namedExport

rsdoctor

rspack

swc

@lynx-js/react-rsbuild-plugin

pluginReactLynx

compat

customCSSInheritanceList

debugInfoOutside

defaultDisplayLinear

defineDCE

enableAccessibilityElement

enableCSSInheritance

enableCSSInvalidation

enableCSSSelector

enableICU

enableNewGesture

enableParallelElement

enableRemoveCSSScope

experimental_isLazyBundle

firstScreenSyncTiming

jsx

pipelineSchedulerConfig

removeDescendantSelectorScope

shake

targetSdkVersion

@lynx-js/qrcode-rsbuild-plugin

CustomizedSchemaFn

pluginQRCode

schema

Elements

Builtin Elements

Styling

Properties

-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

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

At-rules

Data types

<fit-content>

<length-percentage>

<max-content>

Lynx APIs

Event

Global

clearInterval()

IntersectionObserver

relativeToScreen()

relativeToViewport()

Lynx

BeforePublishEvent

cancelAnimationFrame()

cancelResourcePrefetch()

createIntersectionObserver()

createSelectorQuery()

getElementById()

registerModule()

requestAnimationFrame()

requestResourcePrefetch()

requireModuleAsync()

requireModule()

resumeExposure()

setObserverFrameRate()

NodesRef

setNativeProps()

MainThread

lynx.getTextInfo()

lynx.querySelector()

lynx.querySelectorAll()

lynx.requestAnimationFrame()

lynx.__globalProps

SelectorQuery

selectUniqueID()

Performance APIs

Performance Entry

InitContainerEntry

InitLynxviewEntry

InitBackgroundRuntimeEntry

MetricAcutalFmpEntry

LoadBundleEntry

Performance Observer

PerformanceObserver.observe()

PerformanceObserver.disconnect()

PerformanceMetric

FrameworkPipelineTiming

Lynx Native APIs

LynxView

addLynxViewClient

findUIByIdSelector

findViewByIdSelector

findViewByIdName

removeLynxViewClient

sendGlobalEvent

updateFontScale

ResourceFetcher

LynxGenericResourceFetcher

LynxMediaResourceFetcher

LynxTemplateResourceFetcher

Lynx Engine Low-level APIs

Element PAPIs

__AddInlineStyle

__AppendElement

__CreateComponent

__CreateElement

__ElementIsEqual

__FirstElement

__GetAttributes

__GetChildren

__GetComponentID

__GetDataByKey

__GetElementConfig

__GetElementUniqueID

__GetInlineStyles

__InsertElementBefore

__LastElement

__NextElement

__RemoveElement

__ReplaceElement

__ReplaceElements

__SetAttribute

__SetInlineStyles

__SwapElement

__UpdateComponentID

Errors in Lynx

Overview

Filter

LynxView

addLynxViewClient

Syntax
Compatibility

destroy

Syntax
Compatibility

findUIByIdSelector

Syntax
Compatibility

findUIByName

Syntax
Compatibility

findViewByIdSelector

Syntax
Parameters
Compatibility

findViewByIdName

Syntax
Compatibility

LoadTemplate

Syntax
Compatibility

removeLynxViewClient

Syntax
Parameters
Compatibility

sendGlobalEvent

Syntax
Compatibility

setExtraTiming

Syntax
Compatibility

UpdateData

Syntax
Compatibility

updateFontScale

Syntax
Compatibility

updateViewport

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.