@o3r/components/devkit/components-devkit.interface.d.ts

This module contains component-related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...) It comes with an integrated ng builder to help you generate components compatible with Otter features (CMS integration

import type { ConnectContentMessage, DevtoolsCommonOptions, MessageDataTypes, OtterMessageContent, RequestMessagesContentMessage } from '@o3r/core';
import type { PlaceholderMode } from '../stores';
import { OtterLikeComponentInfo } from './inspector';
/**
 * Component Devtools options
 */
export interface ComponentsDevtoolsServiceOptions extends DevtoolsCommonOptions {
}
/**
 * Message to give the selected component information
 */
export interface SelectedComponentInfoMessage extends OtterLikeComponentInfo, OtterMessageContent<'selectedComponentInfo'> {
}
/**
 * Message to toggle the inspector
 */
export interface ToggleInspectorMessage extends OtterMessageContent<'toggleInspector'> {
    /** Is the inspector running */
    isRunning: boolean;
}
/**
 * Message to toggle the placeholder mode
 */
export interface PlaceholderModeMessage extends OtterMessageContent<'placeholderMode'> {
    /** Placeholder mode */
    mode: PlaceholderMode;
}
/**
 * Message to know the component selection availability
 */
export interface IsComponentSelectionAvailableMessage extends OtterMessageContent<'isComponentSelectionAvailable'> {
    available: boolean;
}
type ComponentsMessageContents = IsComponentSelectionAvailableMessage | SelectedComponentInfoMessage | ToggleInspectorMessage | PlaceholderModeMessage;
/** List of possible DataTypes for Components messages */
export type ComponentsMessageDataTypes = MessageDataTypes<ComponentsMessageContents>;
/** List of all messages for Components purpose */
export type AvailableComponentsMessageContents = ComponentsMessageContents | ConnectContentMessage | RequestMessagesContentMessage<ComponentsMessageDataTypes>;
/**
 * Determine if the given message is a Components message
 * @param message message to check
 */
export declare const isComponentsMessage: (message: any) => message is AvailableComponentsMessageContents;
export {};
//# sourceMappingURL=components-devkit.interface.d.ts.map