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.
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.
