Class ComponentHierarchyRegistrar

Utility class for registering component hierarchies

Index

Constructors

Methods

registerHierarchy registerSingleComponent

Constructors

constructor

new ComponentHierarchyRegistrar(
    compiler: ComponentCompiler,
    registry: ComponentRegistry,
    runtimeContext: RuntimeContext,
): ComponentHierarchyRegistrar
Parameters
- compiler: ComponentCompiler
- registry: ComponentRegistry
- runtimeContext: RuntimeContext
Returns ComponentHierarchyRegistrar
- Defined in React/runtime/src/runtime/component-hierarchy.ts:68

Methods

registerHierarchy

registerHierarchy(
rootSpec: ComponentSpec,
options: HierarchyRegistrationOptions,
): Promise<HierarchyRegistrationResult>
Registers a complete component hierarchy from a root specification
Parameters
- rootSpec: ComponentSpec
  The root component specification
- options: HierarchyRegistrationOptions
  Registration options
Returns Promise<HierarchyRegistrationResult>
Registration result with details about success/failures
- Defined in React/runtime/src/runtime/component-hierarchy.ts:120

registerSingleComponent

registerSingleComponent(
    spec: ComponentSpec,
    options: {
        allLibraries: MJComponentLibraryEntity[];
        allowOverride?: boolean;
        namespace?: string;
        styles?: ComponentStyles;
        version?: string;
    },
): Promise<{ error?: ComponentRegistrationError; success: boolean }>
Registers a single component from a specification
Parameters
- spec: ComponentSpec
  Component specification
- options: {
      allLibraries: MJComponentLibraryEntity[];
      allowOverride?: boolean;
      namespace?: string;
      styles?: ComponentStyles;
      version?: string;
  }
  Registration options
Returns Promise<{ error?: ComponentRegistrationError; success: boolean }>
Registration result for this component
- Defined in React/runtime/src/runtime/component-hierarchy.ts:306