Skip to main content

useContext

Access context values from Context Providers.

Import

import { useContext } from '@bedrock-core/ui';

Signature

function useContext<T>(context: Context<T>): T

Parameters

context

  • Type: Context<T>
  • Description: The context object created by createContext()

Returns

The current context value for the given context. The value is determined by the nearest <Context> above the component in the tree.

Usage

import { createContext, useContext } from '@bedrock-core/ui';

interface Theme {
color: string;
fontSize: number;
}

const ThemeContext = createContext<Theme>({
color: '#ffffff',
fontSize: 14
});

function App() {
return (
<ThemeContext value={{ color: '#3498db', fontSize: 16 }}>
<ThemedComponent />
</ThemeContext>
);
}

function ThemedComponent() {
const theme = useContext(ThemeContext);

return (
<Text x={10} y={10} width={300} height={30}>{`Color: ${theme.color}, Size: ${theme.fontSize}`}</Text>
);
}

Examples

Theme Context

interface Theme {
primaryColor: string;
backgroundColor: string;
}

const ThemeContext = createContext<Theme>({
primaryColor: '#ffffff',
backgroundColor: '#000000'
});

function App() {
return (
<ThemeContext value={{ primaryColor: '#3498db', backgroundColor: '#2c3e50' }}>
<Panel width={400} height={300}>
<ThemedText />
<ThemedButton />
</Panel>
</ThemeContext>
);
}

function ThemedText() {
const theme = useContext(ThemeContext);

return (
<Text x={10} y={10} width={380} height={30}>{`Primary: ${theme.primaryColor}`}</Text>
);
}

function ThemedButton() {
const theme = useContext(ThemeContext);

return (
<Button x={10} y={50} width={380} height={40} onPress={() => {}}>
<Text x={10} y={10} width={360} height={20}>Styled Button</Text>
</Button>
);
}

User Context

interface User {
id: string;
name: string;
role: 'admin' | 'user';
}

const UserContext = createContext<User | null>(null);

function App() {
const currentUser: User = {
id: '123',
name: 'Steve',
role: 'admin'
};

return (
<UserContext value={currentUser}>
<Dashboard />
</UserContext>
);
}

function Dashboard() {
const user = useContext(UserContext);

if (!user) {
return <Text x={10} y={10} width={300} height={30}>Not logged in</Text>;
}

return (
<Panel width={400} height={300}>
<Text x={10} y={10} width={380} height={30}>{`Welcome, ${user.name}!`}</Text>
<Text x={10} y={50} width={380} height={30}>{`Role: ${user.role}`}</Text>
</Panel>
);
}

Settings Context with Updates

interface Settings {
volume: number;
brightness: number;
}

interface SettingsContextValue {
settings: Settings;
updateSettings: (partial: Partial<Settings>) => void;
}

const SettingsContext = createContext<SettingsContextValue>({
settings: { volume: 50, brightness: 80 },
updateSettings: () => {}
});

function SettingsProvider({ children }: { children: JSX.Element }) {
const [settings, setSettings] = useState<Settings>({
volume: 50,
brightness: 80
});

const updateSettings = (partial: Partial<Settings>) => {
setSettings(prev => ({ ...prev, ...partial }));
};

return (
<SettingsContext value={{ settings, updateSettings }}>
{children}
</SettingsContext>
);
}

function VolumeControl() {
const { settings, updateSettings } = useContext(SettingsContext);

return (
<>
<Text x={10} y={10} width={300} height={30}>{`Volume: ${settings.volume}%`}</Text>
<Button x={10} y={50} width={180} height={40} onPress={() => updateSettings({ volume: Math.min(settings.volume + 10, 100) })}>
<Text x={10} y={10} width={160} height={20}>Volume +</Text>
</Button>
<Button x={200} y={50} width={180} height={40} onPress={() => updateSettings({ volume: Math.max(settings.volume - 10, 0) })}>
<Text x={10} y={10} width={160} height={20}>Volume -</Text>
</Button>
</>
);
}

Best Practices

Provide Default Values

// ✅ Good - meaningful default
const ThemeContext = createContext({
color: '#000000',
fontSize: 14
});

// ❌ Less ideal
const ThemeContext = createContext(null);

Use Custom Hooks

// ✅ Good - encapsulate context logic
function useTheme() {
const context = useContext(ThemeContext);
if (!context) {
throw new Error('useTheme must be used within ThemeProvider');
}
return context;
}

// Usage
const theme = useTheme();

Type Safety

// ✅ Good - typed context
interface AppSettings {
darkMode: boolean;
language: string;
}

const SettingsContext = createContext<AppSettings>({
darkMode: false,
language: 'en'
});

Common Patterns

Provider Composition

function AppProviders({ children }: { children: JSX.Element }) {
return (
<ThemeProvider>
<AuthProvider>
<SettingsProvider>
{children}
</SettingsProvider>
</AuthProvider>
</ThemeProvider>
);
}

Context vs Props

AspectContextProps
When to useDeeply nested dataDirect parent-child
ClarityGood for global stateMore explicit data flow
BoilerplateLess prop drillingMore verbose