From 8af5038d294339c1003dd6e76860a338598dc8af Mon Sep 17 00:00:00 2001 From: Yiming Li Date: Wed, 27 May 2026 15:57:52 +0800 Subject: [PATCH 1/2] docs(api): regenerate rspeedy & typedoc API docs from lynx-stack main Regenerate all API reference docs sourced from lynx-stack: - rspeedy (api-documenter): sync en/zh from lynx-stack main. Adds new members (e.g. Config.splitChunks, SourceMap.css, pluginReactLynx enableUiSourceMap / experimental_useElementTemplate), removes dropped ones (Config.provider, distPath.{css,js,root,...}, enableICU, ...), and unifies the zh table format to HTML to match en (zh was a year stale). Reconcile docs/{en,zh}/api/_meta.json nav. - react / reactlynx-testing-library / lynx-testing-environment (typedoc): regenerate against @lynx-js/react 0.121.1 and testing-environment 0.2.1. react gains GlobalProps APIs, createPortal, useErrorBoundary; drops createRoot. Document.* conceptual pages preserved. Tooling/deps: - bump @lynx-js/react devDep to ^0.121.1 - pin typedoc to ^0.26.11 (0.28 breaks the markdown theme) - scripts/typedoc: rewrite absolute https://lynxjs.org links to site-relative in generated output - add new API terms to cspell dictionary Change-Id: I415d0bd9d2d3a367d1be8e23a400b794d6247636 --- .cspell/dictionary.txt | 7 + docs/en/api/_meta.json | 50 +- .../Class.GlobalEventEmitter.mdx | 194 +++++++ .../Class.LynxTestingEnv.mdx | 39 +- .../Function.initElementTree.mdx | 60 ++ .../Function.installLynxTestingEnv.mdx | 34 ++ .../Function.uninstallLynxTestingEnv.mdx | 33 ++ .../Interface.LynxElement.mdx | 2 +- .../Interface.LynxEnv.mdx | 27 + .../TypeAlias.ElementTree.mdx | 2 +- .../TypeAlias.ElementTreeGlobals.mdx | 2 +- .../TypeAlias.FilterUnderscoreKeys.mdx | 2 +- .../TypeAlias.PickUnderscoreKeys.mdx | 2 +- .../en/api/lynx-testing-environment/index.mdx | 15 +- docs/en/api/react/Class.Component.mdx | 52 +- docs/en/api/react/Class.MainThreadRef.mdx | 4 +- docs/en/api/react/Class.PureComponent.mdx | 52 +- docs/en/api/react/Function.Fragment.mdx | 6 +- .../react/Function.GlobalPropsConsumer.mdx | 34 ++ .../react/Function.GlobalPropsProvider.mdx | 55 ++ .../api/react/Function.InitDataConsumer.mdx | 6 +- .../api/react/Function.InitDataProvider.mdx | 6 +- docs/en/api/react/Function.Suspense.mdx | 6 +- docs/en/api/react/Function.cloneElement.mdx | 14 +- docs/en/api/react/Function.createContext.mdx | 2 +- docs/en/api/react/Function.createElement.mdx | 42 +- docs/en/api/react/Function.createPortal.mdx | 34 ++ docs/en/api/react/Function.createRef.mdx | 2 +- docs/en/api/react/Function.createRoot.mdx | 33 -- docs/en/api/react/Function.forwardRef.mdx | 2 +- docs/en/api/react/Function.isValidElement.mdx | 6 +- docs/en/api/react/Function.lazy.mdx | 2 +- docs/en/api/react/Function.memo.mdx | 4 +- .../en/api/react/Function.runOnBackground.mdx | 2 +- .../en/api/react/Function.runOnMainThread.mdx | 2 +- docs/en/api/react/Function.useCallback.mdx | 2 +- docs/en/api/react/Function.useContext.mdx | 2 +- docs/en/api/react/Function.useDebugValue.mdx | 2 +- docs/en/api/react/Function.useEffect.mdx | 2 +- docs/en/api/react/Function.useGlobalProps.mdx | 38 ++ .../react/Function.useGlobalPropsChanged.mdx | 44 ++ .../react/Function.useImperativeHandle.mdx | 6 +- docs/en/api/react/Function.useInitData.mdx | 2 +- .../api/react/Function.useInitDataChanged.mdx | 2 +- .../en/api/react/Function.useLayoutEffect.mdx | 2 +- .../Function.useLynxGlobalEventListener.mdx | 4 +- .../api/react/Function.useMainThreadRef.mdx | 10 +- docs/en/api/react/Function.useMemo.mdx | 2 +- docs/en/api/react/Function.useReducer.mdx | 10 +- docs/en/api/react/Function.useRef.mdx | 20 +- docs/en/api/react/Function.useState.mdx | 4 +- .../react/Function.useSyncExternalStore.mdx | 2 +- .../react/Function.withInitDataInState.mdx | 2 +- .../Interface.DataProcessorDefinition.mdx | 4 +- .../en/api/react/Interface.DataProcessors.mdx | 2 +- docs/en/api/react/Interface.GlobalProps.mdx | 15 + docs/en/api/react/Interface.Lynx.mdx | 52 +- docs/en/api/react/Interface.Root.mdx | 4 +- docs/en/api/react/Variable.root.mdx | 2 +- .../api/react/Variable.useErrorBoundary.mdx | 17 + docs/en/api/react/_meta.json | 10 +- docs/en/api/react/index.mdx | 9 +- .../Class.LynxTestingEnv.mdx | 77 +-- .../Function.findAllByAltText.mdx | 2 +- .../Function.findAllByDisplayValue.mdx | 2 +- .../Function.findAllByLabelText.mdx | 2 +- .../Function.findAllByPlaceholderText.mdx | 2 +- .../Function.findAllByRole.mdx | 2 +- .../Function.findAllByTestId.mdx | 2 +- .../Function.findAllByText.mdx | 2 +- .../Function.findAllByTitle.mdx | 2 +- .../Function.findByAltText.mdx | 2 +- .../Function.findByDisplayValue.mdx | 2 +- .../Function.findByLabelText.mdx | 2 +- .../Function.findByPlaceholderText.mdx | 2 +- .../Function.findByRole.mdx | 2 +- .../Function.findByTestId.mdx | 2 +- .../Function.findByText.mdx | 2 +- .../Function.findByTitle.mdx | 2 +- .../Function.fireEvent.mdx | 2 +- .../Function.getAllByAltText.mdx | 2 +- .../Function.getAllByDisplayValue.mdx | 2 +- .../Function.getAllByLabelText.mdx | 2 +- .../Function.getAllByPlaceholderText.mdx | 2 +- .../Function.getAllByRole.mdx | 2 +- .../Function.getAllByTestId.mdx | 2 +- .../Function.getAllByText.mdx | 2 +- .../Function.getAllByTitle.mdx | 2 +- .../Function.getByAltText.mdx | 2 +- .../Function.getByDisplayValue.mdx | 2 +- .../Function.getByLabelText.mdx | 2 +- .../Function.getByPlaceholderText.mdx | 2 +- .../Function.getByRole.mdx | 2 +- .../Function.getByTestId.mdx | 2 +- .../Function.getByText.mdx | 2 +- .../Function.getByTitle.mdx | 2 +- .../Function.getConfig.mdx | 2 +- .../Function.getDefaultNormalizer.mdx | 2 +- .../Function.getElementError.mdx | 2 +- .../Function.getNodeText.mdx | 2 +- .../Function.getQueriesForElement.mdx | 2 +- .../Function.getRoles.mdx | 2 +- .../Function.getSuggestedQuery.mdx | 2 +- .../Function.isInaccessible.mdx | 2 +- .../Function.logDOM.mdx | 2 +- .../Function.logRoles.mdx | 2 +- .../Function.prettyDOM.mdx | 2 +- .../Function.queryAllByAltText.mdx | 2 +- .../Function.queryAllByAttribute.mdx | 2 +- .../Function.queryAllByDisplayValue.mdx | 2 +- .../Function.queryAllByLabelText.mdx | 2 +- .../Function.queryAllByPlaceholderText.mdx | 2 +- .../Function.queryAllByRole.mdx | 2 +- .../Function.queryAllByTestId.mdx | 2 +- .../Function.queryAllByText.mdx | 2 +- .../Function.queryAllByTitle.mdx | 2 +- .../Function.queryByAltText.mdx | 2 +- .../Function.queryByAttribute.mdx | 6 +- .../Function.queryByDisplayValue.mdx | 2 +- .../Function.queryByLabelText.mdx | 2 +- .../Function.queryByPlaceholderText.mdx | 2 +- .../Function.queryByRole.mdx | 2 +- .../Function.queryByTestId.mdx | 2 +- .../Function.queryByText.mdx | 2 +- .../Function.queryByTitle.mdx | 2 +- .../Function.render.mdx | 6 +- .../Function.renderHook.mdx | 2 +- .../Function.waitFor.mdx | 2 +- .../Function.waitForElementToBeRemoved.mdx | 2 +- .../Function.waitSchedule.mdx | 8 +- .../Function.within.mdx | 2 +- .../Interface.ByRoleOptions.mdx | 22 +- .../Interface.LogRolesOptions.mdx | 2 +- .../Interface.MatcherOptions.mdx | 10 +- .../Interface.NormalizerOptions.mdx | 2 +- .../Interface.PrettyDOMOptions.mdx | 4 +- .../Interface.RenderHookOptions.mdx | 14 +- .../Interface.RenderHookResult.mdx | 6 +- .../Interface.RenderOptions.mdx | 62 +- .../Interface.Suggestion.mdx | 12 +- .../Interface.waitForOptions.mdx | 12 +- .../TypeAlias.ByRoleMatcher.mdx | 2 +- .../TypeAlias.CreateObject.mdx | 2 +- .../TypeAlias.EventType.mdx | 119 ++-- .../TypeAlias.FindAllBy.mdx | 2 +- .../TypeAlias.FindAllByBoundAttribute.mdx | 2 +- .../TypeAlias.FindAllByRole.mdx | 2 +- .../TypeAlias.FindAllByText.mdx | 2 +- .../TypeAlias.FindBy.mdx | 2 +- .../TypeAlias.FindByBoundAttribute.mdx | 2 +- .../TypeAlias.FindByRole.mdx | 2 +- .../TypeAlias.FindByText.mdx | 2 +- .../TypeAlias.FireFunction.mdx | 2 +- .../TypeAlias.FireObject.mdx | 4 +- .../TypeAlias.GetAllBy.mdx | 2 +- .../TypeAlias.GetBy.mdx | 2 +- .../TypeAlias.GetByBoundAttribute.mdx | 2 +- .../TypeAlias.GetByRole.mdx | 2 +- .../TypeAlias.GetByText.mdx | 2 +- .../TypeAlias.GetErrorFunction.mdx | 2 +- .../TypeAlias.Match.mdx | 2 +- .../TypeAlias.Matcher.mdx | 2 +- .../TypeAlias.MatcherFunction.mdx | 2 +- .../TypeAlias.Method.mdx | 2 +- .../TypeAlias.NormalizerFn.mdx | 2 +- .../TypeAlias.Query.mdx | 2 +- .../TypeAlias.QueryArgs.mdx | 2 +- .../TypeAlias.QueryBy.mdx | 2 +- .../TypeAlias.QueryByAttribute.mdx | 2 +- .../TypeAlias.RenderResult.mdx | 16 +- .../TypeAlias.Screen.mdx | 6 +- .../TypeAlias.Variant.mdx | 2 +- .../Variable.act.mdx} | 6 +- .../Variable.screen.mdx | 2 +- .../api/reactlynx-testing-library/index.mdx | 65 ++- ...ueries.TypeAlias.QueryByBoundAttribute.mdx | 2 +- .../queries.TypeAlias.QueryByRole.mdx | 2 +- .../queries.TypeAlias.QueryByText.mdx | 2 +- ...lpers.Interface.SelectorMatcherOptions.mdx | 14 +- .../queryHelpers.TypeAlias.QueryMethod.mdx | 2 +- .../queryHelpers.TypeAlias.WithSuggest.mdx | 2 +- ...lugin.builtinexternalspresetdefinitions.md | 2 +- ...e-rsbuild-plugin.externalspresetcontext.md | 47 +- ...-plugin.externalspresetcontext.rootpath.md | 13 + ...lugin.externalspresetdefinition.extends.md | 13 + ...sbuild-plugin.externalspresetdefinition.md | 87 ++- ...ernalspresetdefinition.resolveexternals.md | 13 + ...lspresetdefinition.resolvemanagedassets.md | 13 + ...build-plugin.externalspresetdefinitions.md | 4 +- ...-bundle-rsbuild-plugin.externalspresets.md | 48 +- ...build-plugin.externalspresets.reactlynx.md | 13 + .../rspeedy/external-bundle-rsbuild-plugin.md | 197 ++++++- ...ndle-rsbuild-plugin.normalizebundlepath.md | 37 +- ...dle-rsbuild-plugin.pluginexternalbundle.md | 51 +- ...xternalbundleoptions.externalbundleroot.md | 15 + ...n.pluginexternalbundleoptions.externals.md | 13 + ...undleoptions.externalspresetdefinitions.md | 15 + ...nexternalbundleoptions.externalspresets.md | 15 + ...uild-plugin.pluginexternalbundleoptions.md | 116 +++- ...dle-rsbuild-plugin.pluginexternalconfig.md | 12 +- ...d-plugin.pluginexternalvalue.bundlepath.md | 15 + ...ndle-rsbuild-plugin.pluginexternalvalue.md | 74 ++- ...-rsbuild-plugin.pluginexternalvalue.url.md | 20 + ...ctlynxexternalspresetoptions.bundlepath.md | 20 + ...-plugin.reactlynxexternalspresetoptions.md | 93 ++- ...ernalspresetoptions.reactumdpackagename.md | 20 + ...gin.reactlynxexternalspresetoptions.url.md | 20 + ...ck-plugin.externalsloadingpluginoptions.md | 19 + ...n.externalsloadingpluginoptions.retries.md | 18 + ...ls-loading-webpack-plugin.externalvalue.md | 19 + ...ng-webpack-plugin.externalvalue.retries.md | 18 + ...lewebpackpluginoptions.mainthreadchunks.md | 18 + ...nfig.externalbundlewebpackpluginoptions.md | 19 + ...ld-plugin.pluginreactlynxoptions.compat.md | 4 + ...actlynxoptions.customcssinheritancelist.md | 4 + ...pluginreactlynxoptions.debuginfooutside.md | 4 + ...inreactlynxoptions.defaultdisplaylinear.md | 6 +- ...plugin.pluginreactlynxoptions.definedce.md | 5 + ...tlynxoptions.enableaccessibilityelement.md | 5 + ...inreactlynxoptions.enablecssinheritance.md | 4 + ...nreactlynxoptions.enablecssinvalidation.md | 4 + ...luginreactlynxoptions.enablecssselector.md | 5 + ...plugin.pluginreactlynxoptions.enableicu.md | 15 - ...nreactlynxoptions.enableparallelelement.md | 13 - ...luginreactlynxoptions.enableuisourcemap.md | 18 + ...in.pluginreactlynxoptions.engineversion.md | 5 + ...ctlynxoptions.experimental_islazybundle.md | 5 + ...options.experimental_useelementtemplate.md | 18 + ...build-plugin.pluginreactlynxoptions.jsx.md | 13 - ...t-rsbuild-plugin.pluginreactlynxoptions.md | 40 ++ ...eactlynxoptions.pipelineschedulerconfig.md | 32 -- ...nxoptions.removedescendantselectorscope.md | 5 + ...ild-plugin.pluginreactlynxoptions.shake.md | 5 + ...pluginreactlynxoptions.targetsdkversion.md | 5 + docs/en/api/rspeedy/rspeedy.bundlefilename.md | 17 + ...rspeedy.bundlefilenamecontext.entryname.md | 15 + ...speedy.bundlefilenamecontext.lazybundle.md | 15 + .../rspeedy/rspeedy.bundlefilenamecontext.md | 100 ++++ .../rspeedy.bundlefilenamecontext.platform.md | 13 + docs/en/api/rspeedy/rspeedy.chunksplit.md | 5 + .../api/rspeedy/rspeedy.chunksplitbysize.md | 5 + .../api/rspeedy/rspeedy.chunksplitcustom.md | 5 + docs/en/api/rspeedy/rspeedy.config.md | 19 + docs/en/api/rspeedy/rspeedy.config.mode.md | 1 + docs/en/api/rspeedy/rspeedy.config.plugins.md | 2 +- .../en/api/rspeedy/rspeedy.config.provider.md | 36 -- .../api/rspeedy/rspeedy.config.splitchunks.md | 20 + .../rspeedy.createrspeedyoptions.loadenv.md | 2 +- .../rspeedy/rspeedy.createrspeedyoptions.md | 2 +- .../rspeedy.cssextract.loaderoptions.md | 2 - docs/en/api/rspeedy/rspeedy.cssextract.md | 5 +- .../rspeedy.cssextract.pluginoptions.md | 3 +- .../rspeedy.cssextractrspackloaderoptions.md | 1 - .../rspeedy.cssextractrspackpluginoptions.md | 2 +- .../en/api/rspeedy/rspeedy.dev.assetprefix.md | 1 + docs/en/api/rspeedy/rspeedy.distpath.css.md | 20 - .../api/rspeedy/rspeedy.distpath.cssasync.md | 20 - docs/en/api/rspeedy/rspeedy.distpath.js.md | 20 - .../api/rspeedy/rspeedy.distpath.jsasync.md | 20 - docs/en/api/rspeedy/rspeedy.distpath.md | 2 +- docs/en/api/rspeedy/rspeedy.distpath.root.md | 20 - .../api/rspeedy/rspeedy.entrydescription.md | 1 + .../api/rspeedy/rspeedy.exposedapi.entries.md | 13 + docs/en/api/rspeedy/rspeedy.exposedapi.md | 21 +- .../en/api/rspeedy/rspeedy.filename.bundle.md | 25 +- docs/en/api/rspeedy/rspeedy.filename.md | 2 +- docs/en/api/rspeedy/rspeedy.md | 47 +- .../api/rspeedy/rspeedy.mergerspeedyconfig.md | 2 +- .../api/rspeedy/rspeedy.minify.cssoptions.md | 37 -- .../api/rspeedy/rspeedy.minify.jsoptions.md | 1 + .../api/rspeedy/rspeedy.output.assetprefix.md | 1 + .../rspeedy/rspeedy.output.cleandistpath.md | 6 + docs/en/api/rspeedy/rspeedy.output.copy.md | 1 + .../en/api/rspeedy/rspeedy.output.distpath.md | 2 +- .../rspeedy/rspeedy.output.inlinescripts.md | 4 +- .../rspeedy/rspeedy.performance.chunksplit.md | 5 + docs/en/api/rspeedy/rspeedy.performance.md | 3 +- .../rspeedy.performance.printfilesize.md | 2 +- .../rspeedy/rspeedy.performance.profile.md | 9 +- ...eedy.rsdoctorrspackpluginoptions.linter.md | 15 + .../rspeedy.rsdoctorrspackpluginoptions.md | 54 +- docs/en/api/rspeedy/rspeedy.server.base.md | 2 +- docs/en/api/rspeedy/rspeedy.server.host.md | 2 +- .../rspeedy/rspeedy.source.assetsinclude.md | 1 + docs/en/api/rspeedy/rspeedy.source.define.md | 2 +- docs/en/api/rspeedy/rspeedy.source.exclude.md | 1 + docs/en/api/rspeedy/rspeedy.source.include.md | 1 + docs/en/api/rspeedy/rspeedy.source.md | 2 +- .../en/api/rspeedy/rspeedy.source.preentry.md | 2 +- docs/en/api/rspeedy/rspeedy.sourcemap.css.md | 34 ++ docs/en/api/rspeedy/rspeedy.sourcemap.js.md | 1 + docs/en/api/rspeedy/rspeedy.sourcemap.md | 19 + .../api/rspeedy/rspeedy.tools.bundlerchain.md | 1 + .../api/rspeedy/rspeedy.tools.cssextract.md | 1 + docs/en/api/rspeedy/rspeedy.tools.md | 1 + docs/en/api/rspeedy/rspeedy.tools.rspack.md | 7 +- docs/zh/api/_meta.json | 50 +- .../Class.GlobalEventEmitter.mdx | 194 +++++++ .../Class.LynxTestingEnv.mdx | 39 +- .../Function.initElementTree.mdx | 60 ++ .../Function.installLynxTestingEnv.mdx | 34 ++ .../Function.uninstallLynxTestingEnv.mdx | 33 ++ .../Interface.LynxElement.mdx | 2 +- .../Interface.LynxEnv.mdx | 27 + .../TypeAlias.ElementTree.mdx | 2 +- .../TypeAlias.ElementTreeGlobals.mdx | 2 +- .../TypeAlias.FilterUnderscoreKeys.mdx | 2 +- .../TypeAlias.PickUnderscoreKeys.mdx | 2 +- .../zh/api/lynx-testing-environment/index.mdx | 15 +- docs/zh/api/react/Class.Component.mdx | 268 ++++----- docs/zh/api/react/Class.MainThreadRef.mdx | 42 +- docs/zh/api/react/Class.PureComponent.mdx | 282 ++++----- docs/zh/api/react/Function.Fragment.mdx | 18 +- .../react/Function.GlobalPropsConsumer.mdx | 34 ++ .../react/Function.GlobalPropsProvider.mdx | 55 ++ .../api/react/Function.InitDataConsumer.mdx | 16 +- .../api/react/Function.InitDataProvider.mdx | 20 +- docs/zh/api/react/Function.Suspense.mdx | 20 +- docs/zh/api/react/Function.cloneElement.mdx | 100 ++-- docs/zh/api/react/Function.createContext.mdx | 20 +- docs/zh/api/react/Function.createElement.mdx | 124 ++-- docs/zh/api/react/Function.createPortal.mdx | 34 ++ docs/zh/api/react/Function.createRef.mdx | 12 +- docs/zh/api/react/Function.createRoot.mdx | 33 -- docs/zh/api/react/Function.forwardRef.mdx | 20 +- docs/zh/api/react/Function.isValidElement.mdx | 20 +- docs/zh/api/react/Function.lazy.mdx | 20 +- docs/zh/api/react/Function.memo.mdx | 34 +- .../zh/api/react/Function.runOnBackground.mdx | 24 +- .../zh/api/react/Function.runOnMainThread.mdx | 24 +- docs/zh/api/react/Function.useCallback.mdx | 18 +- docs/zh/api/react/Function.useContext.mdx | 18 +- docs/zh/api/react/Function.useDebugValue.mdx | 18 +- docs/zh/api/react/Function.useEffect.mdx | 12 +- docs/zh/api/react/Function.useGlobalProps.mdx | 38 ++ .../react/Function.useGlobalPropsChanged.mdx | 44 ++ .../react/Function.useImperativeHandle.mdx | 22 +- docs/zh/api/react/Function.useInitData.mdx | 10 +- .../api/react/Function.useInitDataChanged.mdx | 14 +- .../zh/api/react/Function.useLayoutEffect.mdx | 14 +- .../Function.useLynxGlobalEventListener.mdx | 20 +- .../api/react/Function.useMainThreadRef.mdx | 50 +- docs/zh/api/react/Function.useMemo.mdx | 18 +- docs/zh/api/react/Function.useReducer.mdx | 82 +-- docs/zh/api/react/Function.useRef.mdx | 60 +- docs/zh/api/react/Function.useState.mdx | 30 +- .../react/Function.useSyncExternalStore.mdx | 18 +- .../react/Function.withInitDataInState.mdx | 18 +- .../Interface.DataProcessorDefinition.mdx | 18 +- .../zh/api/react/Interface.DataProcessors.mdx | 20 +- docs/zh/api/react/Interface.GlobalProps.mdx | 15 + docs/zh/api/react/Interface.InitData.mdx | 2 +- docs/zh/api/react/Interface.InitDataRaw.mdx | 2 +- docs/zh/api/react/Interface.Lynx.mdx | 74 +-- docs/zh/api/react/Interface.Root.mdx | 26 +- docs/zh/api/react/Variable.root.mdx | 8 +- .../api/react/Variable.useErrorBoundary.mdx | 17 + docs/zh/api/react/_meta.json | 10 +- docs/zh/api/react/index.mdx | 21 +- .../Class.LynxTestingEnv.mdx | 77 +-- .../Function.findAllByAltText.mdx | 2 +- .../Function.findAllByDisplayValue.mdx | 2 +- .../Function.findAllByLabelText.mdx | 2 +- .../Function.findAllByPlaceholderText.mdx | 2 +- .../Function.findAllByRole.mdx | 2 +- .../Function.findAllByTestId.mdx | 2 +- .../Function.findAllByText.mdx | 2 +- .../Function.findAllByTitle.mdx | 2 +- .../Function.findByAltText.mdx | 2 +- .../Function.findByDisplayValue.mdx | 2 +- .../Function.findByLabelText.mdx | 2 +- .../Function.findByPlaceholderText.mdx | 2 +- .../Function.findByRole.mdx | 2 +- .../Function.findByTestId.mdx | 2 +- .../Function.findByText.mdx | 2 +- .../Function.findByTitle.mdx | 2 +- .../Function.fireEvent.mdx | 2 +- .../Function.getAllByAltText.mdx | 2 +- .../Function.getAllByDisplayValue.mdx | 2 +- .../Function.getAllByLabelText.mdx | 2 +- .../Function.getAllByPlaceholderText.mdx | 2 +- .../Function.getAllByRole.mdx | 2 +- .../Function.getAllByTestId.mdx | 2 +- .../Function.getAllByText.mdx | 2 +- .../Function.getAllByTitle.mdx | 2 +- .../Function.getByAltText.mdx | 2 +- .../Function.getByDisplayValue.mdx | 2 +- .../Function.getByLabelText.mdx | 2 +- .../Function.getByPlaceholderText.mdx | 2 +- .../Function.getByRole.mdx | 2 +- .../Function.getByTestId.mdx | 2 +- .../Function.getByText.mdx | 2 +- .../Function.getByTitle.mdx | 2 +- .../Function.getConfig.mdx | 2 +- .../Function.getDefaultNormalizer.mdx | 2 +- .../Function.getElementError.mdx | 2 +- .../Function.getNodeText.mdx | 2 +- .../Function.getQueriesForElement.mdx | 2 +- .../Function.getRoles.mdx | 2 +- .../Function.getSuggestedQuery.mdx | 2 +- .../Function.isInaccessible.mdx | 2 +- .../Function.logDOM.mdx | 2 +- .../Function.logRoles.mdx | 2 +- .../Function.prettyDOM.mdx | 2 +- .../Function.queryAllByAltText.mdx | 2 +- .../Function.queryAllByAttribute.mdx | 2 +- .../Function.queryAllByDisplayValue.mdx | 2 +- .../Function.queryAllByLabelText.mdx | 2 +- .../Function.queryAllByPlaceholderText.mdx | 2 +- .../Function.queryAllByRole.mdx | 2 +- .../Function.queryAllByTestId.mdx | 2 +- .../Function.queryAllByText.mdx | 2 +- .../Function.queryAllByTitle.mdx | 2 +- .../Function.queryByAltText.mdx | 2 +- .../Function.queryByAttribute.mdx | 6 +- .../Function.queryByDisplayValue.mdx | 2 +- .../Function.queryByLabelText.mdx | 2 +- .../Function.queryByPlaceholderText.mdx | 2 +- .../Function.queryByRole.mdx | 2 +- .../Function.queryByTestId.mdx | 2 +- .../Function.queryByText.mdx | 2 +- .../Function.queryByTitle.mdx | 2 +- .../Function.render.mdx | 6 +- .../Function.renderHook.mdx | 2 +- .../Function.waitFor.mdx | 2 +- .../Function.waitForElementToBeRemoved.mdx | 2 +- .../Function.waitSchedule.mdx | 8 +- .../Function.within.mdx | 2 +- .../Interface.ByRoleOptions.mdx | 22 +- .../Interface.LogRolesOptions.mdx | 2 +- .../Interface.MatcherOptions.mdx | 10 +- .../Interface.NormalizerOptions.mdx | 2 +- .../Interface.PrettyDOMOptions.mdx | 4 +- .../Interface.RenderHookOptions.mdx | 14 +- .../Interface.RenderHookResult.mdx | 6 +- .../Interface.RenderOptions.mdx | 62 +- .../Interface.Suggestion.mdx | 12 +- .../Interface.waitForOptions.mdx | 12 +- .../TypeAlias.ByRoleMatcher.mdx | 2 +- .../TypeAlias.CreateObject.mdx | 2 +- .../TypeAlias.EventType.mdx | 119 ++-- .../TypeAlias.FindAllBy.mdx | 2 +- .../TypeAlias.FindAllByBoundAttribute.mdx | 2 +- .../TypeAlias.FindAllByRole.mdx | 2 +- .../TypeAlias.FindAllByText.mdx | 2 +- .../TypeAlias.FindBy.mdx | 2 +- .../TypeAlias.FindByBoundAttribute.mdx | 2 +- .../TypeAlias.FindByRole.mdx | 2 +- .../TypeAlias.FindByText.mdx | 2 +- .../TypeAlias.FireFunction.mdx | 2 +- .../TypeAlias.FireObject.mdx | 4 +- .../TypeAlias.GetAllBy.mdx | 2 +- .../TypeAlias.GetBy.mdx | 2 +- .../TypeAlias.GetByBoundAttribute.mdx | 2 +- .../TypeAlias.GetByRole.mdx | 2 +- .../TypeAlias.GetByText.mdx | 2 +- .../TypeAlias.GetErrorFunction.mdx | 2 +- .../TypeAlias.Match.mdx | 2 +- .../TypeAlias.Matcher.mdx | 2 +- .../TypeAlias.MatcherFunction.mdx | 2 +- .../TypeAlias.Method.mdx | 2 +- .../TypeAlias.NormalizerFn.mdx | 2 +- .../TypeAlias.Query.mdx | 2 +- .../TypeAlias.QueryArgs.mdx | 2 +- .../TypeAlias.QueryBy.mdx | 2 +- .../TypeAlias.QueryByAttribute.mdx | 2 +- .../TypeAlias.RenderResult.mdx | 16 +- .../TypeAlias.Screen.mdx | 6 +- .../TypeAlias.Variant.mdx | 2 +- .../Variable.act.mdx} | 6 +- .../Variable.screen.mdx | 2 +- .../api/reactlynx-testing-library/index.mdx | 65 ++- ...ueries.TypeAlias.QueryByBoundAttribute.mdx | 2 +- .../queries.TypeAlias.QueryByRole.mdx | 2 +- .../queries.TypeAlias.QueryByText.mdx | 2 +- ...lpers.Interface.SelectorMatcherOptions.mdx | 14 +- .../queryHelpers.TypeAlias.QueryMethod.mdx | 2 +- .../queryHelpers.TypeAlias.WithSuggest.mdx | 2 +- ...lugin.builtinexternalspresetdefinitions.md | 2 +- ...e-rsbuild-plugin.externalspresetcontext.md | 47 +- ...-plugin.externalspresetcontext.rootpath.md | 13 + ...lugin.externalspresetdefinition.extends.md | 13 + ...sbuild-plugin.externalspresetdefinition.md | 87 ++- ...ernalspresetdefinition.resolveexternals.md | 13 + ...lspresetdefinition.resolvemanagedassets.md | 13 + ...build-plugin.externalspresetdefinitions.md | 4 +- ...-bundle-rsbuild-plugin.externalspresets.md | 48 +- ...build-plugin.externalspresets.reactlynx.md | 13 + .../rspeedy/external-bundle-rsbuild-plugin.md | 197 ++++++- ...ndle-rsbuild-plugin.normalizebundlepath.md | 37 +- ...dle-rsbuild-plugin.pluginexternalbundle.md | 51 +- ...xternalbundleoptions.externalbundleroot.md | 15 + ...n.pluginexternalbundleoptions.externals.md | 13 + ...undleoptions.externalspresetdefinitions.md | 15 + ...nexternalbundleoptions.externalspresets.md | 15 + ...uild-plugin.pluginexternalbundleoptions.md | 116 +++- ...dle-rsbuild-plugin.pluginexternalconfig.md | 12 +- ...d-plugin.pluginexternalvalue.bundlepath.md | 15 + ...ndle-rsbuild-plugin.pluginexternalvalue.md | 74 ++- ...-rsbuild-plugin.pluginexternalvalue.url.md | 20 + ...ctlynxexternalspresetoptions.bundlepath.md | 20 + ...-plugin.reactlynxexternalspresetoptions.md | 93 ++- ...ernalspresetoptions.reactumdpackagename.md | 20 + ...gin.reactlynxexternalspresetoptions.url.md | 20 + ...ck-plugin.externalsloadingpluginoptions.md | 19 + ...n.externalsloadingpluginoptions.retries.md | 18 + ...ls-loading-webpack-plugin.externalvalue.md | 19 + ...ng-webpack-plugin.externalvalue.retries.md | 18 + ...lewebpackpluginoptions.mainthreadchunks.md | 18 + ...nfig.externalbundlewebpackpluginoptions.md | 19 + ...sbuild-plugin.addcomponentelementconfig.md | 44 +- ...eact-rsbuild-plugin.compatvisitorconfig.md | 204 ++++++- ...t-rsbuild-plugin.definedcevisitorconfig.md | 44 +- .../react-rsbuild-plugin.extractstrconfig.md | 44 +- ...mplateplugin.getlynxtemplatepluginhooks.md | 11 + ...react-rsbuild-plugin.lynxtemplateplugin.md | 54 ++ docs/zh/api/rspeedy/react-rsbuild-plugin.md | 121 +++- .../react-rsbuild-plugin.pluginreactlynx.md | 36 +- ...ld-plugin.pluginreactlynxoptions.compat.md | 4 + ...actlynxoptions.customcssinheritancelist.md | 4 + ...pluginreactlynxoptions.debuginfooutside.md | 4 + ...inreactlynxoptions.defaultdisplaylinear.md | 6 +- ...plugin.pluginreactlynxoptions.definedce.md | 5 + ...tlynxoptions.enableaccessibilityelement.md | 5 + ...inreactlynxoptions.enablecssinheritance.md | 4 + ...nreactlynxoptions.enablecssinvalidation.md | 4 + ...luginreactlynxoptions.enablecssselector.md | 5 + ...plugin.pluginreactlynxoptions.enableicu.md | 15 - ...pluginreactlynxoptions.enablenewgesture.md | 5 + ...nreactlynxoptions.enableparallelelement.md | 13 - ...inreactlynxoptions.enableremovecssscope.md | 5 + ...plugin.pluginreactlynxoptions.enablessr.md | 5 + ...luginreactlynxoptions.enableuisourcemap.md | 18 + ...in.pluginreactlynxoptions.engineversion.md | 5 + ...ctlynxoptions.experimental_islazybundle.md | 5 + ...options.experimental_useelementtemplate.md | 18 + ...lugin.pluginreactlynxoptions.extractstr.md | 5 + ...nreactlynxoptions.firstscreensynctiming.md | 5 + ....pluginreactlynxoptions.globalpropsmode.md | 24 + ...build-plugin.pluginreactlynxoptions.jsx.md | 13 - ...t-rsbuild-plugin.pluginreactlynxoptions.md | 507 +++++++++++++++- ...uginreactlynxoptions.optimizebundlesize.md | 23 + ...eactlynxoptions.pipelineschedulerconfig.md | 32 -- ...nxoptions.removedescendantselectorscope.md | 5 + ...ild-plugin.pluginreactlynxoptions.shake.md | 5 + ...pluginreactlynxoptions.targetsdkversion.md | 5 + ...react-rsbuild-plugin.shakevisitorconfig.md | 103 +++- ...ld-plugin.shakevisitorconfig.removecall.md | 36 ++ ...gin.shakevisitorconfig.removecallparams.md | 2 +- docs/zh/api/rspeedy/rspeedy.bundlefilename.md | 17 + ...rspeedy.bundlefilenamecontext.entryname.md | 15 + ...speedy.bundlefilenamecontext.lazybundle.md | 15 + .../rspeedy/rspeedy.bundlefilenamecontext.md | 100 ++++ .../rspeedy.bundlefilenamecontext.platform.md | 13 + docs/zh/api/rspeedy/rspeedy.chunksplit.md | 5 + .../api/rspeedy/rspeedy.chunksplitbysize.md | 5 + .../api/rspeedy/rspeedy.chunksplitcustom.md | 5 + docs/zh/api/rspeedy/rspeedy.config.md | 19 + docs/zh/api/rspeedy/rspeedy.config.mode.md | 1 + docs/zh/api/rspeedy/rspeedy.config.plugins.md | 2 +- .../zh/api/rspeedy/rspeedy.config.provider.md | 36 -- .../api/rspeedy/rspeedy.config.splitchunks.md | 20 + .../rspeedy.createrspeedyoptions.loadenv.md | 2 +- .../rspeedy/rspeedy.createrspeedyoptions.md | 2 +- .../rspeedy.cssextract.loaderoptions.md | 2 - docs/zh/api/rspeedy/rspeedy.cssextract.md | 5 +- .../rspeedy.cssextract.pluginoptions.md | 3 +- .../rspeedy.cssextractrspackloaderoptions.md | 1 - .../rspeedy.cssextractrspackpluginoptions.md | 2 +- .../zh/api/rspeedy/rspeedy.dev.assetprefix.md | 1 + docs/zh/api/rspeedy/rspeedy.distpath.css.md | 20 - .../api/rspeedy/rspeedy.distpath.cssasync.md | 20 - docs/zh/api/rspeedy/rspeedy.distpath.js.md | 20 - .../api/rspeedy/rspeedy.distpath.jsasync.md | 20 - docs/zh/api/rspeedy/rspeedy.distpath.md | 2 +- docs/zh/api/rspeedy/rspeedy.distpath.root.md | 20 - .../api/rspeedy/rspeedy.entrydescription.md | 1 + .../api/rspeedy/rspeedy.exposedapi.entries.md | 13 + docs/zh/api/rspeedy/rspeedy.exposedapi.md | 21 +- .../zh/api/rspeedy/rspeedy.filename.bundle.md | 25 +- docs/zh/api/rspeedy/rspeedy.filename.md | 2 +- docs/zh/api/rspeedy/rspeedy.md | 47 +- .../api/rspeedy/rspeedy.mergerspeedyconfig.md | 2 +- .../api/rspeedy/rspeedy.minify.cssoptions.md | 37 -- .../api/rspeedy/rspeedy.minify.jsoptions.md | 1 + .../api/rspeedy/rspeedy.output.assetprefix.md | 1 + .../rspeedy/rspeedy.output.cleandistpath.md | 6 + docs/zh/api/rspeedy/rspeedy.output.copy.md | 1 + .../zh/api/rspeedy/rspeedy.output.distpath.md | 2 +- .../rspeedy/rspeedy.output.inlinescripts.md | 4 +- .../rspeedy/rspeedy.performance.chunksplit.md | 5 + docs/zh/api/rspeedy/rspeedy.performance.md | 3 +- .../rspeedy.performance.printfilesize.md | 2 +- .../rspeedy/rspeedy.performance.profile.md | 9 +- ...eedy.rsdoctorrspackpluginoptions.linter.md | 15 + .../rspeedy.rsdoctorrspackpluginoptions.md | 54 +- docs/zh/api/rspeedy/rspeedy.server.base.md | 2 +- docs/zh/api/rspeedy/rspeedy.server.host.md | 2 +- .../rspeedy/rspeedy.source.assetsinclude.md | 1 + docs/zh/api/rspeedy/rspeedy.source.define.md | 2 +- docs/zh/api/rspeedy/rspeedy.source.exclude.md | 1 + docs/zh/api/rspeedy/rspeedy.source.include.md | 1 + docs/zh/api/rspeedy/rspeedy.source.md | 2 +- .../zh/api/rspeedy/rspeedy.source.preentry.md | 2 +- docs/zh/api/rspeedy/rspeedy.sourcemap.css.md | 34 ++ docs/zh/api/rspeedy/rspeedy.sourcemap.js.md | 1 + docs/zh/api/rspeedy/rspeedy.sourcemap.md | 19 + .../api/rspeedy/rspeedy.tools.bundlerchain.md | 1 + .../api/rspeedy/rspeedy.tools.cssextract.md | 1 + docs/zh/api/rspeedy/rspeedy.tools.md | 1 + docs/zh/api/rspeedy/rspeedy.tools.rspack.md | 7 +- package.json | 4 +- pnpm-lock.yaml | 543 ++++++++++-------- scripts/typedoc/run-typedoc.ts | 39 ++ 614 files changed, 7806 insertions(+), 2887 deletions(-) create mode 100644 docs/en/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx create mode 100644 docs/en/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx create mode 100644 docs/en/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx create mode 100644 docs/en/api/lynx-testing-environment/Interface.LynxEnv.mdx create mode 100644 docs/en/api/react/Function.GlobalPropsConsumer.mdx create mode 100644 docs/en/api/react/Function.GlobalPropsProvider.mdx create mode 100644 docs/en/api/react/Function.createPortal.mdx delete mode 100644 docs/en/api/react/Function.createRoot.mdx create mode 100644 docs/en/api/react/Function.useGlobalProps.mdx create mode 100644 docs/en/api/react/Function.useGlobalPropsChanged.mdx create mode 100644 docs/en/api/react/Interface.GlobalProps.mdx create mode 100644 docs/en/api/react/Variable.useErrorBoundary.mdx rename docs/{zh/api/reactlynx-testing-library/Variable.prettyFormat.mdx => en/api/reactlynx-testing-library/Variable.act.mdx} (82%) create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetcontext.rootpath.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.extends.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.resolveexternals.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.resolvemanagedassets.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.externalspresets.reactlynx.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalbundleroot.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externals.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalspresetdefinitions.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalspresets.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalvalue.bundlepath.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalvalue.url.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.bundlepath.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.reactumdpackagename.md create mode 100644 docs/en/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.url.md create mode 100644 docs/en/api/rspeedy/externals-loading-webpack-plugin.externalsloadingpluginoptions.retries.md create mode 100644 docs/en/api/rspeedy/externals-loading-webpack-plugin.externalvalue.retries.md create mode 100644 docs/en/api/rspeedy/lynx-bundle-rslib-config.externalbundlewebpackpluginoptions.mainthreadchunks.md delete mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableicu.md delete mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableparallelelement.md create mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableuisourcemap.md create mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.experimental_useelementtemplate.md delete mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.jsx.md delete mode 100644 docs/en/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.pipelineschedulerconfig.md create mode 100644 docs/en/api/rspeedy/rspeedy.bundlefilename.md create mode 100644 docs/en/api/rspeedy/rspeedy.bundlefilenamecontext.entryname.md create mode 100644 docs/en/api/rspeedy/rspeedy.bundlefilenamecontext.lazybundle.md create mode 100644 docs/en/api/rspeedy/rspeedy.bundlefilenamecontext.md create mode 100644 docs/en/api/rspeedy/rspeedy.bundlefilenamecontext.platform.md delete mode 100644 docs/en/api/rspeedy/rspeedy.config.provider.md create mode 100644 docs/en/api/rspeedy/rspeedy.config.splitchunks.md delete mode 100644 docs/en/api/rspeedy/rspeedy.distpath.css.md delete mode 100644 docs/en/api/rspeedy/rspeedy.distpath.cssasync.md delete mode 100644 docs/en/api/rspeedy/rspeedy.distpath.js.md delete mode 100644 docs/en/api/rspeedy/rspeedy.distpath.jsasync.md delete mode 100644 docs/en/api/rspeedy/rspeedy.distpath.root.md create mode 100644 docs/en/api/rspeedy/rspeedy.exposedapi.entries.md delete mode 100644 docs/en/api/rspeedy/rspeedy.minify.cssoptions.md create mode 100644 docs/en/api/rspeedy/rspeedy.rsdoctorrspackpluginoptions.linter.md create mode 100644 docs/en/api/rspeedy/rspeedy.sourcemap.css.md create mode 100644 docs/zh/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx create mode 100644 docs/zh/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx create mode 100644 docs/zh/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx create mode 100644 docs/zh/api/lynx-testing-environment/Interface.LynxEnv.mdx create mode 100644 docs/zh/api/react/Function.GlobalPropsConsumer.mdx create mode 100644 docs/zh/api/react/Function.GlobalPropsProvider.mdx create mode 100644 docs/zh/api/react/Function.createPortal.mdx delete mode 100644 docs/zh/api/react/Function.createRoot.mdx create mode 100644 docs/zh/api/react/Function.useGlobalProps.mdx create mode 100644 docs/zh/api/react/Function.useGlobalPropsChanged.mdx create mode 100644 docs/zh/api/react/Interface.GlobalProps.mdx create mode 100644 docs/zh/api/react/Variable.useErrorBoundary.mdx rename docs/{en/api/reactlynx-testing-library/Variable.prettyFormat.mdx => zh/api/reactlynx-testing-library/Variable.act.mdx} (82%) create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetcontext.rootpath.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.extends.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.resolveexternals.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.externalspresetdefinition.resolvemanagedassets.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.externalspresets.reactlynx.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalbundleroot.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externals.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalspresetdefinitions.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalbundleoptions.externalspresets.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalvalue.bundlepath.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.pluginexternalvalue.url.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.bundlepath.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.reactumdpackagename.md create mode 100644 docs/zh/api/rspeedy/external-bundle-rsbuild-plugin.reactlynxexternalspresetoptions.url.md create mode 100644 docs/zh/api/rspeedy/externals-loading-webpack-plugin.externalsloadingpluginoptions.retries.md create mode 100644 docs/zh/api/rspeedy/externals-loading-webpack-plugin.externalvalue.retries.md create mode 100644 docs/zh/api/rspeedy/lynx-bundle-rslib-config.externalbundlewebpackpluginoptions.mainthreadchunks.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.lynxtemplateplugin.getlynxtemplatepluginhooks.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.lynxtemplateplugin.md delete mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableicu.md delete mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableparallelelement.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableuisourcemap.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.experimental_useelementtemplate.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.globalpropsmode.md delete mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.jsx.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.optimizebundlesize.md delete mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.pipelineschedulerconfig.md create mode 100644 docs/zh/api/rspeedy/react-rsbuild-plugin.shakevisitorconfig.removecall.md create mode 100644 docs/zh/api/rspeedy/rspeedy.bundlefilename.md create mode 100644 docs/zh/api/rspeedy/rspeedy.bundlefilenamecontext.entryname.md create mode 100644 docs/zh/api/rspeedy/rspeedy.bundlefilenamecontext.lazybundle.md create mode 100644 docs/zh/api/rspeedy/rspeedy.bundlefilenamecontext.md create mode 100644 docs/zh/api/rspeedy/rspeedy.bundlefilenamecontext.platform.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.config.provider.md create mode 100644 docs/zh/api/rspeedy/rspeedy.config.splitchunks.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.distpath.css.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.distpath.cssasync.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.distpath.js.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.distpath.jsasync.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.distpath.root.md create mode 100644 docs/zh/api/rspeedy/rspeedy.exposedapi.entries.md delete mode 100644 docs/zh/api/rspeedy/rspeedy.minify.cssoptions.md create mode 100644 docs/zh/api/rspeedy/rspeedy.rsdoctorrspackpluginoptions.linter.md create mode 100644 docs/zh/api/rspeedy/rspeedy.sourcemap.css.md diff --git a/.cspell/dictionary.txt b/.cspell/dictionary.txt index 23a5e4eb1..f237f7234 100644 --- a/.cspell/dictionary.txt +++ b/.cspell/dictionary.txt @@ -103,3 +103,10 @@ yari العاشر ليونيكود initjs +vnode +bgload +bgerror +scrolltoupperedge +scrolltoloweredge +scrolltonormalstate +typia diff --git a/docs/en/api/_meta.json b/docs/en/api/_meta.json index 78226aef1..0afe08cfc 100644 --- a/docs/en/api/_meta.json +++ b/docs/en/api/_meta.json @@ -327,6 +327,13 @@ "collapsed": true, "collapsible": true, "items": [ + { + "label": "css", + "link": "/api/rspeedy/rspeedy.sourcemap.css", + "collapsed": true, + "collapsible": false, + "items": [] + }, { "label": "js", "link": "/api/rspeedy/rspeedy.sourcemap.js", @@ -661,6 +668,13 @@ } ] }, + { + "label": "splitChunks", + "link": "/api/rspeedy/rspeedy.config.splitchunks", + "collapsed": true, + "collapsible": false, + "items": [] + }, { "label": "tools", "link": "/api/rspeedy/rspeedy.tools", @@ -977,14 +991,6 @@ "collapsible": false, "items": [] }, - { - "label": "enableICU", - "type": "custom-link", - "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableicu", - "collapsed": true, - "collapsible": false, - "items": [] - }, { "label": "enableNewGesture", "type": "custom-link", @@ -994,25 +1000,25 @@ "items": [] }, { - "label": "enableParallelElement", + "label": "enableRemoveCSSScope", "type": "custom-link", - "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableparallelelement", + "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableremovecssscope", "collapsed": true, "collapsible": false, "items": [] }, { - "label": "enableRemoveCSSScope", + "label": "enableSSR", "type": "custom-link", - "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableremovecssscope", + "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enablessr", "collapsed": true, "collapsible": false, "items": [] }, { - "label": "enableSSR", + "label": "enableUiSourceMap", "type": "custom-link", - "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enablessr", + "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.enableuisourcemap", "collapsed": true, "collapsible": false, "items": [] @@ -1033,6 +1039,14 @@ "collapsible": false, "items": [] }, + { + "label": "experimental_useElementTemplate", + "type": "custom-link", + "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.experimental_useelementtemplate", + "collapsed": true, + "collapsible": false, + "items": [] + }, { "label": "extractStr", "type": "custom-link", @@ -1058,14 +1072,6 @@ "collapsible": false, "items": [] }, - { - "label": "pipelineSchedulerConfig", - "type": "custom-link", - "link": "/api/rspeedy/react-rsbuild-plugin.pluginreactlynxoptions.pipelineschedulerconfig", - "collapsed": true, - "collapsible": false, - "items": [] - }, { "label": "removeDescendantSelectorScope", "type": "custom-link", diff --git a/docs/en/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx b/docs/en/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx new file mode 100644 index 000000000..46788266c --- /dev/null +++ b/docs/en/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx @@ -0,0 +1,194 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[lynx-testing-environment](/api/lynx-testing-environment/index.mdx) / GlobalEventEmitter + +# Class: GlobalEventEmitter + +The Lynx `GlobalEventEmitter` module, accessible via `lynx.getJSModule('GlobalEventEmitter')`. + +Framework testing libraries can use this to trigger and listen to cross-thread events. + +## Constructors + +### new GlobalEventEmitter() + +```ts +new GlobalEventEmitter(): GlobalEventEmitter +``` + +#### Returns + +[`GlobalEventEmitter`](/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx) + +## Properties + +### listeners + +```ts +listeners: Record; +``` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:9 + +## Methods + +### addListener() + +```ts +addListener(eventName: string, listener: Function): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` | +| `listener` | `Function` | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:10 + +*** + +### clear() + +```ts +clear(): void +``` + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:13 + +*** + +### emit() + +```ts +emit(eventName: string, args: any[]): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` | +| `args` | `any`[] | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:12 + +*** + +### removeAllListeners() + +```ts +removeAllListeners(eventName?: string): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName`? | `string` | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:14 + +*** + +### removeListener() + +```ts +removeListener(eventName: string, listener: Function): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` | +| `listener` | `Function` | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:11 + +*** + +### toggle() + +```ts +toggle(eventName: string, ...data: unknown[]): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` | +| ...`data` | `unknown`[] | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:16 + +*** + +### trigger() + +```ts +trigger(eventName: string, params: string | Record): void +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `string` | +| `params` | `string` \| `Record`\<`any`, `any`\> | + +#### Returns + +`void` + +#### Defined in + +lynx/GlobalEventEmitter.d.ts:15 diff --git a/docs/en/api/lynx-testing-environment/Class.LynxTestingEnv.mdx b/docs/en/api/lynx-testing-environment/Class.LynxTestingEnv.mdx index 022c5ad7a..f7bf1c980 100644 --- a/docs/en/api/lynx-testing-environment/Class.LynxTestingEnv.mdx +++ b/docs/en/api/lynx-testing-environment/Class.LynxTestingEnv.mdx @@ -19,8 +19,9 @@ notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/g ```ts import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); lynxTestingEnv.switchToMainThread(); // use the main thread Element PAPI @@ -35,16 +36,22 @@ __AppendElement(page, view); ### new LynxTestingEnv() ```ts -new LynxTestingEnv(): LynxTestingEnv +new LynxTestingEnv(env?: LynxEnv): LynxTestingEnv ``` +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `env`? | [`LynxEnv`](/api/lynx-testing-environment/Interface.LynxEnv.mdx) | + #### Returns [`LynxTestingEnv`](/api/lynx-testing-environment/Class.LynxTestingEnv.mdx) #### Defined in -index.d.ts:108 +index.d.ts:166 ## Properties @@ -60,8 +67,9 @@ The global object for the background thread. ```ts import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); lynxTestingEnv.switchToBackgroundThread(); // use the background thread global object @@ -70,19 +78,19 @@ globalThis.lynxCoreInject.tt.OnLifecycleEvent(...args); #### Defined in -index.d.ts:88 +index.d.ts:145 *** -### jsdom +### env ```ts -jsdom: JSDOM; +env: LynxEnv; ``` #### Defined in -index.d.ts:107 +index.d.ts:165 *** @@ -98,8 +106,9 @@ The global object for the main thread. ```ts import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); lynxTestingEnv.switchToMainThread(); // use the main thread global object @@ -110,7 +119,7 @@ globalThis.__AppendElement(page, view); #### Defined in -index.d.ts:106 +index.d.ts:164 ## Methods @@ -126,7 +135,7 @@ clearGlobal(): void #### Defined in -index.d.ts:112 +index.d.ts:170 *** @@ -142,7 +151,7 @@ injectGlobals(): void #### Defined in -index.d.ts:109 +index.d.ts:167 *** @@ -158,7 +167,7 @@ reset(): void #### Defined in -index.d.ts:113 +index.d.ts:171 *** @@ -174,7 +183,7 @@ switchToBackgroundThread(): void #### Defined in -index.d.ts:110 +index.d.ts:168 *** @@ -190,4 +199,4 @@ switchToMainThread(): void #### Defined in -index.d.ts:111 +index.d.ts:169 diff --git a/docs/en/api/lynx-testing-environment/Function.initElementTree.mdx b/docs/en/api/lynx-testing-environment/Function.initElementTree.mdx index 975d65014..2a87bb057 100644 --- a/docs/en/api/lynx-testing-environment/Function.initElementTree.mdx +++ b/docs/en/api/lynx-testing-environment/Function.initElementTree.mdx @@ -20,12 +20,26 @@ function initElementTree(): object `object` +### animationMap + +```ts +animationMap: Map; +``` + +**`Internal`** + ### root ```ts root: undefined | LynxElement; ``` +### uniqueId2Element + +```ts +uniqueId2Element: Map; +``` + ### \_\_AddDataset() #### Parameters @@ -194,6 +208,19 @@ root: undefined | LynxElement; [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) +### \_\_ElementAnimate() + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `element` | [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) | +| `args` | [`number`, `string`, `...any[]`] | + +#### Returns + +`void` + ### \_\_FirstElement() #### Parameters @@ -275,6 +302,12 @@ root: undefined | LynxElement; `undefined` \| `object` +### \_\_GetPageElement() + +#### Returns + +`undefined` \| [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) + ### \_\_GetTag() #### Parameters @@ -301,6 +334,20 @@ root: undefined | LynxElement; `void` +### \_\_QuerySelector() + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `e` | [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) | +| `cssSelector` | `string` | +| `_params` | `object` | + +#### Returns + +`undefined` \| [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) + ### \_\_RemoveElement() #### Parameters @@ -314,6 +361,19 @@ root: undefined | LynxElement; `void` +### \_\_RemoveGestureDetector() + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `e` | [`LynxElement`](/api/lynx-testing-environment/Interface.LynxElement.mdx) | +| `id` | `number` | + +#### Returns + +`void` + ### \_\_ReplaceElement() #### Parameters diff --git a/docs/en/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx b/docs/en/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx new file mode 100644 index 000000000..3c97f6731 --- /dev/null +++ b/docs/en/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx @@ -0,0 +1,34 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[lynx-testing-environment](/api/lynx-testing-environment/index.mdx) / installLynxTestingEnv + +# Function: installLynxTestingEnv() + +```ts +function installLynxTestingEnv(target: typeof globalThis & object, env: LynxEnv): void +``` + +Installs a `LynxTestingEnv` instance and its required globals onto a target. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `target` | *typeof* `globalThis` & `object` | +| `env` | [`LynxEnv`](/api/lynx-testing-environment/Interface.LynxEnv.mdx) | + +## Returns + +`void` + +## Defined in + +index.d.ts:90 diff --git a/docs/en/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx b/docs/en/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx new file mode 100644 index 000000000..6af897001 --- /dev/null +++ b/docs/en/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx @@ -0,0 +1,33 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[lynx-testing-environment](/api/lynx-testing-environment/index.mdx) / uninstallLynxTestingEnv + +# Function: uninstallLynxTestingEnv() + +```ts +function uninstallLynxTestingEnv(target: typeof globalThis & object): void +``` + +Removes the globals installed by `installLynxTestingEnv`. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `target` | *typeof* `globalThis` & `object` | + +## Returns + +`void` + +## Defined in + +index.d.ts:100 diff --git a/docs/en/api/lynx-testing-environment/Interface.LynxElement.mdx b/docs/en/api/lynx-testing-environment/Interface.LynxElement.mdx index 67608c4fd..1461fdda6 100644 --- a/docs/en/api/lynx-testing-environment/Interface.LynxElement.mdx +++ b/docs/en/api/lynx-testing-environment/Interface.LynxElement.mdx @@ -14,7 +14,7 @@ import * as Lynx from '@lynx'; Any Lynx Element, such as `view`, `text`, `image`, etc. -[Lynx Spec Reference](/guide/spec.html?ts=1743416098203#element%E2%91%A0) +[Lynx Spec Reference](/living-spec/index.html?ts=1743416098203#element%E2%91%A0) ## Extends diff --git a/docs/en/api/lynx-testing-environment/Interface.LynxEnv.mdx b/docs/en/api/lynx-testing-environment/Interface.LynxEnv.mdx new file mode 100644 index 000000000..04b03696b --- /dev/null +++ b/docs/en/api/lynx-testing-environment/Interface.LynxEnv.mdx @@ -0,0 +1,27 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[lynx-testing-environment](/api/lynx-testing-environment/index.mdx) / LynxEnv + +# Interface: LynxEnv + +The host environment used to initialize `LynxTestingEnv`. + +## Properties + +### window + +```ts +window: any; +``` + +#### Defined in + +index.d.ts:19 diff --git a/docs/en/api/lynx-testing-environment/TypeAlias.ElementTree.mdx b/docs/en/api/lynx-testing-environment/TypeAlias.ElementTree.mdx index 3d611c797..87babf3a3 100644 --- a/docs/en/api/lynx-testing-environment/TypeAlias.ElementTree.mdx +++ b/docs/en/api/lynx-testing-environment/TypeAlias.ElementTree.mdx @@ -20,4 +20,4 @@ The lynx element tree ## Defined in -index.d.ts:17 +index.d.ts:25 diff --git a/docs/en/api/lynx-testing-environment/TypeAlias.ElementTreeGlobals.mdx b/docs/en/api/lynx-testing-environment/TypeAlias.ElementTreeGlobals.mdx index 779457bc4..bd99b5e06 100644 --- a/docs/en/api/lynx-testing-environment/TypeAlias.ElementTreeGlobals.mdx +++ b/docs/en/api/lynx-testing-environment/TypeAlias.ElementTreeGlobals.mdx @@ -20,4 +20,4 @@ The Element PAPI Types ## Defined in -index.d.ts:32 +index.d.ts:40 diff --git a/docs/en/api/lynx-testing-environment/TypeAlias.FilterUnderscoreKeys.mdx b/docs/en/api/lynx-testing-environment/TypeAlias.FilterUnderscoreKeys.mdx index 1ac64c03a..dc45d115c 100644 --- a/docs/en/api/lynx-testing-environment/TypeAlias.FilterUnderscoreKeys.mdx +++ b/docs/en/api/lynx-testing-environment/TypeAlias.FilterUnderscoreKeys.mdx @@ -24,4 +24,4 @@ type FilterUnderscoreKeys: { [K in keyof T]: K extends `__${string}` ? K : ne ## Defined in -index.d.ts:21 +index.d.ts:29 diff --git a/docs/en/api/lynx-testing-environment/TypeAlias.PickUnderscoreKeys.mdx b/docs/en/api/lynx-testing-environment/TypeAlias.PickUnderscoreKeys.mdx index 6d9cbd582..ff26e880f 100644 --- a/docs/en/api/lynx-testing-environment/TypeAlias.PickUnderscoreKeys.mdx +++ b/docs/en/api/lynx-testing-environment/TypeAlias.PickUnderscoreKeys.mdx @@ -24,4 +24,4 @@ type PickUnderscoreKeys: Pick>; ## Defined in -index.d.ts:27 +index.d.ts:35 diff --git a/docs/en/api/lynx-testing-environment/index.mdx b/docs/en/api/lynx-testing-environment/index.mdx index 9cc98f39c..0bf2c454d 100644 --- a/docs/en/api/lynx-testing-environment/index.mdx +++ b/docs/en/api/lynx-testing-environment/index.mdx @@ -18,8 +18,9 @@ The Element PAPI implementation is based on jsdom, for example `__CreateElement` ```js import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); ``` To use `@lynx-js/testing-environment`, you will primarily use the `LynxTestingEnv` constructor, which is a named export of the package. You will get back a `LynxTestingEnv` instance, which has a number of methods of useful properties, notably `switchToMainThread` and `switchToBackgroundThread`, which allow you to switch between the main thread and background thread. @@ -75,6 +76,14 @@ If you want to use `@lynx-js/testing-environment` for unit testing in ReactLynx, Please refer to [ReactLynx Testing Library](/react/reactlynx-testing-library.html) to inherit the configuration from `@lynx-js/react/testing-library`. +### Use in Rstest + +If your runner already provides a `window` global via jsdom, you can load the shared Lynx test environment with: + +```js +import '@lynx-js/testing-environment/env/rstest'; +``` + ## Credits Thanks to: @@ -88,6 +97,7 @@ notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/g | Class | Description | | ------ | ------ | +| [GlobalEventEmitter](/api/lynx-testing-environment/Class.GlobalEventEmitter.mdx) | The Lynx `GlobalEventEmitter` module, accessible via `lynx.getJSModule('GlobalEventEmitter')`. | | [LynxTestingEnv](/api/lynx-testing-environment/Class.LynxTestingEnv.mdx) | A pure-JavaScript implementation of the [Lynx Spec](/guide/spec.html), notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/guide/spec#dual-threaded-model) for use with Node.js. | ## Interfaces @@ -95,6 +105,7 @@ notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/g | Interface | Description | | ------ | ------ | | [LynxElement](/api/lynx-testing-environment/Interface.LynxElement.mdx) | Any Lynx Element, such as `view`, `text`, `image`, etc. | +| [LynxEnv](/api/lynx-testing-environment/Interface.LynxEnv.mdx) | The host environment used to initialize `LynxTestingEnv`. | | [LynxGlobalThis](/api/lynx-testing-environment/Interface.LynxGlobalThis.mdx) | The `globalThis` object of Lynx dual thread environment. | ## Type Aliases @@ -111,3 +122,5 @@ notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/g | Function | Description | | ------ | ------ | | [initElementTree](/api/lynx-testing-environment/Function.initElementTree.mdx) | - | +| [installLynxTestingEnv](/api/lynx-testing-environment/Function.installLynxTestingEnv.mdx) | Installs a `LynxTestingEnv` instance and its required globals onto a target. | +| [uninstallLynxTestingEnv](/api/lynx-testing-environment/Function.uninstallLynxTestingEnv.mdx) | Removes the globals installed by `installLynxTestingEnv`. | diff --git a/docs/en/api/react/Class.Component.mdx b/docs/en/api/react/Class.Component.mdx index edfaedaf2..f14af23af 100644 --- a/docs/en/api/react/Class.Component.mdx +++ b/docs/en/api/react/Class.Component.mdx @@ -52,7 +52,7 @@ new Component(props: P): Component #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1009 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1017 ### new Component() @@ -83,7 +83,7 @@ new Component(props: P, context: any): Component #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1014 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1022 ## Properties @@ -113,7 +113,7 @@ declare context: React.ContextType #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1007 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1015 *** @@ -125,7 +125,7 @@ readonly props: Readonly

; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1027 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1035 *** @@ -147,7 +147,7 @@ refs: object; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1034 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1042 *** @@ -159,7 +159,7 @@ state: Readonly; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1028 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1036 *** @@ -192,7 +192,7 @@ class Foo extends React.Component { #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:989 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:997 ## Methods @@ -222,7 +222,7 @@ the entire component tree to unmount. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1391 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1399 *** @@ -244,7 +244,7 @@ Called immediately after a component is mounted. Setting state here will trigger #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1370 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1378 *** @@ -279,7 +279,7 @@ The snapshot is only present if [getSnapshotBeforeUpdate](/api/react/Class.Compo #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1433 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1441 *** @@ -315,7 +315,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1449 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1457 *** @@ -361,7 +361,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1480 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1488 *** @@ -384,7 +384,7 @@ cancelled network requests, or cleaning up any DOM elements created in `componen #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1386 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1394 *** @@ -432,7 +432,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1512 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1520 *** @@ -454,14 +454,14 @@ forceUpdate(callback?: () => void): void #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1024 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1032 *** ### getSnapshotBeforeUpdate()? ```ts -optional getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: Readonly): SS +optional getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: Readonly): null | SS ``` Runs before React applies the result of [render](/api/react/Class.Component.mdx#render) to the document, and @@ -480,7 +480,7 @@ lifecycle events from running. #### Returns -`SS` +`null` \| `SS` #### Inherited from @@ -488,7 +488,7 @@ lifecycle events from running. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1427 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1435 *** @@ -504,14 +504,14 @@ render(): ReactNode #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1025 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1033 *** ### setState() ```ts -setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick | Pick, callback?: () => void): void +setState(state: null | S | (prevState: Readonly, props: Readonly

) => null | S | Pick | Pick, callback?: () => void): void ``` #### Type Parameters @@ -524,7 +524,7 @@ setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick< | Parameter | Type | | ------ | ------ | -| `state` | `S` \| (`prevState`: `Readonly`\<`S`\>, `props`: `Readonly`\<`P`\>) => `S` \| `Pick`\<`S`, `K`\> \| `Pick`\<`S`, `K`\> | +| `state` | `null` \| `S` \| (`prevState`: `Readonly`\<`S`\>, `props`: `Readonly`\<`P`\>) => `null` \| `S` \| `Pick`\<`S`, `K`\> \| `Pick`\<`S`, `K`\> | | `callback`? | () => `void` | #### Returns @@ -533,7 +533,7 @@ setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick< #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1019 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1027 *** @@ -573,7 +573,7 @@ and `componentDidUpdate` will not be called. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1381 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1389 *** @@ -611,7 +611,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1464 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1472 *** @@ -659,7 +659,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1498 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1506 *** @@ -709,4 +709,4 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1528 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1536 diff --git a/docs/en/api/react/Class.MainThreadRef.mdx b/docs/en/api/react/Class.MainThreadRef.mdx index 6d90a4d44..27714e521 100644 --- a/docs/en/api/react/Class.MainThreadRef.mdx +++ b/docs/en/api/react/Class.MainThreadRef.mdx @@ -51,7 +51,7 @@ new MainThreadRef(initValue: T): MainThreadRef #### Defined in -@lynx-js/react/runtime/lib/worklet/ref/workletRef.d.ts:15 +@lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:15 ## Accessors @@ -89,4 +89,4 @@ set current(_: T): void #### Defined in -@lynx-js/react/runtime/lib/worklet/ref/workletRef.d.ts:4 +@lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:4 diff --git a/docs/en/api/react/Class.PureComponent.mdx b/docs/en/api/react/Class.PureComponent.mdx index 96197dee6..910afcc87 100644 --- a/docs/en/api/react/Class.PureComponent.mdx +++ b/docs/en/api/react/Class.PureComponent.mdx @@ -48,7 +48,7 @@ new PureComponent(props: P): PureComponent #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1009 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1017 ### new PureComponent() @@ -79,7 +79,7 @@ new PureComponent(props: P, context: any): PureComponent #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1014 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1022 ## Properties @@ -113,7 +113,7 @@ declare context: React.ContextType #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1007 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1015 *** @@ -129,7 +129,7 @@ readonly props: Readonly

; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1027 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1035 *** @@ -155,7 +155,7 @@ refs: object; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1034 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1042 *** @@ -171,7 +171,7 @@ state: Readonly; #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1028 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1036 *** @@ -208,7 +208,7 @@ class Foo extends React.Component { #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:989 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:997 ## Methods @@ -238,7 +238,7 @@ the entire component tree to unmount. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1391 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1399 *** @@ -260,7 +260,7 @@ Called immediately after a component is mounted. Setting state here will trigger #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1370 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1378 *** @@ -295,7 +295,7 @@ The snapshot is only present if [getSnapshotBeforeUpdate](/api/react/Class.PureC #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1433 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1441 *** @@ -331,7 +331,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1449 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1457 *** @@ -377,7 +377,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1480 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1488 *** @@ -400,7 +400,7 @@ cancelled network requests, or cleaning up any DOM elements created in `componen #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1386 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1394 *** @@ -448,7 +448,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1512 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1520 *** @@ -474,14 +474,14 @@ forceUpdate(callback?: () => void): void #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1024 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1032 *** ### getSnapshotBeforeUpdate()? ```ts -optional getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: Readonly): SS +optional getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: Readonly): null | SS ``` Runs before React applies the result of [render](/api/react/Class.Component.mdx#render) to the document, and @@ -500,7 +500,7 @@ lifecycle events from running. #### Returns -`SS` +`null` \| `SS` #### Inherited from @@ -508,7 +508,7 @@ lifecycle events from running. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1427 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1435 *** @@ -528,14 +528,14 @@ render(): ReactNode #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1025 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1033 *** ### setState() ```ts -setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick | Pick, callback?: () => void): void +setState(state: null | S | (prevState: Readonly, props: Readonly

) => null | S | Pick | Pick, callback?: () => void): void ``` #### Type Parameters @@ -548,7 +548,7 @@ setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick< | Parameter | Type | | ------ | ------ | -| `state` | `S` \| (`prevState`: `Readonly`\<`S`\>, `props`: `Readonly`\<`P`\>) => `S` \| `Pick`\<`S`, `K`\> \| `Pick`\<`S`, `K`\> | +| `state` | `null` \| `S` \| (`prevState`: `Readonly`\<`S`\>, `props`: `Readonly`\<`P`\>) => `null` \| `S` \| `Pick`\<`S`, `K`\> \| `Pick`\<`S`, `K`\> | | `callback`? | () => `void` | #### Returns @@ -561,7 +561,7 @@ setState(state: S | (prevState: Readonly, props: Readonly

) => S | Pick< #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1019 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1027 *** @@ -601,7 +601,7 @@ and `componentDidUpdate` will not be called. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1381 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1389 *** @@ -639,7 +639,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1464 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1472 *** @@ -687,7 +687,7 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1498 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1506 *** @@ -737,4 +737,4 @@ this from being invoked. #### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1528 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1536 diff --git a/docs/en/api/react/Function.Fragment.mdx b/docs/en/api/react/Function.Fragment.mdx index 46ad0462b..2effb9770 100644 --- a/docs/en/api/react/Function.Fragment.mdx +++ b/docs/en/api/react/Function.Fragment.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: Fragment() ```ts -function Fragment(props: object): ReactElement> +function Fragment(props: object): null | ReactElement> ``` Lets you group elements without a wrapper node. @@ -27,7 +27,7 @@ Lets you group elements without a wrapper node. ## Returns -`ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> +`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> ## See @@ -55,4 +55,4 @@ import { Fragment } from 'react'; ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:823 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:831 diff --git a/docs/en/api/react/Function.GlobalPropsConsumer.mdx b/docs/en/api/react/Function.GlobalPropsConsumer.mdx new file mode 100644 index 000000000..ffb869958 --- /dev/null +++ b/docs/en/api/react/Function.GlobalPropsConsumer.mdx @@ -0,0 +1,34 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[@lynx-js/react](/api/react/index.mdx) / GlobalPropsConsumer + +# Function: GlobalPropsConsumer() + +```ts +function GlobalPropsConsumer(props: ConsumerProps): null | ReactElement> +``` + +The [Consumer](https://react.dev/reference/react/createContext#consumer) Component that provide `lynx.__globalProps`. +This should be used with [GlobalPropsProvider](/api/react/Function.GlobalPropsProvider.mdx) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | `ConsumerProps`\<[`GlobalProps`](/api/react/Interface.GlobalProps.mdx)\> | + +## Returns + +`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> + +## Defined in + +@lynx-js/react/runtime/lib/lynx-api.d.ts:175 diff --git a/docs/en/api/react/Function.GlobalPropsProvider.mdx b/docs/en/api/react/Function.GlobalPropsProvider.mdx new file mode 100644 index 000000000..98625528c --- /dev/null +++ b/docs/en/api/react/Function.GlobalPropsProvider.mdx @@ -0,0 +1,55 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[@lynx-js/react](/api/react/index.mdx) / GlobalPropsProvider + +# Function: GlobalPropsProvider() + +```ts +function GlobalPropsProvider(props: object, deprecatedLegacyContext?: any): null | ReactElement +``` + +The [Provider](https://react.dev/reference/react/createContext#provider) Component that provide `lynx.__globalProps`, +you must wrap your JSX inside it + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `props` | `object` | - | +| `props.children`? | `ReactNode` | - | +| `deprecatedLegacyContext`? | `any` | **Deprecated** **See** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) | + +## Returns + +`null` \| `ReactElement`\<`any`, `any`\> + +## Example + +```ts +import { root } from "@lynx-js/react" + +function App() { + return ( + ...}/> + ) +} + +root.render( + + + +); + +``` + +## Defined in + +@lynx-js/react/runtime/lib/lynx-api.d.ts:166 diff --git a/docs/en/api/react/Function.InitDataConsumer.mdx b/docs/en/api/react/Function.InitDataConsumer.mdx index 9b4d47825..478bd9d00 100644 --- a/docs/en/api/react/Function.InitDataConsumer.mdx +++ b/docs/en/api/react/Function.InitDataConsumer.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: InitDataConsumer() ```ts -function InitDataConsumer(props: ConsumerProps): ReactElement> +function InitDataConsumer(props: ConsumerProps): null | ReactElement> ``` The [Consumer](https://react.dev/reference/react/createContext#consumer) Component that provide `initData`. @@ -27,8 +27,8 @@ This should be used with [InitDataProvider](/api/react/Function.InitDataProvider ## Returns -`ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> +`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> ## Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:106 +@lynx-js/react/runtime/lib/lynx-api.d.ts:107 diff --git a/docs/en/api/react/Function.InitDataProvider.mdx b/docs/en/api/react/Function.InitDataProvider.mdx index ea31908fc..158550bd1 100644 --- a/docs/en/api/react/Function.InitDataProvider.mdx +++ b/docs/en/api/react/Function.InitDataProvider.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: InitDataProvider() ```ts -function InitDataProvider(props: object, deprecatedLegacyContext?: any): ReactElement +function InitDataProvider(props: object, deprecatedLegacyContext?: any): null | ReactElement ``` The [Provider](https://react.dev/reference/react/createContext#provider) Component that provide `initData`, @@ -29,7 +29,7 @@ you must wrap your JSX inside it ## Returns -`ReactElement`\<`any`, `any`\> +`null` \| `ReactElement`\<`any`, `any`\> ## Example @@ -52,4 +52,4 @@ root.render( ## Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:97 +@lynx-js/react/runtime/lib/lynx-api.d.ts:98 diff --git a/docs/en/api/react/Function.Suspense.mdx b/docs/en/api/react/Function.Suspense.mdx index 2935e352b..4c3a0a6c9 100644 --- a/docs/en/api/react/Function.Suspense.mdx +++ b/docs/en/api/react/Function.Suspense.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: Suspense() ```ts -function Suspense(props: SuspenseProps): ReactElement> +function Suspense(props: SuspenseProps): null | ReactElement> ``` Lets you display a fallback until its children have finished loading. @@ -26,7 +26,7 @@ Lets you display a fallback until its children have finished loading. ## Returns -`ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> +`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> ## See @@ -44,4 +44,4 @@ import { Suspense } from 'react'; ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:875 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:883 diff --git a/docs/en/api/react/Function.cloneElement.mdx b/docs/en/api/react/Function.cloneElement.mdx index 7dbf25f12..b70adce19 100644 --- a/docs/en/api/react/Function.cloneElement.mdx +++ b/docs/en/api/react/Function.cloneElement.mdx @@ -42,7 +42,7 @@ children?: ReactNode[]): DetailedReactHTMLElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:563 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:571 ## cloneElement(element, props, children) @@ -74,7 +74,7 @@ children?: ReactNode[]): ReactHTMLElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:569 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:577 ## cloneElement(element, props, children) @@ -106,7 +106,7 @@ function cloneElement( ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:575 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:583 ## cloneElement(element, props, children) @@ -138,7 +138,7 @@ children?: ReactNode[]): DOMElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:581 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:589 ## cloneElement(element, props, children) @@ -169,7 +169,7 @@ children?: ReactNode[]): FunctionComponentElement

### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:588 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:596 ## cloneElement(element, props, children) @@ -201,7 +201,7 @@ children?: ReactNode[]): CElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:593 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:601 ## cloneElement(element, props, children) @@ -232,4 +232,4 @@ children?: ReactNode[]): ReactElement

### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:598 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:606 diff --git a/docs/en/api/react/Function.createContext.mdx b/docs/en/api/react/Function.createContext.mdx index 3a14fb10e..deabe5aa5 100644 --- a/docs/en/api/react/Function.createContext.mdx +++ b/docs/en/api/react/Function.createContext.mdx @@ -49,4 +49,4 @@ const ThemeContext = createContext('light'); ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:775 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:783 diff --git a/docs/en/api/react/Function.createElement.mdx b/docs/en/api/react/Function.createElement.mdx index 6f15d4220..a2b3cd964 100644 --- a/docs/en/api/react/Function.createElement.mdx +++ b/docs/en/api/react/Function.createElement.mdx @@ -17,7 +17,7 @@ import * as Lynx from '@lynx'; ```ts function createElement( type: "input", - props?: InputHTMLAttributes & ClassAttributes, ... + props?: null | InputHTMLAttributes & ClassAttributes, ... children?: ReactNode[]): DetailedReactHTMLElement, HTMLInputElement> ``` @@ -26,7 +26,7 @@ children?: ReactNode[]): DetailedReactHTMLElement & `ClassAttributes`\<`HTMLInputElement`\> | +| `props`? | `null` \| `InputHTMLAttributes`\<`HTMLInputElement`\> & `ClassAttributes`\<`HTMLInputElement`\> | | ...`children`? | `ReactNode`[] | ### Returns @@ -35,14 +35,14 @@ children?: ReactNode[]): DetailedReactHTMLElement( type: keyof ReactHTML, - props?: ClassAttributes & P, ... + props?: null | ClassAttributes & P, ... children?: ReactNode[]): DetailedReactHTMLElement ``` @@ -58,7 +58,7 @@ children?: ReactNode[]): DetailedReactHTMLElement | Parameter | Type | | ------ | ------ | | `type` | keyof `ReactHTML` | -| `props`? | `ClassAttributes`\<`T`\> & `P` | +| `props`? | `null` \| `ClassAttributes`\<`T`\> & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -67,14 +67,14 @@ children?: ReactNode[]): DetailedReactHTMLElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:527 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:535 ## createElement(type, props, children) ```ts function createElement( type: keyof ReactSVG, - props?: ClassAttributes & P, ... + props?: null | ClassAttributes & P, ... children?: ReactNode[]): ReactSVGElement ``` @@ -90,7 +90,7 @@ function createElement( | Parameter | Type | | ------ | ------ | | `type` | keyof `ReactSVG` | -| `props`? | `ClassAttributes`\<`T`\> & `P` | +| `props`? | `null` \| `ClassAttributes`\<`T`\> & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -99,14 +99,14 @@ function createElement( ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:532 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:540 ## createElement(type, props, children) ```ts function createElement( type: string, - props?: ClassAttributes & P, ... + props?: null | ClassAttributes & P, ... children?: ReactNode[]): DOMElement ``` @@ -122,7 +122,7 @@ children?: ReactNode[]): DOMElement | Parameter | Type | | ------ | ------ | | `type` | `string` | -| `props`? | `ClassAttributes`\<`T`\> & `P` | +| `props`? | `null` \| `ClassAttributes`\<`T`\> & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -131,14 +131,14 @@ children?: ReactNode[]): DOMElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:537 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:545 ## createElement(type, props, children) ```ts function createElement

