Skip to main content

Function: useAppSettings()

useAppSettings<T, P>(params, options): useAppSettingsResponse<T>

Defined in: packages/next/src/data/hooks/useAppSettings.ts:33

The useAppSettings hook

Usage

const { data, loading, error } = useAppSettings();

// check loading and error states
Server-Side-Rendering or Static-Site-Generation
export async function getServerSideProps(context) {
const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);
return addHookData([useAppSettingsData], {});
}

Important: You most likely want to fetch app settings on every route so that you can access global settings and menus in your pages & components

Type Parameters

T

T extends AppEntity = AppEntity

P

P extends EndpointParams = EndpointParams

Parameters

params

Partial<P> = {}

The parameters accepted by the hook

options

FetchHookOptions<FetchResponse<T>> = {}

Options for the SWR configuration

Returns

useAppSettingsResponse<T>