@syncfusion/react-base/src/provider.d.ts

A common package of core React base, methods and class definitions

import { ReactNode } from 'react';
interface ProviderContextProps {
    locale: string;
    dir: string;
    ripple: boolean;
    animate: boolean;
}
/**
 * Props for the Provider context.
 */
export interface ProviderProps {
    /**
     * Components that will have access to the provided context value.
     */
    children: ReactNode;
    /**
     * Specifies the locale for the component.
     *
     * @default 'en-US'
     */
    locale?: string;
    /**
     * Specifies the text direction of the component. Use 'ltr' for left-to-right or 'rtl' for right-to-left.
     *
     * @default 'ltr'
     */
    dir?: string;
    /**
     * Enables or disables the ripple effect for the component.
     *
     * @default false
     */
    ripple?: boolean;
    /**
     * Enables or disables the animation effect for the component.
     *
     * @default true
     */
    animate?: boolean;
}
export declare const Provider: React.FC<ProviderProps>;
/**
 * Custom hook to consume locale context.
 *
 * @private
 * @returns {ProviderContextProps} - The locale context value.
 */
export declare function useProviderContext(): ProviderContextProps;
export {};