Interfaces
ModuleOptions
Properties
Variables
module
Functions
useFooterNavigation()
Access the main footer navigation tree.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params? | GetNavigationParameters | undefined | Options to use when fetching the navigation tree through SAPI. |
treeName? | string | 'Footer' | The name of the navigation tree to fetch. Defaults to 'Footer'. |
Returns
ExtendedAsyncData<NavigationTree, unknown, NavigationTree, KeysOf<NavigationTree>, null>
The navigation tree for the main footer.
useHeaderNavigation()
Access the main header navigation tree.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params? | GetNavigationParameters | undefined | Options to use when fetching the navigation tree through SAPI. |
treeName? | string | 'Header' | The name of the navigation tree to fetch. Defaults to 'Header'. |
Returns
ExtendedAsyncData<NavigationTree, unknown, NavigationTree, KeysOf<NavigationTree>, null>
The navigation tree for the main header.
useNavigations()
Access all navigation trees.
Type Parameters
| Type Parameter | Default type |
|---|---|
DataT | NavigationV2AllEndpointResponseData |
PickKeys extends KeysOf<DataT> | KeysOf<DataT> |
DefaultT | null |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params | Partial<{ options: UseRpcOptions<..., ..., ..., ...>; params: MaybeRefOrGetter<...>; }> | {} | Parameters for fetching navigation trees. |
key | MaybeRefOrGetter | 'getAllNavigations' | A unique key for this RPC call. Used internally by useRpc for caching and state management. |
Returns
UseRpcReturn<"getAllNavigations", DataT, PickKeys, DefaultT>
The navigation trees data. It will return an ErrorResponse if an error occurs during fetching.
useNavigationsByReferenceKey()
Access a navigation tree by its reference key.
Type Parameters
| Type Parameter | Default type |
|---|---|
DataT | NavigationV2Tree |
PickKeys extends KeysOf<DataT> | KeysOf<DataT> |
DefaultT | null |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params | Partial<{ options: UseRpcOptions<..., ..., ..., ...>; params: MaybeRefOrGetter<...>; }> | {} | Parameters for fetching navigation trees. |
key | MaybeRefOrGetter | 'getNavigationsByReferenceKey' | A unique key for this RPC call. Used internally by useRpc for caching and state management. |
Returns
UseRpcReturn<"getNavigationsByReferenceKey", DataT, PickKeys, DefaultT>
The navigation tree data. It will return an ErrorResponse if an error occurs during fetching.
useSimpleFooterNavigation()
Access the simple footer navigation tree.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params? | GetNavigationParameters | undefined | Options to use when fetching the navigation tree through SAPI. |
treeName? | string | 'Simplified Footer' | The name of the navigation tree to fetch. Defaults to 'Simplified Footer'. |
Returns
ExtendedAsyncData<NavigationTree, unknown, NavigationTree, KeysOf<NavigationTree>, null>
The navigation tree for the simple footer.
useSimpleHeaderNavigation()
Access the simple header navigation tree.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
params? | GetNavigationParameters | undefined | Options to use when fetching the navigation tree through SAPI. |
treeName? | string | 'Simplified Header' | The name of the navigation tree to fetch. Defaults to 'Simplified Header'. |
Returns
ExtendedAsyncData<NavigationTree, unknown, NavigationTree, KeysOf<NavigationTree>, null>
The navigation tree for the simple header.
