nx/docs/generated/packages/react/generators/component.json

{
  "name": "component",
  "factory": "./src/generators/component/component",
  "schema": {
    "$schema": "https://json-schema.org/schema",
    "cli": "nx",
    "$id": "NxReactComponent",
    "title": "Create a React Component",
    "description": "Create a React Component for Nx.",
    "type": "object",
    "properties": {
      "path": {
        "type": "string",
        "description": "The file path to the component. Relative to the current working directory.",
        "$default": { "$source": "argv", "index": 0 },
        "x-prompt": "What is the component file path?",
        "x-priority": "important"
      },
      "name": {
        "type": "string",
        "description": "The component symbol name. Defaults to the last segment of the file path."
      },
      "style": {
        "description": "The file extension to be used for style files.",
        "type": "string",
        "alias": "s",
        "default": "css",
        "x-prompt": {
          "message": "Which stylesheet format would you like to use?",
          "type": "list",
          "items": [
            { "value": "css", "label": "CSS" },
            {
              "value": "scss",
              "label": "SASS(.scss)       [ https://sass-lang.com          ]"
            },
            {
              "value": "less",
              "label": "LESS              [ https://lesscss.org            ]"
            },
            {
              "value": "tailwind",
              "label": "tailwind          [ https://tailwindcss.com/       ]"
            },
            {
              "value": "styled-components",
              "label": "styled-components [ https://styled-components.com ]"
            },
            {
              "value": "@emotion/styled",
              "label": "emotion           [ https://emotion.sh            ]"
            },
            {
              "value": "styled-jsx",
              "label": "styled-jsx        [ https://www.npmjs.com/package/styled-jsx ]"
            },
            { "value": "none", "label": "None" }
          ]
        }
      },
      "js": {
        "type": "boolean",
        "description": "Generate JavaScript files rather than TypeScript files.",
        "x-deprecated": "Provide the full file path including the file extension in the `path` option. This option will be removed in Nx v21."
      },
      "skipTests": {
        "type": "boolean",
        "description": "When true, does not create `spec.ts` test files for the new component.",
        "default": false,
        "x-priority": "internal"
      },
      "export": {
        "type": "boolean",
        "description": "When true, the component is exported from the project `index.ts` (if it exists).",
        "alias": "e",
        "default": false,
        "x-prompt": "Should this component be exported in the project?"
      },
      "classComponent": {
        "type": "boolean",
        "alias": "C",
        "description": "Use class components instead of functional component.",
        "default": false
      },
      "routing": {
        "type": "boolean",
        "description": "Generate a library with routes."
      },
      "globalCss": {
        "type": "boolean",
        "description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
        "default": false
      },
      "inSourceTests": {
        "type": "boolean",
        "default": false,
        "description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html"
      },
      "skipFormat": {
        "description": "Skip formatting files.",
        "type": "boolean",
        "default": false,
        "x-priority": "internal"
      }
    },
    "required": ["path"],
    "examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Simple Component\" %}\n\nCreate a component named `MyComponent` at `libs/ui/src/my-component.tsx`:\n\n```shell\nnx g @nx/react:component libs/ui/src/my-component.tsx\n```\n\n{% /tab %}\n\n{% tab label=\"With a Different Symbol Name\" %}\n\nCreate a component named `Custom` at `libs/ui/src/my-component.tsx`:\n\n```shell\nnx g @nx/react:component libs/ui/src/my-component.tsx --name=custom\n```\n\n{% /tab %}\n\n{% tab label=\"Omitting the File Extension\" %}\n\nCreate a component named `MyComponent` at `libs/ui/src/my-component.tsx` without specifying the file extension:\n\n```shell\nnx g @nx/react:component libs/ui/src/my-component\n```\n\n{% /tab %}\n\n{% tab label=\"Class Component\" %}\n\nCreate a class component named `MyComponent` at `libs/ui/src/my-component.tsx`:\n\n```shell\nnx g @nx/react:component libs/ui/src/my-component --classComponent\n```\n\n{% /tab %}\n",
    "presets": []
  },
  "description": "Create a React component.",
  "aliases": ["c"],
  "implementation": "/packages/react/src/generators/component/component.ts",
  "hidden": false,
  "path": "/packages/react/src/generators/component/schema.json",
  "type": "generator"
}