Codux
Codux configuration file
| Type | object |
|---|---|
| File match |
codux.config.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/codux/latest.json |
| Source | https://wixplosives.github.io/codux-config-schema/codux.config.schema.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Add Panel config. Can contain list of libraries installed in the project which provide boards for Codux.
1 nested properties
Configures how SVG assets load. Refer to https://help.codux.com/kb/en/article/kb17934 for more information.
Default directory for new boards, relative to the project root. Refer to https://help.codux.com/kb/en/article/kb19337 for more information.
Configures default path for board template folders and files.
2 nested properties
Path where project templates are stored.
Defines a configuration object for templates. This configuration allows specifying default directories for entities created using these templates. Each template can have a custom configuration.
Maximum time (in milliseconds) to postpone capturing a thumbnail for the board. Refer to https://help.codux.com/kb/en/article/kb20920 for more information.
Configures scripts for project users to run from Codux (triggerable and on demand). Refer to https://help.codux.com/kb/en/article/kb30920 for more information.
Path to a file that will be evaluated before each board is rendered, Useful for importing global stylesheets and initializing global variables. Can be absolute or relative to the project root (in which case it needs to start with './') Refer to https://help.codux.com/kb/en/article/kb36623 for more information.
Specifies environment variables to use globally across the project. Refer to https://help.codux.com/kb/en/article/kb37722 for more information.
2 nested properties
variables that are being accessed from process.env
variables that are being accessed from process.env from an env file
The relative path to the folder from which static files are served. Refer to https://help.codux.com/kb/en/article/kb23123 for more information.
Enables CSS modules in your project. Refer to https://help.codux.com/kb/en/article/kb25813 for more information.
2 nested properties
Enables or disables the use of CSS modules.
The extension types for files to load as modules.
Configures maximum rendered elements. Refer to https://help.codux.com/kb/en/article/kb18414 for more information.
1 nested properties
If the project uses
Configures the default file path to add new fonts to.
Port of HTTP server that is used to serve previews and user project itself.
Configuration for adding additional json schemas to your project. This can be used to centralise json schemas addition instead of using $schema and get autocompletion for json files when using Codux.
Configures the default directory where the Codux Media Manager stores new assets. Refer to https://help.codux.com/kb/en/article/kb96140 for more information.
Configures default paths for new component and template files. Refer to https://help.codux.com/kb/en/article/kb16522 for more information.
3 nested properties
Path where project templates are stored.
Defines a configuration object for templates. This configuration allows specifying default directories for entities created using these templates. Each template can have a custom configuration.
Path where new components and related files will save to.
Specifies project folders to exclude from component search. Refer to https://help.codux.com/kb/en/article/kb14730 for more information.
Configures file-naming convention for new component creation. Refer to https://help.codux.com/kb/en/article/kb29627 for more information. Options: "pascal-case" | "camel-case" | "kebab-case"
Includes package assets from additional sources, and creates aliases and fallbacks. Refer to https://help.codux.com/kb/en/article/kb18719 for more information.
5 nested properties
Aliases for package requests. Record key is the request to be mapped, value is the new target. Alias is attempted before original request.
Fallback for package requests. Record key is the request to be mapped, value is the new target. Original request is attempted before fallback.
Folders to use when searching for packages.
Aliases for all package requests in a monorepo. Record key is the request to be mapped, value is the new target.
Conditions to set in addition to the resolver-specific defaults when resolving imports.
Adds Sass support to compilations. Refer to https://help.codux.com/kb/en/article/kb19315 for more information.
3 nested properties
Defines path and module extensions for Sass modules to include and/or ignore. Input as an array of glob patterns.
2 nested properties
Array of glob patterns to include.
Array of glob patterns to ignore.
Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.
Array of paths to resolve Sass files from.
Configures proxy servers for Codux to redirect requests to. The key is the path to proxy requests from, and the value is the url to proxy requests to. Refer to https://help.codux.com/kb/en/article/kb18137 for more information.
Disables sharing the project in the Codux Online Playground. Refer to https://help.codux.com/kb/en/article/kb02353 for more information.
Styling related configuration. Contains field for styling solution which determines the main styling solution in the user's project. Refer to https://help.codux.com/kb/en/article/kb31817 for more information.
1 nested properties
Default file extension to use for component style sheets in the project. Options: "css" | "sass" | "css modules" | "sass modules" | "scss" | "scss modules" | "stylable"
Formats code styling in the Codux code drawer. Refer to https://help.codux.com/kb/en/article/kb18018 for more information.
1 nested properties
An extended glob pattern that describes the common CSS files used in the project. The Style Panel will not suggest these files for adding new rules to an element or editing its style.
Options for using the classNames utility library, including path to classNames module, and target export. The default configuration is set for handling the 'classnames' library by JedWatson. Refer to https://help.codux.com/kb/en/article/kb36122 for more information.
2 nested properties
Configures the schema memory usage panel
1 nested properties
Lets you pass a custom tailwindcss config file path. Refer to https://help.codux.com/kb/en/article/kb18518 for more information.
Scopes component discovery in your project. Refer to https://help.codux.com/kb/en/article/kb37113 for more information.
2 nested properties
Array of glob patterns to include.
Array of glob patterns to exclude.
1 nested properties
2 nested properties
Definitions
Path where project templates are stored.
Script title in the UI. Will be available to use from Codux.
This is the command that the script runs when executed.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
The value of this parameter is an array of script objects to include in the batch.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Script title in the UI. Will be available to use from Codux.
Options for using the classNames utility library, including path to classNames module, and target export. The default configuration is set for handling the 'classnames' library by JedWatson. Refer to https://help.codux.com/kb/en/article/kb36122 for more information.