Skip to content

useContext Hook ​

The useContext composable accesses context values from context providers in Fabric components.

Use useContext when: You need to access shared state, configuration, or values from parent components.

Perfect for: Custom context access, shared configuration, implementing context patterns.

NOTE

This hook is used internally by @kubb/react-fabric for React context integration.

Usage ​

Access values from a specific context key.

Example: Access Fabric context values.

ts
import { 
useContext
} from '@kubb/fabric-core'
import {
FabricContext
} from '@kubb/fabric-core'
function
MyComponent
() {
const {
meta
} =
useContext
(
FabricContext
)
return `Version: ${(
meta
as {
version
: string }).
version
}`
}

Parameters ​

ParameterTypeDescription
keyContext<T>The context key to retrieve
defaultValueTOptional default value if context is not found

Return Value ​

Returns the value stored in the specified context, or the default value if not found.

When to Use ​

Use useContext when you need to:

  • Access shared state from a context provider
  • Read configuration values from parent components
  • Implement custom context access patterns

Examples ​

With Default Value ​

ts
import { 
useContext
,
createContext
} from '@kubb/fabric-core'
const
ThemeContext
=
createContext
<{
mode
: 'light' | 'dark' }>({
mode
: 'light' })
function
MyComponent
() {
const
theme
=
useContext
(
ThemeContext
, {
mode
: 'light' })
return
theme
}

See Also ​

Released under the MIT License.