( type: FunctionComponent

, - props?: Attributes & P, ... + props?: null | Attributes & P, ... children?: ReactNode[]): FunctionComponentElement

``` @@ -153,7 +153,7 @@ children?: ReactNode[]): FunctionComponentElement

| Parameter | Type | | ------ | ------ | | `type` | `FunctionComponent`\<`P`\> | -| `props`? | `Attributes` & `P` | +| `props`? | `null` \| `Attributes` & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -162,14 +162,14 @@ children?: ReactNode[]): FunctionComponentElement

### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:545 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:553 ## createElement(type, props, children) ```ts function createElement( type: ClassType, - props?: ClassAttributes & P, ... + props?: null | ClassAttributes & P, ... children?: ReactNode[]): CElement ``` @@ -186,7 +186,7 @@ children?: ReactNode[]): CElement | Parameter | Type | | ------ | ------ | | `type` | `ClassType`\<`P`, `T`, `C`\> | -| `props`? | `ClassAttributes`\<`T`\> & `P` | +| `props`? | `null` \| `ClassAttributes`\<`T`\> & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -195,14 +195,14 @@ children?: ReactNode[]): CElement ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:550 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:558 ## createElement(type, props, children) ```ts function createElement

( type: string | FunctionComponent

| ComponentClass, - props?: Attributes & P, ... + props?: null | Attributes & P, ... children?: ReactNode[]): ReactElement

