Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vertz.dev/llms.txt

Use this file to discover all available pages before exploring further.

Context provides dependency injection for components. Create a context, wrap a subtree with a Provider, and read it with useContext(). No prop threading required.

​
createContext()

Create a context object that can hold a typed value. 
import { createContext } from '@vertz/ui';

interface SettingsValue {
  theme: string;
  locale: string;
}

const SettingsContext = createContext<SettingsValue>();

​
Signature

function createContext<T>(defaultValue?: T): Context<T>;

​
Parameters

ParameterTypeDescription
defaultValueTValue returned by useContext() when no Provider is active

​
Returns

Context<T> — an object with a Provider method for providing values and internal state for useContext() lookups.

​
useContext()

Read the current value from the nearest Provider in the component tree. 
import { useContext } from '@vertz/ui';

function SettingsPanel() {
  const settings = useContext(SettingsContext);
  return <div>Theme: {settings.theme}</div>;
}

​
Signature

function useContext<T>(ctx: Context<T>): T | undefined;

​
Parameters

ParameterTypeDescription
ctxContext<T>The context to read from

​
Returns

The current context value from the nearest Provider, the default value if no Provider is active, or undefined if neither exists.

​
Provider

Provide a value to all descendants. Two usage patterns are supported:

​
JSX usage

function App() {
  const settings = { theme: 'dark', locale: 'en' };

  return (
    <SettingsContext.Provider value={settings}>
      <SettingsPanel />
    </SettingsContext.Provider>
  );
}

​
Callback usage

SettingsContext.Provider({ theme: 'dark', locale: 'en' }, () => {
  // Everything rendered here sees the provided value
  renderApp();
});

​
Pattern: typed accessor hook

Always create a use* wrapper that throws on missing Provider. This gives consumers a clear error instead of silent undefined. 
import { createContext, useContext } from '@vertz/ui';

interface AuthValue {
  user: { id: string; name: string };
  logout: () => void;
}

const AuthContext = createContext<AuthValue>();

export function useAuth(): AuthValue {
  const ctx = useContext(AuthContext);
  if (!ctx) throw new Error('useAuth must be called within AuthContext.Provider');
  return ctx;
}

function UserMenu() {
  const { user, logout } = useAuth();
  return (
    <div>
      <span>{user.name}</span>
      <button onClick={logout}>Logout</button>
    </div>
  );
}

​
Types

interface Context<T> {
  Provider(value: T, fn: () => void): void;
  Provider(props: ProviderJsxProps<T>): HTMLElement;
}

interface ProviderJsxProps<T> {
  value: T;
  children: (() => unknown) | unknown;
}