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 changes
• navigate(key, player, options?) — open a screen by key, including one another addon built
• back(player) — return to the screen the player came from
• closeUi(player) — close what a player is looking at, from outside the screen
• createContainerScreen(Screen) — serve a container screen, from @bedrock-core/ui/container

Contexts

• createContext(defaultValue) — pass a value down the tree without prop drilling
• TranslationContext — how localized text resolves for a subtree; render() provides it at every root, so you rarely provide it yourself
• ModalContext — marks that a subtree is inside a <Form>; read by the build's restriction pass

Build records

• Compiled screens — the component-to-title registry, the snapshot a debug render 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,
  NavigateOptions, RenderOptions, ScreenKey, ScreenKeys,
  PressEvent, SlotEvent, SubmitEvent, UiEvent, ContainerEvent,
  CompiledScreen, CompiledSnapshot,
  AddonReference, ScreenReference, ReferenceTarget, WalkResult,
} from '@bedrock-core/ui';

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
• @bedrock-core/ui-compiler — the build-time library, for tooling rather than for addons

Next steps

• Components — every built-in component
• Hooks — state and effects
• Hosts — what each screen can carry