``` @@ -217,7 +217,7 @@ children?: ReactNode[]): ReactElement

| Parameter | Type | | ------ | ------ | | `type` | `string` \| `FunctionComponent`\<`P`\> \| `ComponentClass`\<`P`, `any`\> | -| `props`? | `Attributes` & `P` | +| `props`? | `null` \| `Attributes` & `P` | | ...`children`? | `ReactNode`[] | ### Returns @@ -226,4 +226,4 @@ children?: ReactNode[]): ReactElement

### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:555 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:563 diff --git a/docs/en/api/react/Function.createPortal.mdx b/docs/en/api/react/Function.createPortal.mdx new file mode 100644 index 000000000..f4bf1b8da --- /dev/null +++ b/docs/en/api/react/Function.createPortal.mdx @@ -0,0 +1,34 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[@lynx-js/react](/api/react/index.mdx) / createPortal + +# Function: createPortal() + +```ts +function createPortal(vnode: ComponentChild, container: NodesRef): useErrorBoundary | null +``` + +Create a `Portal` to continue rendering the vnode tree at a different DOM node. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `vnode` | `ComponentChild` | +| `container` | `NodesRef` | + +## Returns + +[`useErrorBoundary`](/api/react/Variable.useErrorBoundary.mdx)\<`any`\> \| `null` + +## Defined in + +@lynx-js/react/runtime/lib/snapshot/lynx/portals.d.ts:9 diff --git a/docs/en/api/react/Function.createRef.mdx b/docs/en/api/react/Function.createRef.mdx index d350db918..da6f486f7 100644 --- a/docs/en/api/react/Function.createRef.mdx +++ b/docs/en/api/react/Function.createRef.mdx @@ -28,4 +28,4 @@ function createRef(): RefObject ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1562 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1570 diff --git a/docs/en/api/react/Function.createRoot.mdx b/docs/en/api/react/Function.createRoot.mdx deleted file mode 100644 index 171cfba5d..000000000 --- a/docs/en/api/react/Function.createRoot.mdx +++ /dev/null @@ -1,33 +0,0 @@ -{/* -* This file is generated by @lynx-js/tool-typedoc. -* Do not edit this file directly. -* @generated -*/} - -{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} -import * as Lynx from '@lynx'; - - -[react](/api/react/index.mdx) / createRoot - -# Function: ~~createRoot()~~ - -```ts -function createRoot(): Root -``` - -The default and only root of ReactLynx for you to render JSX - -## Returns - -[`Root`](/api/react/Interface.Root.mdx) - -Always return [root](/api/react/Variable.root.mdx). - -## Deprecated - -use [root](/api/react/Variable.root.mdx) instead - -## Defined in - -@lynx-js/react/runtime/lib/lynx-api.d.ts:78 diff --git a/docs/en/api/react/Function.forwardRef.mdx b/docs/en/api/react/Function.forwardRef.mdx index 8a59a367b..f97934c41 100644 --- a/docs/en/api/react/Function.forwardRef.mdx +++ b/docs/en/api/react/Function.forwardRef.mdx @@ -58,4 +58,4 @@ export const FancyButton = forwardRef((props, ref) => ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1606 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1614 diff --git a/docs/en/api/react/Function.isValidElement.mdx b/docs/en/api/react/Function.isValidElement.mdx index c9289c758..b02377ab2 100644 --- a/docs/en/api/react/Function.isValidElement.mdx +++ b/docs/en/api/react/Function.isValidElement.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: isValidElement() ```ts -function isValidElement

(object: object): object is ReactElement> +function isValidElement

