aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/odlux/framework/src/models/applicationInfo.ts
blob: d2076591edddea097cdf2eac17f07cb8195806d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import { ComponentType } from 'react';
import { IconType } from './iconDefinition';

import { IActionHandler } from '../flux/action';
import { Middleware } from '../flux/middleware';

/** Represents the information needed about an application to integrate. */
export class ApplicationInfo {
  /** The name of the application. */
  name: string;
  /** Optional: The title of the application, if null ot undefined the name will be used. */
  title?: string;
  /** Optional: The icon of the application for the navigation and title bar. */
  icon?: IconType;
  /** Optional: The description of the application. */
  description?: string;
  /** The root component of the application. */
  rootComponent: ComponentType;
  /** Optional: The root action handler of the application. */
  rootActionHandler?: IActionHandler<{ [key: string]: any }>; 
  /** Optional: Application speciffic middlewares. */
  middlewares?: Middleware<{ [key: string]: any }>[]; 
  /** Optional: A mapping object with the exported components. */
  exportedComponents?: { [key: string]: ComponentType }
  /** Optional: The entry to be shown in the menu. If undefiened the name will be used. */
  menuEntry?: string | React.ComponentType;
  /** Optional: A component to be shown in the menu when this app is active below the main entry. If undefiened the name will be used. */
  subMenuEntry?: React.ComponentType;
  /** Optional: The pasth for this application. If undefined the name will be use as path. */
  path?: string;
}