@j2inn/app/dist/app/AppView.d.ts

J2 Innovations core application framework

/**
 * The application view type.
 */
export type AppViewType = 'main' | 'sidebar' | 'header' | 'editor';
/**
 * An application view.
 */
export interface AppView {
    /**
     * The type of application view.
     */
    type: AppViewType;
    /**
     * Which category grouping to show in the AppLauncher.
     *
     * Please note, this only applies to main and header views.
     */
    category?: string;
    /**
     * Hides a view by default so it's not visible from
     * the application launcher. By default, a view is **not** hidden.
     *
     * Please note, this only applies to main views.
     */
    hidden?: boolean;
    /**
     * The associated app view ids for this app view.
     *
     * This is used by a sidebar that should only show when another main app view is showing.
     */
    associatedAppViewIds?: string[];
}