Documentation
Tutorials
Contributing Documentation For Developers
Test Results Test Coverage Github Repository Github Profile

Global

Methods

# Dynamic() → {function}

Decorator that registers an Angular component with the NgxRenderingEngine for dynamic loading. This decorator must be applied before the @Component decorator to properly extract component metadata. It adds metadata to the component class and registers it with the rendering engine using its selector.

Marks an Angular component as dynamically loadable

sequenceDiagram participant C as Component Class participant D as Dynamic Decorator participant R as NgxRenderingEngine participant M as Angular Metadata C->>D: Apply decorator D->>M: reflectComponentType() M-->>D: Return component metadata alt No metadata found D->>D: Throw InternalError else Metadata found D->>R: registerComponent(selector, constructor) D->>C: Apply metadata end

View Source lib/engine/decorators.ts, line 8

A decorator function that can be applied to Angular component classes

function

# async execute(command)

Executes a shell command asynchronously.

Executes a shell command asynchronously.

Parameters:
Name Type Description
command

The shell command to execute.

View Source cli-module.ts, line 88

A Promise that resolves with the command's stdout output as a string if successful, or rejects with an error message if the command fails or produces stderr output.

# getNgxInlineModal(inlineContent, propsopt, injectoropt) → {Promise.<void>}

Get modal component instance for show inline content

get modal with inline content instance.

Parameters:
Name Type Attributes Default Description
inlineContent string | SafeHtml

The content to display in the lightbox modal.
props Partial.<ModalComponent> <optional>
 {}

Properties to initialize the modal component.
injector EnvironmentInjector <optional>

Optional environment injector for dependency injection.

View Source lib/components/modal/modal.component.ts, line 366

  • A promise that resolves when the modal is presented.
Promise.<void>

# getNgxModalComponent(propsopt, modalPropsopt, injectoropt) → {Promise.<IonModal>}

Creates and initializes a modal component with the provided properties and options.

Retrieves a modal component instance.

Parameters:
Name Type Attributes Default Description
props Partial.<ModalComponent> <optional>
 {}

Properties to initialize the modal component.
modalProps Partial.<ModalOptions> <optional>
 {}

Additional modal options.
injector EnvironmentInjector <optional>

Optional environment injector for dependency injection.

View Source lib/components/modal/modal.component.ts, line 325

  • A promise that resolves with the modal instance.
Promise.<IonModal>

# getNgxSelectOptionsModal(options, injectoropt) → {Promise.<IonModal>}

Creates and initializes a modal component for displaying a list of selectable options.

Retrieves a modal for selecting options.

Parameters:
Name Type Attributes Description
options Array.<SelectOption>

The list of options to display in the modal.
injector EnvironmentInjector <optional>

Optional environment injector for dependency injection.

View Source lib/components/modal/modal.component.ts, line 377

  • A promise that resolves with the modal instance.
Promise.<IonModal>

# parseProjectName(value)

Parses and normalizes the project name input.

Parses and normalizes the project name input.

Parameters:
Name Type Description
value

The input project name to be parsed. Can be 'app', 'lib', or any other string value.

View Source cli-module.ts, line 106

A normalized string representation of the project name. Returns 'for-angular-app' if input is 'app', 'for-angular' if input is 'lib', or the lowercase version of the input for any other value.

# presentNgxInlineModal(inlineContent, propsopt, injectoropt) → {Promise.<void>}

Displays a modal with the specified content and properties.

Presents modal with inline content.

Parameters:
Name Type Attributes Default Description
inlineContent string | SafeHtml

The content to display in the modal.
props Partial.<ModalComponent> <optional>
 {}

Properties to initialize the modal component.
injector EnvironmentInjector <optional>

Optional environment injector for dependency injection.

View Source lib/components/modal/modal.component.ts, line 354

  • A promise that resolves when the modal is presented.
Promise.<void>

# presentNgxLightBoxModal(inlineContent, propsopt, injectoropt) → {Promise.<void>}

Displays a modal in lightbox mode with the specified content and properties.

Presents a lightbox modal with inline content.

Parameters:
Name Type Attributes Default Description
inlineContent string | SafeHtml

The content to display in the lightbox modal.
props Partial.<ModalComponent> <optional>
 {}

Properties to initialize the modal component.
injector EnvironmentInjector <optional>

Optional environment injector for dependency injection.

View Source lib/components/modal/modal.component.ts, line 342

  • A promise that resolves when the modal is presented.
Promise.<void>

# validateProject(value)

Validates if the given project value is a valid enum member of Projects.

Validates if the given project value is a valid enum member of Projects.

Parameters:
Name Type Description
value

The project value to validate.

View Source cli-module.ts, line 126

A boolean indicating whether the value is a valid Projects enum member.

# validateType(value)

Validates if the given type value is a valid enum member of Types.

Validates if the given type value is a valid enum member of Types.

Parameters:
Name Type Description
value

The type value to validate.

View Source cli-module.ts, line 117

A boolean indicating whether the value is a valid Types enum member.