(object: undefined | null | object): object is ReactElement> ``` ## Type Parameters @@ -26,7 +26,7 @@ function isValidElement

(object: object): object is ReactElement\> ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:781 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:789 diff --git a/docs/en/api/react/Function.lazy.mdx b/docs/en/api/react/Function.lazy.mdx index 5035a0059..483faac3e 100644 --- a/docs/en/api/react/Function.lazy.mdx +++ b/docs/en/api/react/Function.lazy.mdx @@ -48,4 +48,4 @@ const MarkdownPreview = lazy(() => import('./MarkdownPreview.js')); ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1802 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1810 diff --git a/docs/en/api/react/Function.memo.mdx b/docs/en/api/react/Function.memo.mdx index c539b382a..2804f37b2 100644 --- a/docs/en/api/react/Function.memo.mdx +++ b/docs/en/api/react/Function.memo.mdx @@ -53,7 +53,7 @@ const SomeComponent = memo(function SomeComponent(props: { foo: string }) { ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1767 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1775 ## memo(Component, propsAreEqual) @@ -80,4 +80,4 @@ function memo(Component: T, propsAreEqual?: (prevProps: Readonly void): void +``` + +A React Hooks for you to get notified when `__globalProps` changed. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `callback` | (`data`: [`GlobalProps`](/api/react/Interface.GlobalProps.mdx)) => `void` | + +## Returns + +`void` + +## Example + +```ts +function App() { + useGlobalPropsChanged((data) => { + lynx.__globalProps.someProperty // can use lynx.__globalProps + data.someProperty // can use data + }) +} +``` + +## Defined in + +@lynx-js/react/runtime/lib/lynx-api.d.ts:207 diff --git a/docs/en/api/react/Function.useImperativeHandle.mdx b/docs/en/api/react/Function.useImperativeHandle.mdx index 469310b71..c48e47963 100644 --- a/docs/en/api/react/Function.useImperativeHandle.mdx +++ b/docs/en/api/react/Function.useImperativeHandle.mdx @@ -14,7 +14,7 @@ import * as Lynx from '@lynx'; ```ts function useImperativeHandle( - ref: Ref, + ref: undefined | Ref, init: () => R, deps?: DependencyList): void ``` @@ -35,7 +35,7 @@ function useImperativeHandle( | Parameter | Type | | ------ | ------ | -| `ref` | `Ref`\<`T`\> | +| `ref` | `undefined` \| `Ref`\<`T`\> | | `init` | () => `R` | | `deps`? | `DependencyList` | @@ -53,4 +53,4 @@ function useImperativeHandle( ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:2049 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:2057 diff --git a/docs/en/api/react/Function.useInitData.mdx b/docs/en/api/react/Function.useInitData.mdx index e5e225113..18cacad78 100644 --- a/docs/en/api/react/Function.useInitData.mdx +++ b/docs/en/api/react/Function.useInitData.mdx @@ -35,4 +35,4 @@ function App() { ## Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:123 +@lynx-js/react/runtime/lib/lynx-api.d.ts:124 diff --git a/docs/en/api/react/Function.useInitDataChanged.mdx b/docs/en/api/react/Function.useInitDataChanged.mdx index 97f5d2e04..e6bac7048 100644 --- a/docs/en/api/react/Function.useInitDataChanged.mdx +++ b/docs/en/api/react/Function.useInitDataChanged.mdx @@ -40,4 +40,4 @@ function App() { ## Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:137 +@lynx-js/react/runtime/lib/lynx-api.d.ts:138 diff --git a/docs/en/api/react/Function.useLayoutEffect.mdx b/docs/en/api/react/Function.useLayoutEffect.mdx index 03b565559..35c75279f 100644 --- a/docs/en/api/react/Function.useLayoutEffect.mdx +++ b/docs/en/api/react/Function.useLayoutEffect.mdx @@ -37,4 +37,4 @@ Accepts a function that contains imperative, possibly effectful code. The effect ## Defined in -@lynx-js/react/runtime/lib/hooks/react.d.ts:15 +@lynx-js/react/runtime/lib/core/hooks/react.d.ts:26 diff --git a/docs/en/api/react/Function.useLynxGlobalEventListener.mdx b/docs/en/api/react/Function.useLynxGlobalEventListener.mdx index 27b7b5d1b..98d440aa1 100644 --- a/docs/en/api/react/Function.useLynxGlobalEventListener.mdx +++ b/docs/en/api/react/Function.useLynxGlobalEventListener.mdx @@ -16,7 +16,7 @@ import * as Lynx from '@lynx'; function useLynxGlobalEventListener(eventName: string, listener: T): void ``` -`useLynxGlobalEventListener` help you `addListener` as early as possible. +`useLynxGlobalEventListener` helps you `addListener` as early as possible. ## Type Parameters @@ -58,4 +58,4 @@ function App() { ## Defined in -@lynx-js/react/runtime/lib/hooks/useLynxGlobalEventListener.d.ts:29 +@lynx-js/react/runtime/lib/core/hooks/useLynxGlobalEventListener.d.ts:29 diff --git a/docs/en/api/react/Function.useMainThreadRef.mdx b/docs/en/api/react/Function.useMainThreadRef.mdx index 52bb6c6de..559df3f9a 100644 --- a/docs/en/api/react/Function.useMainThreadRef.mdx +++ b/docs/en/api/react/Function.useMainThreadRef.mdx @@ -69,12 +69,12 @@ export function App() { ### Defined in -@lynx-js/react/runtime/lib/worklet/ref/workletRef.d.ts:55 +@lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:55 ## useMainThreadRef(initValue) ```ts -function useMainThreadRef(initValue: T): RefObject +function useMainThreadRef(initValue: null | T): RefObject ``` Create A `MainThreadRef`. @@ -96,7 +96,7 @@ It is a hook and it should only be called at the top level of your component. | Parameter | Type | Description | | ------ | ------ | ------ | -| `initValue` | `T` | The init value of the `MainThreadRef`. | +| `initValue` | `null` \| `T` | The init value of the `MainThreadRef`. | ### Returns @@ -128,7 +128,7 @@ export function App() { ### Defined in -@lynx-js/react/runtime/lib/worklet/ref/workletRef.d.ts:94 +@lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:94 ## useMainThreadRef() @@ -181,4 +181,4 @@ export function App() { ### Defined in -@lynx-js/react/runtime/lib/worklet/ref/workletRef.d.ts:131 +@lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:131 diff --git a/docs/en/api/react/Function.useMemo.mdx b/docs/en/api/react/Function.useMemo.mdx index dfa5e6035..1869fdb2f 100644 --- a/docs/en/api/react/Function.useMemo.mdx +++ b/docs/en/api/react/Function.useMemo.mdx @@ -45,4 +45,4 @@ function useMemo(factory: () => T, deps: DependencyList): T ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:2070 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:2078 diff --git a/docs/en/api/react/Function.useReducer.mdx b/docs/en/api/react/Function.useReducer.mdx index 65ace6013..d7e96b6a9 100644 --- a/docs/en/api/react/Function.useReducer.mdx +++ b/docs/en/api/react/Function.useReducer.mdx @@ -56,7 +56,7 @@ updates because you can pass `dispatch` down instead of callbacks. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1896 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1904 ## useReducer(reducer, initializerArg, initializer) @@ -101,7 +101,7 @@ updates because you can pass `dispatch` down instead of callbacks. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1912 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1920 ## useReducer(reducer, initializerArg, initializer) @@ -147,7 +147,7 @@ updates because you can pass `dispatch` down instead of callbacks. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1930 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1938 ## useReducer(reducer, initializerArg, initializer) @@ -193,7 +193,7 @@ updates because you can pass `dispatch` down instead of callbacks. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1946 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1954 ## useReducer(reducer, initialState, initializer) @@ -238,4 +238,4 @@ updates because you can pass `dispatch` down instead of callbacks. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1971 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1979 diff --git a/docs/en/api/react/Function.useRef.mdx b/docs/en/api/react/Function.useRef.mdx index 5f497c654..dec928ea1 100644 --- a/docs/en/api/react/Function.useRef.mdx +++ b/docs/en/api/react/Function.useRef.mdx @@ -50,12 +50,12 @@ value around similar to how you’d use instance fields in classes. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1986 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1994 ## useRef(initialValue) ```ts -function useRef(initialValue: T): RefObject +function useRef(initialValue: null | T): RefObject ``` `useRef` returns a mutable ref object whose `.current` property is initialized to the passed argument @@ -77,7 +77,7 @@ of the generic argument. | Parameter | Type | | ------ | ------ | -| `initialValue` | `T` | +| `initialValue` | `null` \| `T` | ### Returns @@ -93,12 +93,12 @@ of the generic argument. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:2001 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:2009 -## useRef() +## useRef(initialValue) ```ts -function useRef(): MutableRefObject +function useRef(initialValue?: undefined): MutableRefObject ``` `useRef` returns a mutable ref object whose `.current` property is initialized to the passed argument @@ -113,6 +113,12 @@ value around similar to how you’d use instance fields in classes. | ------ | ------ | | `T` | `undefined` | +### Parameters + +| Parameter | Type | +| ------ | ------ | +| `initialValue`? | `undefined` | + ### Returns `MutableRefObject`\<`T` \| `undefined`\> @@ -127,4 +133,4 @@ value around similar to how you’d use instance fields in classes. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:2014 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:2022 diff --git a/docs/en/api/react/Function.useState.mdx b/docs/en/api/react/Function.useState.mdx index a95cdf0c3..4790a0998 100644 --- a/docs/en/api/react/Function.useState.mdx +++ b/docs/en/api/react/Function.useState.mdx @@ -46,7 +46,7 @@ Returns a stateful value, and a function to update it. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1876 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1884 ## useState() @@ -76,4 +76,4 @@ Returns a stateful value, and a function to update it. ### Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:1884 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:1892 diff --git a/docs/en/api/react/Function.useSyncExternalStore.mdx b/docs/en/api/react/Function.useSyncExternalStore.mdx index 75078ac99..1794977c4 100644 --- a/docs/en/api/react/Function.useSyncExternalStore.mdx +++ b/docs/en/api/react/Function.useSyncExternalStore.mdx @@ -43,4 +43,4 @@ function useSyncExternalStore( ## Defined in -.pnpm/@types+react@18.3.11/node\_modules/@types/react/ts5.0/index.d.ts:2168 +.pnpm/@types+react@18.3.28/node\_modules/@types/react/ts5.0/index.d.ts:2176 diff --git a/docs/en/api/react/Function.withInitDataInState.mdx b/docs/en/api/react/Function.withInitDataInState.mdx index 873eb5075..6257d8c31 100644 --- a/docs/en/api/react/Function.withInitDataInState.mdx +++ b/docs/en/api/react/Function.withInitDataInState.mdx @@ -54,4 +54,4 @@ export default withInitDataInState(App); ## Defined in -@lynx-js/react/runtime/lib/compat/initData.d.ts:44 +@lynx-js/react/runtime/lib/core/initData.d.ts:44 diff --git a/docs/en/api/react/Interface.DataProcessorDefinition.mdx b/docs/en/api/react/Interface.DataProcessorDefinition.mdx index 961d71637..6441e27e0 100644 --- a/docs/en/api/react/Interface.DataProcessorDefinition.mdx +++ b/docs/en/api/react/Interface.DataProcessorDefinition.mdx @@ -26,7 +26,7 @@ Should be used with `lynx.registerDataProcessors`. See more examples at [Lynx.re #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:254 +@lynx-js/react/runtime/lib/lynx-api.d.ts:324 *** @@ -52,4 +52,4 @@ Should be used with `lynx.registerDataProcessors`. See more examples at [Lynx.re #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:248 +@lynx-js/react/runtime/lib/lynx-api.d.ts:318 diff --git a/docs/en/api/react/Interface.DataProcessors.mdx b/docs/en/api/react/Interface.DataProcessors.mdx index f35b5c2a3..4cd4075db 100644 --- a/docs/en/api/react/Interface.DataProcessors.mdx +++ b/docs/en/api/react/Interface.DataProcessors.mdx @@ -98,4 +98,4 @@ lynx.registerDataProcessors({ #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:212 +@lynx-js/react/runtime/lib/lynx-api.d.ts:282 diff --git a/docs/en/api/react/Interface.GlobalProps.mdx b/docs/en/api/react/Interface.GlobalProps.mdx new file mode 100644 index 000000000..6c938f8b8 --- /dev/null +++ b/docs/en/api/react/Interface.GlobalProps.mdx @@ -0,0 +1,15 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[@lynx-js/react](/api/react/index.mdx) / GlobalProps + +# Interface: GlobalProps + +The interface you can extends so that the `useGlobalProps` returning value can be customized diff --git a/docs/en/api/react/Interface.Lynx.mdx b/docs/en/api/react/Interface.Lynx.mdx index ff5e40540..45568501b 100644 --- a/docs/en/api/react/Interface.Lynx.mdx +++ b/docs/en/api/react/Interface.Lynx.mdx @@ -24,54 +24,6 @@ lynx.querySelectorAll(...); ## Properties -### querySelector() - -```ts -querySelector: (selector: string) => null | Element; -``` - -Select the first element matching the given CSS selector in the page. - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `selector` | `string` | CSS Selector string. | - -#### Returns - -`null` \| `Element` - -#### Defined in - -@lynx-js/react/runtime/lib/lynx-api.d.ts:323 - -*** - -### querySelectorAll() - -```ts -querySelectorAll: (selector: string) => Element[]; -``` - -Select all the elements matching the given CSS selector in the page. - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `selector` | `string` | CSS Selector string. | - -#### Returns - -`Element`[] - -#### Defined in - -@lynx-js/react/runtime/lib/lynx-api.d.ts:330 - -*** - ### registerDataProcessors() ```ts @@ -190,7 +142,7 @@ function App() { #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:384 +@lynx-js/react/runtime/lib/lynx-api.d.ts:454 *** @@ -215,4 +167,4 @@ An alias of `lynx.getJSModule("GlobalEventEmitter").trigger(eventName, params)` #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:275 +@lynx-js/react/runtime/lib/lynx-api.d.ts:345 diff --git a/docs/en/api/react/Interface.Root.mdx b/docs/en/api/react/Interface.Root.mdx index ea392955e..d08a26b40 100644 --- a/docs/en/api/react/Interface.Root.mdx +++ b/docs/en/api/react/Interface.Root.mdx @@ -40,7 +40,7 @@ use [lynx.registerDataProcessors](/api/react/Interface.Lynx.mdx#registerdataproc #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:59 +@lynx-js/react/runtime/lib/lynx-api.d.ts:60 *** @@ -102,4 +102,4 @@ if (__MAIN_THREAD__) { #### Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:53 +@lynx-js/react/runtime/lib/lynx-api.d.ts:54 diff --git a/docs/en/api/react/Variable.root.mdx b/docs/en/api/react/Variable.root.mdx index 985abcdea..a1e2bf15b 100644 --- a/docs/en/api/react/Variable.root.mdx +++ b/docs/en/api/react/Variable.root.mdx @@ -26,4 +26,4 @@ import { root } from "@lynx-js/react" ## Defined in -@lynx-js/react/runtime/lib/lynx-api.d.ts:70 +@lynx-js/react/runtime/lib/lynx-api.d.ts:71 diff --git a/docs/en/api/react/Variable.useErrorBoundary.mdx b/docs/en/api/react/Variable.useErrorBoundary.mdx new file mode 100644 index 000000000..e87fcad31 --- /dev/null +++ b/docs/en/api/react/Variable.useErrorBoundary.mdx @@ -0,0 +1,17 @@ +{/* +* This file is generated by @lynx-js/tool-typedoc. +* Do not edit this file directly. +* @generated +*/} + +{/* Import all components as Lynx to allow dynamic lookup in TSDoc writings. */} +import * as Lynx from '@lynx'; + + +[@lynx-js/react](/api/react/index.mdx) / useErrorBoundary + +# Variable: useErrorBoundary + +```ts +useErrorBoundary: any; +``` diff --git a/docs/en/api/react/_meta.json b/docs/en/api/react/_meta.json index c86f1850d..d9b04c7fb 100644 --- a/docs/en/api/react/_meta.json +++ b/docs/en/api/react/_meta.json @@ -12,10 +12,12 @@ "Function.cloneElement", "Function.createContext", "Function.createElement", + "Function.createPortal", "Function.createRef", - "Function.createRoot", "Function.forwardRef", "Function.Fragment", + "Function.GlobalPropsConsumer", + "Function.GlobalPropsProvider", "Function.InitDataConsumer", "Function.InitDataProvider", "Function.isValidElement", @@ -28,6 +30,8 @@ "Function.useContext", "Function.useDebugValue", "Function.useEffect", + "Function.useGlobalProps", + "Function.useGlobalPropsChanged", "Function.useImperativeHandle", "Function.useInitData", "Function.useInitDataChanged", @@ -42,9 +46,11 @@ "Function.withInitDataInState", "Interface.DataProcessorDefinition", "Interface.DataProcessors", + "Interface.GlobalProps", "Interface.InitData", "Interface.InitDataRaw", "Interface.Lynx", "Interface.Root", - "Variable.root" + "Variable.root", + "Variable.useErrorBoundary" ] diff --git a/docs/en/api/react/index.mdx b/docs/en/api/react/index.mdx index 82c01b372..1472d59da 100644 --- a/docs/en/api/react/index.mdx +++ b/docs/en/api/react/index.mdx @@ -45,6 +45,7 @@ At the same time, we will continue to pay attention to subsequent React advancem | ------ | ------ | | [DataProcessorDefinition](/api/react/Interface.DataProcessorDefinition.mdx) | Definition of DataProcessor(s) | | [DataProcessors](/api/react/Interface.DataProcessors.mdx) | The data processors that registered with [Lynx.registerDataProcessors](/api/react/Interface.Lynx.mdx#registerdataprocessors). | +| [GlobalProps](/api/react/Interface.GlobalProps.mdx) | The interface you can extends so that the `useGlobalProps` returning value can be customized | | [InitData](/api/react/Interface.InitData.mdx) | The interface you can extends so that the `defaultDataProcessor` returning value can be customized | | [InitDataRaw](/api/react/Interface.InitDataRaw.mdx) | The interface you can extends so that the `defaultDataProcessor` parameter can be customized | | [Lynx](/api/react/Interface.Lynx.mdx) | APIs under `lynx` global variable that added by ReactLynx. | @@ -55,6 +56,7 @@ At the same time, we will continue to pay attention to subsequent React advancem | Variable | Description | | ------ | ------ | | [root](/api/react/Variable.root.mdx) | The default and only root of ReactLynx for you to render JSX | +| [useErrorBoundary](/api/react/Variable.useErrorBoundary.mdx) | - | ## Functions @@ -63,6 +65,7 @@ At the same time, we will continue to pay attention to subsequent React advancem | [cloneElement](/api/react/Function.cloneElement.mdx) | - | | [createContext](/api/react/Function.createContext.mdx) | Lets you create a Context that components can provide or read. | | [createElement](/api/react/Function.createElement.mdx) | - | +| [createPortal](/api/react/Function.createPortal.mdx) | Create a `Portal` to continue rendering the vnode tree at a different DOM node. | | [createRef](/api/react/Function.createRef.mdx) | - | | [forwardRef](/api/react/Function.forwardRef.mdx) | Lets your component expose a DOM node to a parent component using a ref. | | [Fragment](/api/react/Function.Fragment.mdx) | Lets you group elements without a wrapper node. | @@ -76,11 +79,13 @@ At the same time, we will continue to pay attention to subsequent React advancem | [useContext](/api/react/Function.useContext.mdx) | Accepts a context object (the value returned from `React.createContext`) and returns the current context value, as given by the nearest context provider for the given context. | | [useDebugValue](/api/react/Function.useDebugValue.mdx) | `useDebugValue` can be used to display a label for custom hooks in React DevTools. | | [useEffect](/api/react/Function.useEffect.mdx) | Accepts a function that contains imperative, possibly effectful code. The effects run after main thread dom update without blocking it. | +| [useGlobalProps](/api/react/Function.useGlobalProps.mdx) | A React Hooks for you to get `lynx.__globalProps`. If `lynx.__globalProps` is changed, a re-render will be triggered automatically. | +| [useGlobalPropsChanged](/api/react/Function.useGlobalPropsChanged.mdx) | A React Hooks for you to get notified when `__globalProps` changed. | | [useImperativeHandle](/api/react/Function.useImperativeHandle.mdx) | `useImperativeHandle` customizes the instance value that is exposed to parent components when using `ref`. As always, imperative code using refs should be avoided in most cases. | | [useInitData](/api/react/Function.useInitData.mdx) | A React Hooks for you to get `initData`. If `initData` is changed, a re-render will be triggered automatically. | | [useInitDataChanged](/api/react/Function.useInitDataChanged.mdx) | A React Hooks for you to get notified when `initData` changed. | | [useLayoutEffect](/api/react/Function.useLayoutEffect.mdx) | `useLayoutEffect` is now an alias of `useEffect`. Use `useEffect` instead. | -| [useLynxGlobalEventListener](/api/react/Function.useLynxGlobalEventListener.mdx) | `useLynxGlobalEventListener` help you `addListener` as early as possible. | +| [useLynxGlobalEventListener](/api/react/Function.useLynxGlobalEventListener.mdx) | `useLynxGlobalEventListener` helps you `addListener` as early as possible. | | [useMainThreadRef](/api/react/Function.useMainThreadRef.mdx) | Create A `MainThreadRef`. | | [useMemo](/api/react/Function.useMemo.mdx) | `useMemo` will only recompute the memoized value when one of the `deps` has changed. | | [useReducer](/api/react/Function.useReducer.mdx) | An alternative to `useState`. | @@ -93,5 +98,7 @@ At the same time, we will continue to pay attention to subsequent React advancem | Function | Description | | ------ | ------ | +| [GlobalPropsConsumer](/api/react/Function.GlobalPropsConsumer.mdx) | The [Consumer](https://react.dev/reference/react/createContext#consumer) Component that provide `lynx.__globalProps`. This should be used with [GlobalPropsProvider](/api/react/Function.GlobalPropsProvider.mdx) | +| [GlobalPropsProvider](/api/react/Function.GlobalPropsProvider.mdx) | The [Provider](https://react.dev/reference/react/createContext#provider) Component that provide `lynx.__globalProps`, you must wrap your JSX inside it | | [InitDataConsumer](/api/react/Function.InitDataConsumer.mdx) | The [Consumer](https://react.dev/reference/react/createContext#consumer) Component that provide `initData`. This should be used with [InitDataProvider](/api/react/Function.InitDataProvider.mdx) | | [InitDataProvider](/api/react/Function.InitDataProvider.mdx) | The [Provider](https://react.dev/reference/react/createContext#provider) Component that provide `initData`, you must wrap your JSX inside it | diff --git a/docs/en/api/reactlynx-testing-library/Class.LynxTestingEnv.mdx b/docs/en/api/reactlynx-testing-library/Class.LynxTestingEnv.mdx index 6f2176782..0f17cd7b7 100644 --- a/docs/en/api/reactlynx-testing-library/Class.LynxTestingEnv.mdx +++ b/docs/en/api/reactlynx-testing-library/Class.LynxTestingEnv.mdx @@ -12,20 +12,21 @@ import * as Lynx from '@lynx'; # Class: LynxTestingEnv -A pure-JavaScript implementation of the [Lynx Spec](/guide/spec.html), +A pure-JavaScript implementation of the [Lynx Spec](/guide/spec.html), notably the [Element PAPI](/api/engine/element-api) and [Dual-threaded Model](/guide/spec#dual-threaded-model) for use with Node.js. ## Example -```ts -import { LynxTestingEnv } from '@lynx-js/testing-environment'; +```ts +import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); -lynxTestingEnv.switchToMainThread(); -// use the main thread Element PAPI -const page = __CreatePage('0', 0); -const view = __CreateView(0); +lynxTestingEnv.switchToMainThread(); +// use the main thread Element PAPI +const page = __CreatePage('0', 0); +const view = __CreateView(0); __AppendElement(page, view); ``` @@ -35,16 +36,22 @@ __AppendElement(page, view); ### new LynxTestingEnv() ```ts -new LynxTestingEnv(): LynxTestingEnv +new LynxTestingEnv(env?: LynxEnv): LynxTestingEnv ``` +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `env`? | `LynxEnv` | + #### Returns [`LynxTestingEnv`](/api/reactlynx-testing-library/Class.LynxTestingEnv.mdx) #### Defined in -index.d.ts:892 +index.d.ts:971 ## Properties @@ -58,31 +65,32 @@ The global object for the background thread. #### Example -```ts -import { LynxTestingEnv } from '@lynx-js/testing-environment'; +```ts +import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); -lynxTestingEnv.switchToBackgroundThread(); -// use the background thread global object -globalThis.lynxCoreInject.tt.OnLifecycleEvent(...args); +lynxTestingEnv.switchToBackgroundThread(); +// use the background thread global object +globalThis.lynxCoreInject.tt.OnLifecycleEvent(...args); ``` #### Defined in -index.d.ts:872 +index.d.ts:950 *** -### jsdom +### env ```ts -jsdom: JSDOM; +env: LynxEnv; ``` #### Defined in -index.d.ts:891 +index.d.ts:970 *** @@ -96,21 +104,22 @@ The global object for the main thread. #### Example -```ts -import { LynxTestingEnv } from '@lynx-js/testing-environment'; +```ts +import { LynxTestingEnv } from '@lynx-js/testing-environment'; +import { JSDOM } from 'jsdom'; -const lynxTestingEnv = new LynxTestingEnv(); +const lynxTestingEnv = new LynxTestingEnv({ window: new JSDOM().window }); -lynxTestingEnv.switchToMainThread(); -// use the main thread global object -const page = globalThis.__CreatePage('0', 0); -const view = globalThis.__CreateView(0); -globalThis.__AppendElement(page, view); +lynxTestingEnv.switchToMainThread(); +// use the main thread global object +const page = globalThis.__CreatePage('0', 0); +const view = globalThis.__CreateView(0); +globalThis.__AppendElement(page, view); ``` #### Defined in -index.d.ts:890 +index.d.ts:969 ## Methods @@ -126,7 +135,7 @@ clearGlobal(): void #### Defined in -index.d.ts:896 +index.d.ts:975 *** @@ -142,7 +151,7 @@ injectGlobals(): void #### Defined in -index.d.ts:893 +index.d.ts:972 *** @@ -158,7 +167,7 @@ reset(): void #### Defined in -index.d.ts:897 +index.d.ts:976 *** @@ -174,7 +183,7 @@ switchToBackgroundThread(): void #### Defined in -index.d.ts:894 +index.d.ts:973 *** @@ -190,4 +199,4 @@ switchToMainThread(): void #### Defined in -index.d.ts:895 +index.d.ts:974 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByAltText.mdx index 294ff91af..1dd5b67ae 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByAltText.mdx @@ -34,4 +34,4 @@ function findAllByAltText(...args: [HTMLElement, Matcher, MatcherOptions, wai ## Defined in -index.d.ts:454 +index.d.ts:492 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByDisplayValue.mdx index e4748082e..a393a7f5d 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByDisplayValue.mdx @@ -34,4 +34,4 @@ function findAllByDisplayValue(...args: [HTMLElement, Matcher, MatcherOptions ## Defined in -index.d.ts:465 +index.d.ts:503 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByLabelText.mdx index aca921037..c3c40a058 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByLabelText.mdx @@ -34,4 +34,4 @@ function findAllByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherOp ## Defined in -index.d.ts:469 +index.d.ts:507 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByPlaceholderText.mdx index 754d5be87..63ef935b6 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByPlaceholderText.mdx @@ -34,4 +34,4 @@ function findAllByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOpti ## Defined in -index.d.ts:473 +index.d.ts:511 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByRole.mdx index da9a366d9..81b2d7134 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByRole.mdx @@ -34,4 +34,4 @@ function findAllByRole(...args: [HTMLElement, any, ByRoleOptions, waitForOpti ## Defined in -index.d.ts:484 +index.d.ts:522 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByTestId.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByTestId.mdx index fd8f8f24d..0568a7429 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByTestId.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByTestId.mdx @@ -34,4 +34,4 @@ function findAllByTestId(...args: [HTMLElement, Matcher, MatcherOptions, wait ## Defined in -index.d.ts:488 +index.d.ts:526 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByText.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByText.mdx index f8d04d90e..8c2ca67a3 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByText.mdx @@ -34,4 +34,4 @@ function findAllByText(...args: [HTMLElement, Matcher, SelectorMatcherOptions ## Defined in -index.d.ts:499 +index.d.ts:537 diff --git a/docs/en/api/reactlynx-testing-library/Function.findAllByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.findAllByTitle.mdx index 8b7e22041..1a989397d 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findAllByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findAllByTitle.mdx @@ -34,4 +34,4 @@ function findAllByTitle(...args: [HTMLElement, Matcher, MatcherOptions, waitF ## Defined in -index.d.ts:503 +index.d.ts:541 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.findByAltText.mdx index c0266822c..ffdf2614f 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByAltText.mdx @@ -34,4 +34,4 @@ function findByAltText(...args: [HTMLElement, Matcher, MatcherOptions, waitFo ## Defined in -index.d.ts:512 +index.d.ts:550 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.findByDisplayValue.mdx index db3cf99df..fc2f38034 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByDisplayValue.mdx @@ -34,4 +34,4 @@ function findByDisplayValue(...args: [HTMLElement, Matcher, MatcherOptions, w ## Defined in -index.d.ts:523 +index.d.ts:561 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.findByLabelText.mdx index da21e4af9..dada7091c 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByLabelText.mdx @@ -34,4 +34,4 @@ function findByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherOptio ## Defined in -index.d.ts:527 +index.d.ts:565 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.findByPlaceholderText.mdx index 7917ec0b3..6e398bedf 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByPlaceholderText.mdx @@ -34,4 +34,4 @@ function findByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOptions ## Defined in -index.d.ts:531 +index.d.ts:569 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.findByRole.mdx index 4d1c7a285..75df87646 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByRole.mdx @@ -34,4 +34,4 @@ function findByRole(...args: [HTMLElement, any, ByRoleOptions, waitForOptions ## Defined in -index.d.ts:542 +index.d.ts:580 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByTestId.mdx b/docs/en/api/reactlynx-testing-library/Function.findByTestId.mdx index 79af76e7c..61814c04c 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByTestId.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByTestId.mdx @@ -34,4 +34,4 @@ function findByTestId(...args: [HTMLElement, Matcher, MatcherOptions, waitFor ## Defined in -index.d.ts:546 +index.d.ts:584 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByText.mdx b/docs/en/api/reactlynx-testing-library/Function.findByText.mdx index 374f354f6..eabf23c9a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByText.mdx @@ -34,4 +34,4 @@ function findByText(...args: [HTMLElement, Matcher, SelectorMatcherOptions, w ## Defined in -index.d.ts:557 +index.d.ts:595 diff --git a/docs/en/api/reactlynx-testing-library/Function.findByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.findByTitle.mdx index 779721549..0c994a365 100644 --- a/docs/en/api/reactlynx-testing-library/Function.findByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.findByTitle.mdx @@ -34,4 +34,4 @@ function findByTitle(...args: [HTMLElement, Matcher, MatcherOptions, waitForO ## Defined in -index.d.ts:561 +index.d.ts:599 diff --git a/docs/en/api/reactlynx-testing-library/Function.fireEvent.mdx b/docs/en/api/reactlynx-testing-library/Function.fireEvent.mdx index 5b7ddc8ba..13d3f2446 100644 --- a/docs/en/api/reactlynx-testing-library/Function.fireEvent.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.fireEvent.mdx @@ -29,4 +29,4 @@ function fireEvent(element: any, event: Event): boolean ## Defined in -index.d.ts:565 +index.d.ts:603 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByAltText.mdx index 97285175f..35409a34a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByAltText.mdx @@ -34,4 +34,4 @@ function getAllByAltText(...args: [HTMLElement, Matcher, MatcherOptions]): Re ## Defined in -index.d.ts:584 +index.d.ts:626 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByDisplayValue.mdx index 73b9f7c67..d6b56628f 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByDisplayValue.mdx @@ -34,4 +34,4 @@ function getAllByDisplayValue(...args: [HTMLElement, Matcher, MatcherOptions] ## Defined in -index.d.ts:588 +index.d.ts:630 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByLabelText.mdx index 09ca976b0..dc3ff540c 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByLabelText.mdx @@ -34,4 +34,4 @@ function getAllByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherOpt ## Defined in -index.d.ts:592 +index.d.ts:634 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByPlaceholderText.mdx index c379d1c6a..9918e3ccd 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByPlaceholderText.mdx @@ -34,4 +34,4 @@ function getAllByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOptio ## Defined in -index.d.ts:596 +index.d.ts:638 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByRole.mdx index 080d9096d..05d07a5fc 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByRole.mdx @@ -34,4 +34,4 @@ function getAllByRole(...args: [HTMLElement, any, ByRoleOptions]): ReturnType ## Defined in -index.d.ts:600 +index.d.ts:642 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByTestId.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByTestId.mdx index faf483bb3..c6484e59b 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByTestId.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByTestId.mdx @@ -34,4 +34,4 @@ function getAllByTestId(...args: [HTMLElement, Matcher, MatcherOptions]): Ret ## Defined in -index.d.ts:604 +index.d.ts:646 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByText.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByText.mdx index a3631344b..81fe82b45 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByText.mdx @@ -34,4 +34,4 @@ function getAllByText(...args: [HTMLElement, Matcher, SelectorMatcherOptions] ## Defined in -index.d.ts:608 +index.d.ts:650 diff --git a/docs/en/api/reactlynx-testing-library/Function.getAllByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.getAllByTitle.mdx index 632ac8b69..9d1eb16a8 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getAllByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getAllByTitle.mdx @@ -34,4 +34,4 @@ function getAllByTitle(...args: [HTMLElement, Matcher, MatcherOptions]): Retu ## Defined in -index.d.ts:612 +index.d.ts:654 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.getByAltText.mdx index 339f27dc9..9e02a3108 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByAltText.mdx @@ -34,4 +34,4 @@ function getByAltText(...args: [HTMLElement, Matcher, MatcherOptions]): Retur ## Defined in -index.d.ts:618 +index.d.ts:660 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.getByDisplayValue.mdx index 003a2dac7..1907a2f8a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByDisplayValue.mdx @@ -34,4 +34,4 @@ function getByDisplayValue(...args: [HTMLElement, Matcher, MatcherOptions]): ## Defined in -index.d.ts:628 +index.d.ts:670 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.getByLabelText.mdx index d1ab99fcf..0cf7a077b 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByLabelText.mdx @@ -34,4 +34,4 @@ function getByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherOption ## Defined in -index.d.ts:632 +index.d.ts:674 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.getByPlaceholderText.mdx index 686ebfafd..1fd3fad67 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByPlaceholderText.mdx @@ -34,4 +34,4 @@ function getByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOptions] ## Defined in -index.d.ts:636 +index.d.ts:678 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.getByRole.mdx index 3f1a14031..987bb3f4c 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByRole.mdx @@ -34,4 +34,4 @@ function getByRole(...args: [HTMLElement, any, ByRoleOptions]): ReturnType(...args: [HTMLElement, Matcher, MatcherOptions]): Return ## Defined in -index.d.ts:650 +index.d.ts:692 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByText.mdx b/docs/en/api/reactlynx-testing-library/Function.getByText.mdx index c9add838f..00b1593ad 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByText.mdx @@ -34,4 +34,4 @@ function getByText(...args: [HTMLElement, Matcher, SelectorMatcherOptions]): ## Defined in -index.d.ts:660 +index.d.ts:702 diff --git a/docs/en/api/reactlynx-testing-library/Function.getByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.getByTitle.mdx index df0c0b8c1..48d3dafd4 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getByTitle.mdx @@ -34,4 +34,4 @@ function getByTitle(...args: [HTMLElement, Matcher, MatcherOptions]): ReturnT ## Defined in -index.d.ts:664 +index.d.ts:706 diff --git a/docs/en/api/reactlynx-testing-library/Function.getConfig.mdx b/docs/en/api/reactlynx-testing-library/Function.getConfig.mdx index 4e68ac313..0ea0337b8 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getConfig.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getConfig.mdx @@ -22,4 +22,4 @@ function getConfig(): Config ## Defined in -index.d.ts:668 +index.d.ts:710 diff --git a/docs/en/api/reactlynx-testing-library/Function.getDefaultNormalizer.mdx b/docs/en/api/reactlynx-testing-library/Function.getDefaultNormalizer.mdx index 07c8f2a85..d4ee26f65 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getDefaultNormalizer.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getDefaultNormalizer.mdx @@ -28,4 +28,4 @@ function getDefaultNormalizer(options?: DefaultNormalizerOptions): NormalizerFn ## Defined in -index.d.ts:670 +index.d.ts:712 diff --git a/docs/en/api/reactlynx-testing-library/Function.getElementError.mdx b/docs/en/api/reactlynx-testing-library/Function.getElementError.mdx index 4203b24d9..8a0ff1be3 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getElementError.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getElementError.mdx @@ -29,4 +29,4 @@ function getElementError(message: null | string, container: HTMLElement): Error ## Defined in -index.d.ts:674 +index.d.ts:716 diff --git a/docs/en/api/reactlynx-testing-library/Function.getNodeText.mdx b/docs/en/api/reactlynx-testing-library/Function.getNodeText.mdx index 61f3b4622..78a605cb2 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getNodeText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getNodeText.mdx @@ -28,4 +28,4 @@ function getNodeText(node: HTMLElement): string ## Defined in -index.d.ts:684 +index.d.ts:726 diff --git a/docs/en/api/reactlynx-testing-library/Function.getQueriesForElement.mdx b/docs/en/api/reactlynx-testing-library/Function.getQueriesForElement.mdx index 78dfccf0d..f9dc82724 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getQueriesForElement.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getQueriesForElement.mdx @@ -36,4 +36,4 @@ function getQueriesForElement(element: HTMLElement, queriesToB ## Defined in -index.d.ts:686 +index.d.ts:728 diff --git a/docs/en/api/reactlynx-testing-library/Function.getRoles.mdx b/docs/en/api/reactlynx-testing-library/Function.getRoles.mdx index 163ebfaed..8efe67ed0 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getRoles.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getRoles.mdx @@ -28,4 +28,4 @@ function getRoles(container: HTMLElement): object ## Defined in -index.d.ts:692 +index.d.ts:734 diff --git a/docs/en/api/reactlynx-testing-library/Function.getSuggestedQuery.mdx b/docs/en/api/reactlynx-testing-library/Function.getSuggestedQuery.mdx index 428d000af..a78002467 100644 --- a/docs/en/api/reactlynx-testing-library/Function.getSuggestedQuery.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.getSuggestedQuery.mdx @@ -33,4 +33,4 @@ function getSuggestedQuery( ## Defined in -index.d.ts:696 +index.d.ts:738 diff --git a/docs/en/api/reactlynx-testing-library/Function.isInaccessible.mdx b/docs/en/api/reactlynx-testing-library/Function.isInaccessible.mdx index 4140e8fc1..fe24e7003 100644 --- a/docs/en/api/reactlynx-testing-library/Function.isInaccessible.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.isInaccessible.mdx @@ -30,4 +30,4 @@ https://testing-library.com/docs/dom-testing-library/api-helpers#isinaccessible ## Defined in -index.d.ts:773 +index.d.ts:827 diff --git a/docs/en/api/reactlynx-testing-library/Function.logDOM.mdx b/docs/en/api/reactlynx-testing-library/Function.logDOM.mdx index 2938c900c..1e4f65829 100644 --- a/docs/en/api/reactlynx-testing-library/Function.logDOM.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.logDOM.mdx @@ -33,4 +33,4 @@ function logDOM( ## Defined in -index.d.ts:775 +index.d.ts:829 diff --git a/docs/en/api/reactlynx-testing-library/Function.logRoles.mdx b/docs/en/api/reactlynx-testing-library/Function.logRoles.mdx index 388f312bd..6881ffde4 100644 --- a/docs/en/api/reactlynx-testing-library/Function.logRoles.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.logRoles.mdx @@ -29,4 +29,4 @@ function logRoles(container: HTMLElement, options?: LogRolesOptions): string ## Defined in -index.d.ts:781 +index.d.ts:835 diff --git a/docs/en/api/reactlynx-testing-library/Function.prettyDOM.mdx b/docs/en/api/reactlynx-testing-library/Function.prettyDOM.mdx index 50926c1dc..ddba1cb5c 100644 --- a/docs/en/api/reactlynx-testing-library/Function.prettyDOM.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.prettyDOM.mdx @@ -33,4 +33,4 @@ function prettyDOM( ## Defined in -index.d.ts:967 +index.d.ts:1033 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByAltText.mdx index 1745bbaf6..3643ec6d5 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByAltText.mdx @@ -34,4 +34,4 @@ function queryAllByAltText(...args: [HTMLElement, Matcher, MatcherOptions]): ## Defined in -index.d.ts:1068 +index.d.ts:1134 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByAttribute.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByAttribute.mdx index c640c5ef8..b4c46023e 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByAttribute.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByAttribute.mdx @@ -35,4 +35,4 @@ function queryAllByAttribute( ## Defined in -index.d.ts:1072 +index.d.ts:1138 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByDisplayValue.mdx index 02d4bf29a..132df810a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByDisplayValue.mdx @@ -34,4 +34,4 @@ function queryAllByDisplayValue(...args: [HTMLElement, Matcher, MatcherOption ## Defined in -index.d.ts:1074 +index.d.ts:1140 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByLabelText.mdx index c5ac14b67..df177a005 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByLabelText.mdx @@ -34,4 +34,4 @@ function queryAllByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherO ## Defined in -index.d.ts:1078 +index.d.ts:1144 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByPlaceholderText.mdx index 7f473f5a6..6e52a59a5 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByPlaceholderText.mdx @@ -34,4 +34,4 @@ function queryAllByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOpt ## Defined in -index.d.ts:1082 +index.d.ts:1148 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByRole.mdx index d9de83c93..149be0638 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByRole.mdx @@ -34,4 +34,4 @@ function queryAllByRole(...args: [HTMLElement, any, ByRoleOptions]): ReturnTy ## Defined in -index.d.ts:1086 +index.d.ts:1152 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByTestId.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByTestId.mdx index 00d205df6..4681dcb38 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByTestId.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByTestId.mdx @@ -34,4 +34,4 @@ function queryAllByTestId(...args: [HTMLElement, Matcher, MatcherOptions]): R ## Defined in -index.d.ts:1090 +index.d.ts:1156 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByText.mdx index 89ee67b3b..1ce64c1bf 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByText.mdx @@ -34,4 +34,4 @@ function queryAllByText(...args: [HTMLElement, Matcher, SelectorMatcherOption ## Defined in -index.d.ts:1094 +index.d.ts:1160 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryAllByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.queryAllByTitle.mdx index b410a73fd..5b0a39e61 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryAllByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryAllByTitle.mdx @@ -34,4 +34,4 @@ function queryAllByTitle(...args: [HTMLElement, Matcher, MatcherOptions]): Re ## Defined in -index.d.ts:1098 +index.d.ts:1164 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByAltText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByAltText.mdx index 3bb7bd9db..a9b807d35 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByAltText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByAltText.mdx @@ -34,4 +34,4 @@ function queryByAltText(...args: [HTMLElement, Matcher, MatcherOptions]): Ret ## Defined in -index.d.ts:1109 +index.d.ts:1175 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByAttribute.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByAttribute.mdx index d5622ebcb..cc81d352e 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByAttribute.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByAttribute.mdx @@ -17,7 +17,7 @@ function queryByAttribute( attribute: string, container: HTMLElement, id: Matcher, - options?: MatcherOptions): any + options?: MatcherOptions): null | HTMLElement ``` ## Parameters @@ -31,8 +31,8 @@ function queryByAttribute( ## Returns -`any` +`null` \| `HTMLElement` ## Defined in -index.d.ts:1120 +index.d.ts:1186 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByDisplayValue.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByDisplayValue.mdx index 7a00aa2c4..d8ce7d9bc 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByDisplayValue.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByDisplayValue.mdx @@ -34,4 +34,4 @@ function queryByDisplayValue(...args: [HTMLElement, Matcher, MatcherOptions]) ## Defined in -index.d.ts:1128 +index.d.ts:1194 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByLabelText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByLabelText.mdx index cef7cb58d..4700b181a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByLabelText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByLabelText.mdx @@ -34,4 +34,4 @@ function queryByLabelText(...args: [HTMLElement, Matcher, SelectorMatcherOpti ## Defined in -index.d.ts:1132 +index.d.ts:1198 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByPlaceholderText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByPlaceholderText.mdx index 8c4376a6a..dc81c2818 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByPlaceholderText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByPlaceholderText.mdx @@ -34,4 +34,4 @@ function queryByPlaceholderText(...args: [HTMLElement, Matcher, MatcherOption ## Defined in -index.d.ts:1136 +index.d.ts:1202 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByRole.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByRole.mdx index 43ba4752f..cc83549f1 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByRole.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByRole.mdx @@ -34,4 +34,4 @@ function queryByRole(...args: [HTMLElement, any, ByRoleOptions]): ReturnType< ## Defined in -index.d.ts:1146 +index.d.ts:1212 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByTestId.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByTestId.mdx index 12afe463b..7308c4331 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByTestId.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByTestId.mdx @@ -34,4 +34,4 @@ function queryByTestId(...args: [HTMLElement, Matcher, MatcherOptions]): Retu ## Defined in -index.d.ts:1150 +index.d.ts:1216 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByText.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByText.mdx index c5f786147..142712277 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByText.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByText.mdx @@ -34,4 +34,4 @@ function queryByText(...args: [HTMLElement, Matcher, SelectorMatcherOptions]) ## Defined in -index.d.ts:1160 +index.d.ts:1226 diff --git a/docs/en/api/reactlynx-testing-library/Function.queryByTitle.mdx b/docs/en/api/reactlynx-testing-library/Function.queryByTitle.mdx index c3628d316..d9db16c0a 100644 --- a/docs/en/api/reactlynx-testing-library/Function.queryByTitle.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.queryByTitle.mdx @@ -34,4 +34,4 @@ function queryByTitle(...args: [HTMLElement, Matcher, MatcherOptions]): Retur ## Defined in -index.d.ts:1164 +index.d.ts:1230 diff --git a/docs/en/api/reactlynx-testing-library/Function.render.mdx b/docs/en/api/reactlynx-testing-library/Function.render.mdx index e13911b21..1631bf2d1 100644 --- a/docs/en/api/reactlynx-testing-library/Function.render.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.render.mdx @@ -13,7 +13,7 @@ import * as Lynx from '@lynx'; # Function: render() ```ts -function render(ui: ComponentChild, options?: RenderOptions): RenderResult +function render(ui: ReactNode, options?: RenderOptions): RenderResult ``` Render into the page. It should be used with cleanup. @@ -28,7 +28,7 @@ Render into the page. It should be used with cleanup. | Parameter | Type | | ------ | ------ | -| `ui` | `ComponentChild` | +| `ui` | `ReactNode` | | `options`? | [`RenderOptions`](/api/reactlynx-testing-library/Interface.RenderOptions.mdx)\<`Q`\> | ## Returns @@ -64,4 +64,4 @@ expect(container.firstChild).toMatchInlineSnapshot(` ## Defined in -index.d.ts:1234 +index.d.ts:1300 diff --git a/docs/en/api/reactlynx-testing-library/Function.renderHook.mdx b/docs/en/api/reactlynx-testing-library/Function.renderHook.mdx index 21ff3c0fe..18d411957 100644 --- a/docs/en/api/reactlynx-testing-library/Function.renderHook.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.renderHook.mdx @@ -60,4 +60,4 @@ expect(result.current).toEqual('provided'); ## Defined in -index.d.ts:1266 +index.d.ts:1332 diff --git a/docs/en/api/reactlynx-testing-library/Function.waitFor.mdx b/docs/en/api/reactlynx-testing-library/Function.waitFor.mdx index a0d241c5f..abb2268a6 100644 --- a/docs/en/api/reactlynx-testing-library/Function.waitFor.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.waitFor.mdx @@ -35,4 +35,4 @@ function waitFor(callback: () => T | Promise, options?: waitForOptions): P ## Defined in -index.d.ts:1473 +index.d.ts:1540 diff --git a/docs/en/api/reactlynx-testing-library/Function.waitForElementToBeRemoved.mdx b/docs/en/api/reactlynx-testing-library/Function.waitForElementToBeRemoved.mdx index 67a31b699..b9ecea151 100644 --- a/docs/en/api/reactlynx-testing-library/Function.waitForElementToBeRemoved.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.waitForElementToBeRemoved.mdx @@ -35,4 +35,4 @@ function waitForElementToBeRemoved(callback: T | () => T, options?: waitForOp ## Defined in -index.d.ts:1478 +index.d.ts:1545 diff --git a/docs/en/api/reactlynx-testing-library/Function.waitSchedule.mdx b/docs/en/api/reactlynx-testing-library/Function.waitSchedule.mdx index 91ea34a38..c262746eb 100644 --- a/docs/en/api/reactlynx-testing-library/Function.waitSchedule.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.waitSchedule.mdx @@ -10,7 +10,7 @@ import * as Lynx from '@lynx'; [reactlynx-testing-library](/api/reactlynx-testing-library/index.mdx) / waitSchedule -# Function: waitSchedule() +# Function: ~~waitSchedule()~~ ```ts function waitSchedule(): Promise @@ -24,6 +24,10 @@ It will be useful when you want to wait for the next event loop to finish. `Promise`\<`void`\> +## Deprecated + +Please use `act` instead + ## Defined in -index.d.ts:1498 +index.d.ts:1565 diff --git a/docs/en/api/reactlynx-testing-library/Function.within.mdx b/docs/en/api/reactlynx-testing-library/Function.within.mdx index 777cc4b57..bb34a6f5e 100644 --- a/docs/en/api/reactlynx-testing-library/Function.within.mdx +++ b/docs/en/api/reactlynx-testing-library/Function.within.mdx @@ -36,4 +36,4 @@ function within(element: HTMLElement, queriesToBind?: T): Boun ## Defined in -index.d.ts:1500 +index.d.ts:1567 diff --git a/docs/en/api/reactlynx-testing-library/Interface.ByRoleOptions.mdx b/docs/en/api/reactlynx-testing-library/Interface.ByRoleOptions.mdx index 97a991b1b..2f05d4453 100644 --- a/docs/en/api/reactlynx-testing-library/Interface.ByRoleOptions.mdx +++ b/docs/en/api/reactlynx-testing-library/Interface.ByRoleOptions.mdx @@ -20,7 +20,7 @@ import * as Lynx from '@lynx'; optional busy: boolean; ``` -If true only includes elements in the query set that are marked as +If true only includes elements in the query set that are marked as busy in the accessibility tree, i.e., `aria-busy="true"` #### Defined in @@ -35,7 +35,7 @@ index.d.ts:227 optional checked: boolean; ``` -If true only includes elements in the query set that are marked as +If true only includes elements in the query set that are marked as checked in the accessibility tree, i.e., `aria-checked="true"` #### Defined in @@ -78,7 +78,7 @@ index.d.ts:274 optional expanded: boolean; ``` -If true only includes elements in the query set that are marked as +If true only includes elements in the query set that are marked as expanded in the accessibility tree, i.e., `aria-expanded="true"` #### Defined in @@ -93,8 +93,8 @@ index.d.ts:246 optional hidden: boolean; ``` -If true includes elements in the query set that are usually excluded from -the accessibility tree. `role="none"` or `role="presentation"` are included +If true includes elements in the query set that are usually excluded from +the accessibility tree. `role="none"` or `role="presentation"` are included in either case. #### Defined in @@ -109,8 +109,8 @@ index.d.ts:217 optional level: number; ``` -Includes elements with the `"heading"` role matching the indicated level, -either by the semantic HTML heading elements `

