Uses of Class
com.vaadin.flow.server.frontend.Options

Packages that use Options

Package	Description
com.vaadin.flow.server.frontend
com.vaadin.flow.server.frontend.scanner

Uses of Options in com.vaadin.flow.server.frontend

Fields in com.vaadin.flow.server.frontend declared as Options

Modifier and Type	Field	Description
protected Options	NodeUpdater.options

Methods in com.vaadin.flow.server.frontend that return Options

Modifier and Type	Method	Description
Options	Options.copyLocalResources(File localResourcesFolder)	Set local frontend files to be copied from given folder.
Options	Options.copyResources(Set<File> jars)	Sets whether copy resources from classpath to the appropriate npm package folder so as they are available for frontend build.
Options	Options.createMissingPackageJson(boolean create)	Sets whether to create the package file if missing.
Options	Options.enableImportsUpdate(boolean enableImportsUpdate)	Sets whether to enable imports file update.
Options	Options.enableNpmFileCleaning(boolean forceClean)	Deprecated.
Options	Options.enablePackagesUpdate(boolean enablePackagesUpdate)	Sets whether to enable packages and frontend file updates.
Options	Options.populateTokenFileData(com.fasterxml.jackson.databind.JsonNode object)	Fill token file data into the provided object.
Options	Options.setCopyAssets(boolean copyAssets)	Sets whether to copy npm assets or not.
Options	Options.setJavaResourceFolder(File javaResourceFolder)	Set the java resources folder to be checked for feature file.
Options	Options.setNodeAutoUpdate(boolean update)	Sets whether it is fine to automatically update the alternate node installation if installed version is older than the current default.
Options	Options.skipDevBundleBuild(boolean skip)	Set to true to skip dev bundle build in case a dev bundle exists.
Options	Options.useByteCodeScanner(boolean byteCodeScanner)	Sets frontend scanner strategy: byte code scanning strategy is used if byteCodeScanner is true, full classpath scanner strategy is used otherwise (by default).
Options	Options.useGlobalPnpm(boolean useGlobalPnpm)	Uses globally installed pnpm tool for frontend packages installation.
Options	Options.withBuildDirectory(String buildDirectory)	Use the specified directory name (inside the project folder) for the build output.
Options	Options.withBuildResultFolders(File webappResourcesDirectory, File resourceOutputDirectory)	Sets the folders where frontend build results should be stored.
Options	Options.withBundleBuild(boolean bundleBuild)	Whether to run bundle build.
Options	Options.withCiBuild(boolean ciBuild)	Enables ci build.
Options	Options.withCleanOldGeneratedFiles(boolean clean)	Sets whether generated files from a previous execution that are no more created should be removed.
Options	Options.withCommercialBanner(boolean enableCommercialBanner)	Sets whether the build could generate an application with a commercial banner.
Options	Options.withCompressBundle(boolean compressBundle)	Set to false to skip frontend bundle compression.
Options	Options.withCopyTemplates(boolean copyTemplates)	Sets whether copy templates to META-INF/VAADIN/config/templates.
Options	Options.withEmbeddableWebComponents(boolean generateEmbeddableWebComponents)	Sets whether to collect and package WebComponentExporter dependencies.
Options	Options.withEnableBun(boolean enable)	Enables bun tool.
Options	Options.withEnablePnpm(boolean enable)	Enables pnpm tool.
Options	Options.withFeatureFlags(FeatureFlags featureFlags)
Options	Options.withForceProductionBuild(boolean forceProductionBuild)	Setting this to true will force a build of the production build even if there is a default production bundle that could be used.
Options	Options.withFrontendDependenciesScanner(FrontendDependenciesScanner frontendDependenciesScanner)	Sets the frontend dependencies scanner to use.
Options	Options.withFrontendDirectory(File frontendDirectory)	Sets the directory containing the project's frontend files
Options	Options.withFrontendExtraFileExtensions(List<String> frontendExtraFileExtensions)	Sets the extra file extensions used in the project.
Options	Options.withFrontendGeneratedFolder(File frontendGeneratedFolder)	Set the folder where frontend files should be generated.
Options	Options.withFrontendHotdeploy(boolean frontendHotdeploy)	Whether to run with a dev server (when not in production mode).
Options	Options.withFrontendIgnoreVersionChecks(boolean frontendIgnoreVersionChecks)	Whether to ignore node/npm tool version checks or not.
Options	Options.withHomeNodeExecRequired(boolean requireHomeNodeExec)	Requires node executable to be installed in vaadin home folder.
Options	Options.withJarFrontendResourcesFolder(File jarFrontendResourcesFolder)	Sets the appropriate npm package folder for copying flow resources in jars.
Options	Options.withNodeDownloadRoot(URI nodeDownloadRoot)	Sets the download node.js URL.
Options	Options.withNodeVersion(String nodeVersion)	Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example "v16.0.0".
Options	Options.withNpmExcludeWebComponents(boolean exclude)	Sets whether to exclude web component npm packages in packages.json.
Options	Options.withPostinstallPackages(List<String> postinstallPackages)	Sets the additional npm packages to run postinstall for.
Options	Options.withProductionMode(boolean productionMode)	Sets the production mode.
Options	Options.withReact(boolean reactEnable)
Options	Options.withRunNpmInstall(boolean runNpmInstall)	Sets whether run npm install after updating dependencies.
Options	Options.withTokenFile(File tokenFile)	Sets the token file (flow-build-info.json) path.
Options	Options.withWebpack(File webappResourcesDirectory, File resourceOutputDirectory)	Deprecated, for removal: This API element is subject to removal in a future version. to be removed, use withBuildResultFolders(File, File) instead.

