template generate lightning component

Generate a bundle for an Aura component or a Lightning web component.

Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name. Lightning web components are contained in the directory with name “lwc”, Aura components in “aura”.

To generate a Lightning web component, pass “–type lwc” to the command. If you don’t specify –type, Salesforce CLI generates an Aura component by default.

force:lightning:component:create

lightning:generate:component

Flag Name (Long)Flag Name (Short)Description
‑‑api‑versionN/AType: Value

Override the api version used for api requests made by this command
‑‑flags‑dirN/AType: Value

Import flag values from a directory.
‑‑jsonN/AType: Boolean

Format output as json.
‑‑name‑nType: Value
Required

Name of the generated Lightning Component.

The name can be up to 40 characters and must start with a letter.
‑‑output‑dir‑dType: Value
Default value: .

Directory for saving the created files.

The location can be an absolute path or relative to the current working directory. The default is the current directory.
‑‑template‑tType: Value
Valid Values: default, analyticsDashboard, analyticsDashboardWithStep, typescript
Default value: default

Template to use for file creation.

Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn’t specified, the CLI command automatically selects the template based on the “defaultLwcLanguage” field in the DX project’s “sfdx-project.json” file.
‑‑typeN/AType: Value
Valid Values: aura, lwc
Default value: aura

Type of the component bundle.

Generate the metadata files for an Aura component bundle in the current directory:

Generate a Lightning web component bundle in the current directory:

Generate an Aura component bundle in the “force-app/main/default/aura” directory:

Generate a Lightning web component bundle in the “force-app/main/default/lwc” directory:

Generate a TypeScript Lightning Web Component: