libs/sdk/src/lib/model/split-journey-configuration.schema.ts
PageConfiguration,WithSchema
Properties |
|
| bannerBlock (Optional) | |
| Type |
BannerBlockConfiguration
|
|
Description
|
A Building Block that will be shown in the top area of the page and will stick to the top of the window |
| id | |
| Type |
string
|
|
Description
|
The page id is used to determine the filename of the generated page. The page Id must also match the page id in the PFE configuration otherwise the setup during runtime will fail. Example : |
| notificationsGroup (Optional) | |
| Type |
{ columnSpan?: "4" | "6" | "8" | "10" | "12"; items: NotificationConfig[] }
|
|
Description
|
Configuration for overarching notifications |
| overarchingDetailsBlock (Optional) | |
| Type |
OverarchingDetailsBlockConfiguration
|
|
Description
|
A configuration of the Building Block that will be displayed as overarching details above the page content area. |
| pageData (Optional) | |
| Type |
PageData
|
| panels (Optional) | |
| Type |
PanelDefinition[]
|
|
Description
|
List of available panels to group other content into. |
| sections (Optional) | |
| Type |
PageSectionDefinition[]
|
| Default value |
[]
|
|
Description
|
List of available sections to group other content into. [] |
| sidebar (Optional) | |
| Type |
SidebarConfiguration
|
|
Description
|
Sidebar configuration for the page. |
| smallPrint (Optional) | |
| Type |
SmallPrintDefinition
|
| title (Optional) | |
| Type |
PageTitle
|
|
Description
|
The page title can either be specified as a string or as an object to configure it in more detail (e.g. placing it within a stage). Example : |
import type {
NavServiceActivatorConfig,
PfeActionConfig,
PfeConfig,
PfeNavigationConfiguration
} from '@allianz/ngx-pfe';
import type { PageConfiguration } from '@allianz/taly-core/schemas';
import type { PagesJsonSchema } from './pages-json.schema';
export interface WithSchema {
/** The JSON Schema for this file */
$schema?: string;
}
export interface ApplicationJsonSchema
extends Omit<PagesJsonSchema, 'pages'>,
PfeConfig,
WithSchema {}
export interface PageJsonSchema extends PageConfiguration, WithSchema {}
export interface NavigationJsonSchema
extends Omit<PfeNavigationConfiguration, 'serviceActivators'>,
WithSchema {}
// We need to use `type` for the next two types because the base types are defined using an
// index type that is not `string` and we can't add a string-typed property (like "$schema").
// `interface` doesn't allow this but `type` does.
// See https://www.typescriptlang.org/docs/handbook/2/objects.html#index-signatures for details
export type GlobalServiceActivatorsJsonSchema = {
[key: string]: NavServiceActivatorConfig;
} & WithSchema;
export type GlobalActionsJsonSchema = { [key: string]: PfeActionConfig } & WithSchema;