@itwin/presentation-hierarchies-react/lib/cjs/presentation-hierarchies-react/itwinui/LocalizationContext.d.ts

React components based on `@itwin/presentation-hierarchies`

import { PropsWithChildren } from "react";
/**
 * Localized strings used in the components.
 * @public
 */
export interface LocalizedStrings {
    /**
     * Message displayed when nodes are loading.
     * Default value: `Loading...`.
     */
    loading: string;
    /**
     * Title for apply hierarchy filter button.
     * Default value: `Apply filter`.
     */
    filterHierarchyLevel: string;
    /**
     * Title for clear hierarchy filter button.
     * Default value: `Clear active filter`.
     */
    clearHierarchyLevelFilter: string;
    /**
     * Message displayed when no nodes matching filter are found.
     * Default value: `No child nodes match current filter`.
     */
    noFilteredChildren: string;
    /**
     * Message displayed when result limit exceeds hierarchy size limit.
     * Default value: `There are more items than allowed limit of {{limit}}.`.
     */
    resultLimitExceeded: string;
    /**
     * Message displayed when result limit exceeds hierarchy size limit and hierarchy filtering is enabled.
     * Default value: `Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.`.
     */
    resultLimitExceededWithFiltering: string;
    /**
     * Message displayed when hierarchy size limit can be overridden.
     * Default value: `<link>Increase the hierarchy level size limit to {{limit}}.</link>`.
     */
    increaseHierarchyLimit: string;
    /**
     * Message displayed when hierarchy size limit can be overridden and hierarchy filtering is enabled.
     * Default value: `Or, <link>increase the hierarchy level size limit to {{limit}}.</link>`.
     */
    increaseHierarchyLimitWithFiltering: string;
    /**
     * Label for retry action.
     * Default value: `Retry`.
     */
    retry: string;
    /**
     * Label for more actions button.
     * Default value: `More`.
     */
    more: string;
}
/** @internal */
export interface LocalizationContext {
    localizedStrings: LocalizedStrings;
}
/**
 * Properties for `LocalizationContextProvider`.
 * @public
 */
interface LocalizationContextProviderProps {
    /** Localized strings used in the components. */
    localizedStrings?: Partial<LocalizedStrings>;
}
/**
 * Context provider for localized strings used in the components.
 * @public
 */
export declare function LocalizationContextProvider({ localizedStrings, children }: PropsWithChildren<LocalizationContextProviderProps>): import("react/jsx-runtime").JSX.Element;
/** @internal */
export declare function useLocalizationContext(): LocalizationContext;
export {};
//# sourceMappingURL=LocalizationContext.d.ts.map