Files
react.dev/src/sidebarReference.json
Jack Pope 12fca4c24f Add act documentation (#6901)
* Add act documentation

* Update structure based on feedback

* Add usage examples and async act

---------

Co-authored-by: Rick Hanlon <rickhanlonii@fb.com>
2024-05-28 15:05:05 -04:00

436 lines
11 KiB
JSON

{
"title": "API Reference",
"path": "/reference/react",
"routes": [
{
"hasSectionHeader": true,
"sectionHeader": "react@{{version}}"
},
{
"title": "Overview",
"path": "/reference/react"
},
{
"title": "Hooks",
"path": "/reference/react/hooks",
"routes": [
{
"title": "useActionState",
"path": "/reference/react/useActionState",
"canary": true
},
{
"title": "useCallback",
"path": "/reference/react/useCallback"
},
{
"title": "useContext",
"path": "/reference/react/useContext"
},
{
"title": "useDebugValue",
"path": "/reference/react/useDebugValue"
},
{
"title": "useDeferredValue",
"path": "/reference/react/useDeferredValue"
},
{
"title": "useEffect",
"path": "/reference/react/useEffect"
},
{
"title": "useId",
"path": "/reference/react/useId"
},
{
"title": "useImperativeHandle",
"path": "/reference/react/useImperativeHandle"
},
{
"title": "useInsertionEffect",
"path": "/reference/react/useInsertionEffect"
},
{
"title": "useLayoutEffect",
"path": "/reference/react/useLayoutEffect"
},
{
"title": "useMemo",
"path": "/reference/react/useMemo"
},
{
"title": "useOptimistic",
"path": "/reference/react/useOptimistic",
"canary": true
},
{
"title": "useReducer",
"path": "/reference/react/useReducer"
},
{
"title": "useRef",
"path": "/reference/react/useRef"
},
{
"title": "useState",
"path": "/reference/react/useState"
},
{
"title": "useSyncExternalStore",
"path": "/reference/react/useSyncExternalStore"
},
{
"title": "useTransition",
"path": "/reference/react/useTransition"
}
]
},
{
"title": "Components",
"path": "/reference/react/components",
"routes": [
{
"title": "<Fragment> (<>)",
"path": "/reference/react/Fragment"
},
{
"title": "<Profiler>",
"path": "/reference/react/Profiler"
},
{
"title": "<StrictMode>",
"path": "/reference/react/StrictMode"
},
{
"title": "<Suspense>",
"path": "/reference/react/Suspense"
}
]
},
{
"title": "APIs",
"path": "/reference/react/apis",
"routes": [
{
"title": "act",
"path": "/reference/react/act"
},
{
"title": "cache",
"path": "/reference/react/cache",
"canary": true
},
{
"title": "createContext",
"path": "/reference/react/createContext"
},
{
"title": "forwardRef",
"path": "/reference/react/forwardRef"
},
{
"title": "lazy",
"path": "/reference/react/lazy"
},
{
"title": "memo",
"path": "/reference/react/memo"
},
{
"title": "startTransition",
"path": "/reference/react/startTransition"
},
{
"title": "use",
"path": "/reference/react/use",
"canary": true
},
{
"title": "experimental_taintObjectReference",
"path": "/reference/react/experimental_taintObjectReference",
"canary": true
},
{
"title": "experimental_taintUniqueValue",
"path": "/reference/react/experimental_taintUniqueValue",
"canary": true
}
]
},
{
"hasSectionHeader": true,
"sectionHeader": "react-dom@{{version}}"
},
{
"title": "Hooks",
"path": "/reference/react-dom/hooks",
"routes": [
{
"title": "useFormStatus",
"path": "/reference/react-dom/hooks/useFormStatus",
"canary": true
}
]
},
{
"title": "Components",
"path": "/reference/react-dom/components",
"routes": [
{
"title": "Common (e.g. <div>)",
"path": "/reference/react-dom/components/common"
},
{
"title": "<form>",
"path": "/reference/react-dom/components/form",
"canary": true
},
{
"title": "<input>",
"path": "/reference/react-dom/components/input"
},
{
"title": "<option>",
"path": "/reference/react-dom/components/option"
},
{
"title": "<progress>",
"path": "/reference/react-dom/components/progress"
},
{
"title": "<select>",
"path": "/reference/react-dom/components/select"
},
{
"title": "<textarea>",
"path": "/reference/react-dom/components/textarea"
},
{
"title": "<link>",
"path": "/reference/react-dom/components/link",
"canary": true
},
{
"title": "<meta>",
"path": "/reference/react-dom/components/meta",
"canary": true
},
{
"title": "<script>",
"path": "/reference/react-dom/components/script",
"canary": true
},
{
"title": "<style>",
"path": "/reference/react-dom/components/style",
"canary": true
},
{
"title": "<title>",
"path": "/reference/react-dom/components/title",
"canary": true
}
]
},
{
"title": "APIs",
"path": "/reference/react-dom",
"routes": [
{
"title": "createPortal",
"path": "/reference/react-dom/createPortal"
},
{
"title": "flushSync",
"path": "/reference/react-dom/flushSync"
},
{
"title": "findDOMNode",
"path": "/reference/react-dom/findDOMNode"
},
{
"title": "hydrate",
"path": "/reference/react-dom/hydrate"
},
{
"title": "preconnect",
"path": "/reference/react-dom/preconnect",
"canary": true
},
{
"title": "prefetchDNS",
"path": "/reference/react-dom/prefetchDNS",
"canary": true
},
{
"title": "preinit",
"path": "/reference/react-dom/preinit",
"canary": true
},
{
"title": "preinitModule",
"path": "/reference/react-dom/preinitModule",
"canary": true
},
{
"title": "preload",
"path": "/reference/react-dom/preload",
"canary": true
},
{
"title": "preloadModule",
"path": "/reference/react-dom/preloadModule",
"canary": true
},
{
"title": "render",
"path": "/reference/react-dom/render"
},
{
"title": "unmountComponentAtNode",
"path": "/reference/react-dom/unmountComponentAtNode"
}
]
},
{
"title": "Client APIs",
"path": "/reference/react-dom/client",
"routes": [
{
"title": "createRoot",
"path": "/reference/react-dom/client/createRoot"
},
{
"title": "hydrateRoot",
"path": "/reference/react-dom/client/hydrateRoot"
}
]
},
{
"title": "Server APIs",
"path": "/reference/react-dom/server",
"routes": [
{
"title": "renderToNodeStream",
"path": "/reference/react-dom/server/renderToNodeStream"
},
{
"title": "renderToPipeableStream",
"path": "/reference/react-dom/server/renderToPipeableStream"
},
{
"title": "renderToReadableStream",
"path": "/reference/react-dom/server/renderToReadableStream"
},
{
"title": "renderToStaticMarkup",
"path": "/reference/react-dom/server/renderToStaticMarkup"
},
{
"title": "renderToStaticNodeStream",
"path": "/reference/react-dom/server/renderToStaticNodeStream"
},
{
"title": "renderToString",
"path": "/reference/react-dom/server/renderToString"
}
]
},
{
"hasSectionHeader": true,
"sectionHeader": "Rules of React"
},
{
"title": "Overview",
"path": "/reference/rules",
"routes": [
{
"title": "Components and Hooks must be pure",
"path": "/reference/rules/components-and-hooks-must-be-pure"
},
{
"title": "React calls Components and Hooks",
"path": "/reference/rules/react-calls-components-and-hooks"
},
{
"title": "Rules of Hooks",
"path": "/reference/rules/rules-of-hooks"
}
]
},
{
"hasSectionHeader": true,
"sectionHeader": "React Server Components"
},
{
"title": "Server Components",
"path": "/reference/rsc/server-components",
"canary": true
},
{
"title": "Server Actions",
"path": "/reference/rsc/server-actions",
"canary": true
},
{
"title": "Directives",
"path": "/reference/rsc/directives",
"canary": true,
"routes": [
{
"title": "'use client'",
"path": "/reference/rsc/use-client",
"canary": true
},
{
"title": "'use server'",
"path": "/reference/rsc/use-server",
"canary": true
}
]
},
{
"hasSectionHeader": true,
"sectionHeader": "Legacy APIs"
},
{
"title": "Legacy React APIs",
"path": "/reference/react/legacy",
"routes": [
{
"title": "Children",
"path": "/reference/react/Children"
},
{
"title": "cloneElement",
"path": "/reference/react/cloneElement"
},
{
"title": "Component",
"path": "/reference/react/Component"
},
{
"title": "createElement",
"path": "/reference/react/createElement"
},
{
"title": "createFactory",
"path": "/reference/react/createFactory"
},
{
"title": "createRef",
"path": "/reference/react/createRef"
},
{
"title": "isValidElement",
"path": "/reference/react/isValidElement"
},
{
"title": "PureComponent",
"path": "/reference/react/PureComponent"
}
]
}
]
}