• Overview
@angular/core

createComponent

function

Creates a ComponentRef instance based on provided component type and a set of options.

  
    function createComponent<C>(  component: Type<C>,  options: { environmentInjector: EnvironmentInjector; hostElement?: Element | undefined; elementInjector?: Injector | undefined; projectableNodes?: Node[][] | undefined; }): ComponentRef<C>;
  
  

createComponent

Creates a ComponentRef instance based on provided component type and a set of options.

@paramcomponentType<C>

Component class reference.

@paramoptions{ environmentInjector: EnvironmentInjector; hostElement?: Element | undefined; elementInjector?: Injector | undefined; projectableNodes?: Node[][] | undefined; }

Set of options to use:

  • environmentInjector: An EnvironmentInjector instance to be used for the component.
  • hostElement (optional): A DOM node that should act as a host node for the component. If not provided, Angular creates one based on the tag name used in the component selector (and falls back to using div if selector doesn't have tag name info).
  • elementInjector (optional): An ElementInjector instance, see additional info about it here.
  • projectableNodes (optional): A list of DOM nodes that should be projected through <ng-content> of the new component instance, e.g., [[element1, element2]]: projects element1 and element2 into the same <ng-content>. [[element1, element2], [element3]]: projects element1 and element2 into one <ng-content>, and element3 into a separate <ng-content>.
@returnsComponentRef<C>
Jump to details