@flexnative/theme-context/dist/ThemeContext.d.ts

React ThemeContext

/**
 * @ Author: Redon Alla
 * @ Create Time: 2023-06-04 21:29:02
 * @ Modified by: Redon Alla
 * @ Modified time: 2025-07-22 23:11:35
 * @ Description: Defines the ThemeContext and related hooks for accessing theme data within the application.
 */
import React from 'react';
import { BaseColors, BaseTheme, ThemeContextProps } from './props';
/**
 * The theme context provides the current theme settings to all components in the application.
 * It uses the `React.createContext` function to create the context object.
 *
 * @typeParam T - The type of the theme context properties.
 *
 * @property {ThemeContextProps<any>} defaultValue - The default value for the theme context, initialized with the default theme.
 *
 *  @example
 * ```typescript
 * // Example of using the ThemeContext directly
 * import ThemeContext from './ThemeContext';
 *
 * const MyComponent = () => {
 *   return (
 *     <ThemeContext.Consumer>
 *       {(context) => (
 *         <div>
 *           <p>Current Theme: {context.state.name}</p>
 *         </div>
 *       )}
 *     </ThemeContext.Consumer>
 *   );
 * };
 * ```
 */
declare const ThemeContext: React.Context<ThemeContextProps<any>>;
/**
 * Custom hook to access the current theme context.
 *
 * This hook provides access to the `ThemeContext` which contains the current theme settings.
 * It uses the `React.useContext` hook to retrieve the context value.
 *
 * @typeParam TColors - The type defining the custom colors added to the theme.
 * @returns {ThemeContextProps<TColors>} The current theme context value.
 * @throws {Error} Throws an error if the hook is used outside of a `ThemeProvider`.
 * @example
 * ```typescript
 * import { useThemeContext } from './ThemeContext';
 *
 * const MyComponent = () => {
 *   const { state, setTheme, setColors, setColorScheme } = useThemeContext<MyColors>();
 *   // Use the theme data and functions here
 *   return (
 *      <div>
 *          <p>Current theme name: {state.name}</p>
 *      </div>
 *   );
 * };
 * ```
 */
export declare function useThemeContext<TColors>(): ThemeContextProps<TColors>;
/**
 * Custom hook to access the current theme state.
 *
 * This hook provides access to the current theme's state, which includes the theme name, colors, fontSize, etc.
 * It uses the `React.useContext` hook to retrieve the context value.
 *
 * @typeParam TColors - The type defining the custom colors added to the theme.
 * @returns {BaseTheme<TColors>} The current theme state.
 * @throws {Error} Throws an error if the hook is used outside of a `ThemeProvider`.
 * @example
 * ```typescript
 * import { useThemeState } from './ThemeContext';
 *
 * const MyComponent = () => {
 *   const themeState = useThemeState<MyColors>();
 *   // Use the theme state here (e.g., themeState.colors.primary)
 *   return (
 *       <div>
 *           <p>Current Color Primary: {themeState.colors.primary}</p>
 *       </div>
 *   );
 * };
 * ```
 */
export declare function useThemeState<TColors>(): BaseTheme<TColors>;
/**
 * Custom hook to access the current theme colors.
 *
 * This hook provides access to the current theme's color palette. It returns an object containing both
 * the base colors and any custom colors defined in the theme.
 * It uses the `React.useContext` hook to retrieve the context value.
 *
 * @typeParam TColors - The type defining the custom colors added to the theme.
 * @returns {BaseColors & TColors} The current theme colors.
 * @throws {Error} Throws an error if the hook is used outside of a `ThemeProvider`.
 * @example
 * ```typescript
 * import { useThemeColors } from './ThemeContext';
 *
 * const MyComponent = () => {
 *   const themeColors = useThemeColors<MyColors>();
 *   // Use the theme colors here (e.g., themeColors.primary, themeColors.myCustomColor)
 *   return (
 *       <div style={{backgroundColor: themeColors.primary}}>
 *           <p style={{color: themeColors.text}}>Text on Primary color</p>
 *       </div>
 *   );
 * };
 * ```
 */
export declare function useThemeColors<TColors>(): BaseColors & TColors;
export default ThemeContext;