-
` or matching +Includes elements with the `"heading"` role matching the indicated level, +either by the semantic HTML heading elements `

-

` or matching the `aria-level` attribute. #### Defined in @@ -139,7 +139,7 @@ index.d.ts:267 optional pressed: boolean; ``` -If true only includes elements in the query set that are marked as +If true only includes elements in the query set that are marked as pressed in the accessibility tree, i.e., `aria-pressed="true"` #### Defined in @@ -154,8 +154,8 @@ index.d.ts:237 optional queryFallbacks: boolean; ``` -Includes every role used in the `role` attribute -For example *ByRole('progressbar', \{queryFallbacks: true\})` will find
`. +Includes every role used in the `role` attribute +For example *ByRole('progressbar', {queryFallbacks: true})` will find
`. #### Defined in @@ -169,7 +169,7 @@ index.d.ts:263 optional selected: boolean; ``` -If true only includes elements in the query set that are marked as +If true only includes elements in the query set that are marked as selected in the accessibility tree, i.e., `aria-selected="true"` #### Defined in diff --git a/docs/en/api/reactlynx-testing-library/Interface.LogRolesOptions.mdx b/docs/en/api/reactlynx-testing-library/Interface.LogRolesOptions.mdx index 95ef4a801..5e7d38fa7 100644 --- a/docs/en/api/reactlynx-testing-library/Interface.LogRolesOptions.mdx +++ b/docs/en/api/reactlynx-testing-library/Interface.LogRolesOptions.mdx @@ -22,4 +22,4 @@ optional hidden: boolean; #### Defined in -index.d.ts:787 +index.d.ts:841 diff --git a/docs/en/api/reactlynx-testing-library/Interface.MatcherOptions.mdx b/docs/en/api/reactlynx-testing-library/Interface.MatcherOptions.mdx index 4718ec4d1..021344a57 100644 --- a/docs/en/api/reactlynx-testing-library/Interface.MatcherOptions.mdx +++ b/docs/en/api/reactlynx-testing-library/Interface.MatcherOptions.mdx @@ -28,7 +28,7 @@ Use normalizer with getDefaultNormalizer instead #### Defined in -index.d.ts:932 +index.d.ts:998 *** @@ -40,7 +40,7 @@ optional exact: boolean; #### Defined in -index.d.ts:928 +index.d.ts:994 *** @@ -52,7 +52,7 @@ optional normalizer: NormalizerFn; #### Defined in -index.d.ts:933 +index.d.ts:999 *** @@ -66,7 +66,7 @@ suppress suggestions for a specific query #### Defined in -index.d.ts:935 +index.d.ts:1001 *** @@ -80,4 +80,4 @@ Use normalizer with getDefaultNormalizer instead #### Defined in -index.d.ts:930 +index.d.ts:996 diff --git a/docs/en/api/reactlynx-testing-library/Interface.NormalizerOptions.mdx b/docs/en/api/reactlynx-testing-library/Interface.NormalizerOptions.mdx index 008400764..74e2af240 100644 --- a/docs/en/api/reactlynx-testing-library/Interface.NormalizerOptions.mdx +++ b/docs/en/api/reactlynx-testing-library/Interface.NormalizerOptions.mdx @@ -42,7 +42,7 @@ optional normalizer: NormalizerFn; #### Defined in -index.d.ts:959 +index.d.ts:1025 *** diff --git a/docs/en/api/reactlynx-testing-library/Interface.PrettyDOMOptions.mdx b/docs/en/api/reactlynx-testing-library/Interface.PrettyDOMOptions.mdx index 0937125c7..ebf8f7794 100644 --- a/docs/en/api/reactlynx-testing-library/Interface.PrettyDOMOptions.mdx +++ b/docs/en/api/reactlynx-testing-library/Interface.PrettyDOMOptions.mdx @@ -14,7 +14,7 @@ import * as Lynx from '@lynx'; ## Extends -- [`prettyFormat`](/api/reactlynx-testing-library/Variable.prettyFormat.mdx) +- [`act`](/api/reactlynx-testing-library/Variable.act.mdx) ## Properties @@ -39,4 +39,4 @@ By default, ignores `