For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/react/Function.GlobalPropsProvider.md.
ReactLynx logo
ReactLynx
  • English

      • @lynx-js/react / GlobalPropsProvider

      Function: GlobalPropsProvider() 

      function GlobalPropsProvider(props: object, deprecatedLegacyContext?: any): null | ReactElement<any, any>

      The Provider Component that provide lynx.__globalProps, you must wrap your JSX inside it

      Parameters

      ParameterTypeDescription
      propsobject-
      props.children?ReactNode-
      deprecatedLegacyContext?anyDeprecated See React Docs

      Returns

      null | ReactElement<any, any>

      Example

      import { root } from "@lynx-js/react"

function App() {
  return (
    <GlobalPropsConsumer children={(globalProps) => <view>...</view>}/>
  )
}

root.render(
  <GlobalPropsProvider>
     <App/>
  </GlobalPropsProvider>
);

      Defined in

      @lynx-js/react/runtime/lib/lynx-api.d.ts:166

      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.