generate library
ng generate library
ng generate lib
Creates a new library project in your Angular workspace. Libraries are reusable collections of components, services, and other Angular artifacts that can be shared across multiple applications. This schematic simplifies the process of generating a new library with the necessary files and configurations.
Arguments
name
The name for the new library. This name will be used for the project directory and various identifiers within the library's code.
string
Options
entry-file
The path to the library's public API file, relative to the workspace root. This file defines what parts of the library are accessible to applications that import it.
string
Defaultpublic-api
prefix
p
A prefix to be added to the selectors of components generated within this library. For example, if the prefix is my-lib
and you generate a component named my-component
, the selector will be my-lib-my-component
.
string
Defaultlib
project-root
The root directory for the new library, relative to the workspace root. If not specified, the library will be created in a subfolder within the projects
directory, using the library's name.
string
skip-install
Skip the automatic installation of packages. You will need to manually install the dependencies later.
boolean
Defaultfalse
skip-package-json
Do not automatically add dependencies to the package.json
file.
boolean
Defaultfalse
skip-ts-config
Do not update the workspace tsconfig.json
file to add a path mapping for the new library. The path mapping is needed to use the library in an application, but can be disabled here to simplify development.
boolean
Defaultfalse
standalone
Create a library that utilizes the standalone API, eliminating the need for NgModules. This can simplify the structure of your library and its usage in applications.
boolean
Defaulttrue