@selfcommunity/react-core
Version:
React Core Components useful for integrating UI Community components (react-ui).
38 lines (35 loc) • 1.17 kB
TypeScript
import React from 'react';
import { SCPreferencesContextType } from '../../../types/context';
/**
* Creates Preferences/Features Context
*
:::tip Context can be consumed in one of the following ways:
```jsx
1. <SCPreferencesContext.Consumer>{(preferences) => (...)}</SCPreferencesContext.Consumer>
```
```jsx
2. const scPreferences: SCPreferencesType = useContext(SCPreferencesContext);
```
```jsx
3. const scPreferences: SCPreferencesType = useSCPreferences();
````
:::
*/
export declare const SCPreferencesContext: React.Context<SCPreferencesContextType>;
/**
* #### Description:
* This component imports all preferences and features enabled.
* @param children
* @return
* ```jsx
* <SCPreferencesContext.Provider value={{preferences, features}}>{!loading && children}</SCPreferencesContext.Provider>
* ```
*/
export default function SCPreferencesProvider({ children }: {
children: React.ReactNode;
}): JSX.Element;
/**
* Let's only export the `useSCPreferences` hook instead of the context.
* We only want to use the hook directly and never the context component.
*/
export declare function useSCPreferences(): SCPreferencesContextType;