Lynx
  • English

      • API Reference

      @lynx-js/react

      Built-in Macros
      Directives
      Global Events
      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: Lynx
      Interface: Root
      Variable: root
      Interface: InitData
      Interface: InitDataRaw

      lynx.config.js

      environments
      mode
      dev
      output
      performance
      resolve
      server
      source
      tools

      @lynx-js/react-rsbuild-plugin

      pluginReactLynx

      @lynx-js/qrcode-rsbuild-plugin

      CustomizedSchemaFn
      pluginQRCode

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

      pluginExternalBundle
      PluginExternalBundleOptions

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

      defaultExternalBundleLibConfig
      defineExternalBundleRslibConfig
      EncodeOptions
      ExternalBundleWebpackPlugin
      ExternalBundleWebpackPluginOptions
      LAYERS
      MainThreadRuntimeWrapperWebpackPlugin
      MainThreadRuntimeWrapperWebpackPluginOptions

      Builtin Elements

      <view>
      <text>
      <image>
      <scroll-view>
      <list>
      <page>
      <frame>
      <input>
      <textarea>
      <overlay>
      <svg>
      <refresh>
      <title-bar-view>

      Properties

      -x-auto-font-size-preset-sizes
      -x-auto-font-size
      -x-handle-color
      -x-handle-size
      align-content
      align-items
      align-self
      animation-delay
      animation-direction
      animation-duration
      animation-fill-mode
      animation-iteration-count
      animation-name
      animation-play-state
      animation-timing-function
      animation
      aspect-ratio
      background-clip
      background-color
      background-image
      background-origin
      background-position
      background-repeat
      background-size
      background
      border-bottom-color
      border-bottom-left-radius
      border-bottom-right-radius
      border-bottom-style
      border-bottom-width
      border-bottom
      border-color
      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-left
      border-radius
      border-right-color
      border-right-style
      border-right-width
      border-right
      border-start-end-radius
      border-start-start-radius
      border-style
      border-top-color
      border-top-left-radius
      border-top-right-radius
      border-top-style
      border-top-width
      border-top
      border-width
      border
      bottom
      box-shadow
      box-sizing
      clip-path
      color
      column-gap (grid-column-gap)
      Custom properties (--*): CSS variables
      direction
      display
      filter
      flex-basis
      flex-direction
      flex-flow
      flex-grow
      flex-shrink
      flex-wrap
      flex
      font-family
      font-feature-settings
      font-optical-sizing
      font-size
      font-style
      font-variation-settings
      font-weight
      gap
      grid-auto-columns
      grid-auto-flow
      grid-auto-rows
      grid-column-end
      grid-column-span
      grid-column-start
      grid-row-end
      grid-row-span
      grid-row-start
      grid-template-columns
      grid-template-rows
      height
      image-rendering
      inset-inline-end
      inset-inline-start
      justify-content
      justify-items
      justify-self
      left
      letter-spacing
      line-height
      linear-cross-gravity
      linear-direction
      linear-gravity
      linear-layout-gravity
      linear-weight-sum
      linear-weight
      margin-bottom
      margin-inline-end
      margin-inline-start
      margin-left
      margin-right
      margin-top
      margin
      mask-image
      mask
      max-height
      max-width
      min-height
      min-width
      opacity
      order
      overflow-x
      overflow-y
      overflow
      padding-bottom
      padding-inline-end
      padding-inline-start
      padding-left
      padding-right
      padding-top
      padding
      perspective
      pointer-events
      position
      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-id
      relative-inline-end-of
      relative-inline-start-of
      relative-layout-once
      relative-left-of
      relative-right-of
      relative-top-of
      right
      row-gap (grid-row-gap)
      text-align
      text-decoration
      text-indent
      text-overflow
      text-shadow
      text-stroke-color
      text-stroke-width
      text-stroke
      top
      transform-origin
      transform
      transition-delay
      transition-duration
      transition-property
      transition-timing-function
      transition
      vertical-align
      visibility
      white-space
      width
      word-break
      z-index

      At-rules

      @font-face
      @import
      @keyframes

      Data types

      <angle>
      <color>
      <fit-content>
      <gradient>
      <length-percentage>
      <length>
      <max-content>
      <number>
      <percentage>
      <string>
      <time>

      Selectors

      Selectors

      Event

      AnimationEvent
      CustomEvent
      Event
      GlobalEvent
      MemoryEvent
      MouseEvent
      TouchEvent

      Global

      clearInterval()
      clearTimeout()
      console
      fetch
      setInterval()
      setTimeout()
      SystemInfo

      IntersectionObserver

      disconnect()
      observe()
      relativeToScreen()
      relativeToViewport()
      relativeTo()

      Lynx

      accessibilityAnnounce()
      addFont()
      animate()
      BeforePublishEvent
      cancelAnimationFrame()
      cancelResourcePrefetch()
      createIntersectionObserver()
      createSelectorQuery()
      getElementById()
      getJSModule()
      getSessionStorageItem
      getTextInfo()
      GlobalProps
      performance
      queueMicrotask()
      registerModule()
      reload()
      reportError()
      requestAnimationFrame()
      requestResourcePrefetch()
      requireModuleAsync()
      requireModule()
      resumeExposure()
      setObserverFrameRate()
      setSessionStorageItem
      stopExposure()
      subscribeSessionStorage
      unsubscribeSessionStorage

      NodesRef

      fields()
      invoke()
      path()
      setNativeProps()

      MainThread

      Element
      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()

      SelectorQuery

      exec()
      selectAll()
      selectRoot()
      selectUniqueID()
      select()

      Performance APIs

      Performance Entry
      Performance Observer
      PerformanceMetric
      FrameworkPipelineTiming
      HostPlatformTiming

      LynxView

      addLynxViewClient
      destroy
      enableAutoLayout
      findUIByIdSelector
      findUIByName
      findViewByIdSelector
      findViewByName
      loadTemplate
      <lynx-view>
      reload
      removeLynxViewClient
      sendGlobalEvent
      setExtraTiming
      updateFontScale
      updateMetaData
      updateViewport

      LynxViewClient

      onDataUpdated
      onDestroy
      onFirstLoadPerfReady
      onFirstScreen
      onFling
      onFlushFinish
      onKeyEvent
      onLoadSuccess
      onLynxEvent
      onLynxViewAndJSRuntimeDestroy
      onModuleMethodInvoked
      onPageStart
      onPageUpdate
      onPerformanceEvent
      onPiperInvoked
      onReceivedError
      onReceivedJavaError
      onReceivedJSError
      onReceivedNativeError
      onReportComponentInfo
      onRuntimeReady
      onScrollStart
      onScrollStop
      onTASMFinishedByNative
      onTemplateBundleReady
      onUpdateDataWithoutChange
      onUpdatePerfReady

      LynxBackgroundRuntime

      addLynxBackgroundRuntimeClient
      callJSFunction
      destroy
      evaluateJavaScript
      removeLynxBackgroundRuntimeClient
      sendGlobalEvent

      LynxBackgroundRuntimeClient

      onEvaluateJavaScriptEnd
      onModuleMethodInvoked
      onReceivedError

      LynxContext

      sendGlobalEvent
      setExtraTiming
      updateFontScale
      updateMetaData
      updateViewport

      LynxEnv

      trimMemory

      GenericResourceFetcher

      cancel
      fetchResourcePath
      fetchResource
      fetchStream

      MediaResourceFetcher

      fetchImage
      isLocalResource
      shouldRedirectUrl

      TemplateResourceFetcher

      fetchTemplate

      TemplateBundle

      fromTemplateAsyncWithOption
      fromTemplateAsync
      fromTemplate
      getErrorMessage
      getExtraInfo
      getTemplateSize
      isElementBundleValid
      isValid
      postJsCacheGenerationTask
      release

      TemplateData

      constructor
      data
      fromMap
      fromString
      markState
      merge

      LynxLoadMeta

      LynxLoadMeta

      LynxUpdateMeta

      LynxUpdateMeta

      LynxService

      LynxService

      TraceEvent

      TraceEvent

      CustomizedMessage

      CustomizedMessage

      LynxBaseInspectorOwner

      getConsoleObject
      sendMessage
      setLynxInspectorConsoleDelegate
      subscribeMessage
      unsubscribeMessage

      LynxInspectorConsoleDelegate

      LynxInspectorConsoleDelegate

      MessageHandler

      MessageHandler

      @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
      queries
      queryHelpers
      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: screen
      Type Alias: QueryByBoundAttribute()<T>
      Type Alias: QueryByRole()<T>
      Type Alias: QueryByText()<T>
      Interface: SelectorMatcherOptions
      Type Alias: QueryMethod()<Arguments, Return>
      Type Alias: WithSuggest
      Variable: prettyFormat

      Element PAPIs

      __AddClass
      __AddConfig
      __AddDataset
      __AddEvent
      __AddInlineStyle
      __AppendElement
      __CreateComponent
      __CreateElement
      __CreatePage
      __ElementIsEqual
      __FirstElement
      __GetAttributes
      __GetChildren
      __GetClasses
      __GetComponentID
      __GetComputedStyleByKey
      __GetDataByKey
      __GetDataset
      __GetElementConfig
      __GetElementUniqueID
      __GetEvent
      __GetEvents
      __GetID
      __GetInlineStyles
      __GetParent
      __GetTag
      __InsertElementBefore
      __LastElement
      __NextElement
      __RemoveElement
      __ReplaceElement
      __ReplaceElements
      __SetAttribute
      __SetCSSId
      __SetClasses
      __SetConfig
      __SetDataset
      __SetEvents
      __SetID
      __SetInlineStyles
      __SwapElement
      __UpdateComponentID

      LynxError

      LynxError

      Error Codes

      Error Codes
      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.