API
The top-level surface: showing a screen, the contexts around it, and the records the build leaves behind.
Showing a screen
render(root, player, options?)— show a compiled screen to one player and keep it shown across its state changesendRender(player, options?)— release a player's render session and optionally close native formsobserveRenderLifecycle(listener, options?)— observe server-side session starts, replacements and endingsrefreshRender(player)— re-present the current form while retaining hook statecreateContainerScreen(Screen)— serve a container screen, from@bedrock-core/ui/container
Contexts
createContext(defaultValue)— pass a value down the tree without prop drillingTranslationContext— how localized text resolves for a subtree;render()provides it at every root, so you rarely provide it yourselfModalContext— marks that a subtree is inside a<Form>; read by the build's restriction pass
Navigation
@bedrock-core/navigation owns routing, links, resident stacks and player history. @bedrock-core/ui/navigation is its UI facade. The optional @bedrock-core/navigation/core entry point provides createCoreNavigationAdapter(core) for the same route tree. The main UI entry point exposes rendering and controls independently of navigation.
- Server destinations —
navigate,navigateAsync,backandcloseUi useNavigation()— typed operations on the confirmed route tree- Static navigators —
createStackNavigator,createTopTabNavigatorandcreateStaticNavigation - Screen metadata and parameter contracts — local descriptors and the published registry
- Host openers and realm transport —
navigation(core)andregister()
Build records
- Compiled screens — the component-to-title registry, the snapshot a
debugrender is diffed against, and the reference table a static screen publishes
Errors
- Errors — every error class the library throws and the fix each one names
Types
import type {
ControlProps, LayoutProps, FunctionComponent, JSX, RenderOptions,
PressEvent, SlotEvent, SubmitEvent, UiEvent, ContainerEvent,
CompiledSnapshot, RenderSession, RenderLifecycleEvent,
} from '@bedrock-core/ui';
import type {
DestinationOptions, DestinationKey, StaticScreenProps, StaticParamList,
} from '@bedrock-core/ui/navigation';
Every component's props type is exported beside it — ButtonProps, TextProps, ListProps, TabsProps and the rest — and every flex primitive through @bedrock-core/ui/flexbox.
Advanced
withControl(props)— low-level control normalization used by framework component packages- Extending components — compose public controls and understand the native-control boundary
- Build integration — compile addon screens with builder
- Render extensions — expanded-tree composition, compilation data and render ownership
Next steps
- Components — every built-in component
- Hooks — state and effects
- Hosts — what each screen can carry