Methods in com.vaadin.flow.server.frontend with parameters of type Options

Modifier and Type	Method	Description
static void	BundleUtils.copyPackageLockFromBundle(Options options)	Copy package-lock.json/.yaml file from existing dev-bundle for building new bundle.
TaskGenerateEndpoint	EndpointGeneratorTaskFactory.createTaskGenerateEndpoint(Options options)	Create a task for generating TS files based.
TaskGenerateOpenAPI	EndpointGeneratorTaskFactory.createTaskGenerateOpenAPI(Options options)	Create a task for generating OpenAPI spec.
static boolean	BundleValidationUtil.frontendImportsFound(com.fasterxml.jackson.databind.JsonNode statsJson, Options options, FrontendDependenciesScanner frontendDependencies)
static com.fasterxml.jackson.databind.JsonNode	BundleValidationUtil.getDefaultPackageJson(Options options, FrontendDependenciesScanner frontendDependencies, com.fasterxml.jackson.databind.node.ObjectNode packageJson)
static com.fasterxml.jackson.databind.JsonNode	BundleValidationUtil.getPackageJson(Options options, FrontendDependenciesScanner frontendDependencies)	Get the package.json file from disk if available else generate in memory.
static boolean	FrontendUtils.isReactModuleAvailable(Options options)	Is the React module available in the classpath.
default void	TypeScriptBootstrapModifier.modify(List<String> bootstrapTypeScript, Options options, FrontendDependenciesScanner frontendDependenciesScanner)	Modifies the bootstrap typescript by mutating the parameter.
static boolean	BundleValidationUtil.needsBuild(Options options, FrontendDependenciesScanner frontendDependencies, Mode mode)	Checks if an application needs a new frontend bundle.
static boolean	ThemeValidationUtil.themeConfigurationChanged(Options options, com.fasterxml.jackson.databind.JsonNode statsJson, FrontendDependenciesScanner frontendDependencies)
static boolean	ThemeValidationUtil.themeShadowDOMStylesheetsChanged(Options options, com.fasterxml.jackson.databind.JsonNode statsJson, FrontendDependenciesScanner frontendDependencies)	Checks if theme has legacy Shadow DOM stylesheets in <theme>/components folder and if their content has changed.
static void	TaskGenerateReactFiles.writeLayouts(Options options, Collection<Class<?>> layoutsClasses)	Writes the `layout.json` file in the frontend generated folder.

Constructors in com.vaadin.flow.server.frontend with parameters of type Options

Modifier	Constructor	Description
	GenerateMainImports(FrontendDependenciesScanner frontendDepScanner, Options options, com.fasterxml.jackson.databind.JsonNode statsJson)
	NodeTasks(Options options)	Initialize tasks with the given options.
protected	NodeUpdater(FrontendDependenciesScanner frontendDependencies, Options options)	Constructor.
	TaskCleanFrontendFiles(Options options)	Scans the jar files given defined by resourcesToScan.
	TaskGeneratePWAIcons(Options options, PwaConfiguration pwaConfiguration)
	TaskInstallFrontendBuildPlugins(Options options)	Copy Flow webpack plugins into PLUGIN_TARGET under the build directory.
	TaskPrepareProdBundle(Options options)
	TaskRemoveOldFrontendGeneratedFiles(Options options)

Uses of Options in com.vaadin.flow.server.frontend.scanner

Methods in com.vaadin.flow.server.frontend.scanner with parameters of type Options

Modifier and Type	Method	Description
FrontendDependenciesScanner	FrontendDependenciesScanner.FrontendDependenciesScannerFactory.createScanner(Options options)	Deprecated. Use FrontendDependenciesScanner.FrontendDependenciesScannerFactory.createScanner(boolean, ClassFinder, boolean, FeatureFlags, boolean) instead.