Skip to main content

Function: useSettings()

useSettings<T>(selector?): T | undefined

Defined in: packages/react-page-renderer/src/hooks/settings.ts:19

IMA $Settings access provider with optional selector.

Type Parameters

T = any

Parameters

selector?

string

Optional path selector.

Returns

T | undefined

Settings value or undefined.

Example

const settings = useSettings();
console.log(settings.$Cache.enabled);

// Using settings selector
const { scripts, documentView } = useSettings('$Page.$Render');
const esScripts = useSettings('$Page.$Render.esScripts');