CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Class

ComponentFactory (ui)

@ckeditor/ckeditor5-ui/src/componentfactory

class
See source

A helper class implementing the UI component (view) factory.

It allows functions producing specific UI components to be registered under their unique names in the factory. A registered component can be then instantiated by providing its name. Note that names are case insensitive.

// The editor provides localization tools for the factory.
const factory = new ComponentFactory( editor );

factory.add( 'foo', locale => new FooView( locale ) );
factory.add( 'bar', locale => new BarView( locale ) );

// An instance of FooView.
const fooInstance = factory.create( 'foo' );

// Names are case insensitive so this is also allowed:
const barInstance = factory.create( 'Bar' );

The editor locale is passed to the factory function when create is called.

Filtering

Properties

  • editor : Editor

    readonly

    The editor instance that the factory belongs to.

    See source

  • _components : Map

    private

    Registered component factories.

    See source

Methods

  • constructor( editor )

    Creates an instance of the factory.

    See source

    Parameters

    editor : Editor

    The editor instance.

  • add( name, callback )

    Registers a component factory function that will be used by the create method and called with the editor locale as an argument, allowing localization of the view.

    See source

    Parameters

    name : String

    The name of the component.

    callback : function

    The callback that returns the component.

  • create( name ) → View

    Creates an instance of a component registered in the factory under a specific name.

    See source

    When called, the editor locale is passed to the previously added factory function, allowing localization of the view.

    Parameters

    name : String

    The name of the component.

    Returns

    View

    The instantiated component view.

  • has( name ) → Boolean

    Checks if a component of a given name is registered in the factory.

    See source

    Parameters

    name : String

    The name of the component.

    Returns

    Boolean

  • names() → Iterable.<String>

    Returns an iterator of registered component names. Names are returned in lower case.

    See source

    Returns

    Iterable.<String>