We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
Uses of Class
com.vaadin.flow.server.frontend.Options
Packages that use Options
-
Uses of Options in com.vaadin.flow.server.frontend
Fields in com.vaadin.flow.server.frontend declared as OptionsMethods in com.vaadin.flow.server.frontend that return OptionsModifier and TypeMethodDescriptionOptions.copyLocalResources(File localResourcesFolder) Set local frontend files to be copied from given folder.
Options.copyResources(Set<File> jars) Sets whether copy resources from classpath to the appropriate npm package folder so as they are available for webpack build.
Options.createMissingPackageJson(boolean create) Sets whether to create the package file if missing.
Options.enableImportsUpdate(boolean enableImportsUpdate) Sets whether to enable imports file update.
Options.enableNpmFileCleaning(boolean forceClean) Deprecated.
Options.enablePackagesUpdate(boolean enablePackagesUpdate) Sets whether to enable packages and webpack file updates.
Options.populateTokenFileData(elemental.json.JsonObject object) Fill token file data into the provided
object.Options.setJavaResourceFolder(File javaResourceFolder) Set the java resources folder to be checked for feature file.
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.skipDevBundleBuild(boolean skip) Set to true to skip dev bundle build in case a dev bundle exists.
Options.useByteCodeScanner(boolean byteCodeScanner) Sets frontend scanner strategy: byte code scanning strategy is used if
byteCodeScanneristrue, full classpath scanner strategy is used otherwise (by default).Options.useGlobalPnpm(boolean useGlobalPnpm) Uses globally installed pnpm tool for frontend packages installation.
Options.withBuildDirectory(String buildDirectory) Use the specified directory name (inside the project folder) for the build output.
Options.withBundleBuild(boolean bundleBuild) Whether to run bundle build.
Options.withCiBuild(boolean ciBuild) Enables ci build.
Options.withCopyTemplates(boolean copyTemplates) Sets whether copy templates to
META-INF/VAADIN/config/templates.Options.withEmbeddableWebComponents(boolean generateEmbeddableWebComponents) Sets whether to collect and package
WebComponentExporterdependencies.Options.withEnablePnpm(boolean enable) Enables pnpm tool.
Options.withFeatureFlags(FeatureFlags featureFlags) Options.withForceProductionBuild(boolean forceProductionBuild) Setting this to
truewill force a build of the production build even if there is a default production bundle that could be used.Options.withFrontendDirectory(File frontendDirectory) Sets the directory containing the project's frontend files
Options.withFrontendGeneratedFolder(File frontendGeneratedFolder) Set the folder where frontend files should be generated.
Options.withFrontendHotdeploy(boolean frontendHotdeploy) Whether to run with a dev server (when not in production mode).
Options.withHomeNodeExecRequired(boolean requireHomeNodeExec) Requires node executable to be installed in vaadin home folder.
Options.withJarFrontendResourcesFolder(File jarFrontendResourcesFolder) Sets the appropriate npm package folder for copying flow resources in jars.
Options.withNodeDownloadRoot(URI nodeDownloadRoot) Sets the download node.js URL.
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.withPostinstallPackages(List<String> postinstallPackages) Sets the additional npm packages to run
postinstallfor.Options.withProductionMode(boolean productionMode) Sets the production mode.
Options.withRunNpmInstall(boolean runNpmInstall) Sets whether run
npm installafter updating dependencies.Options.withTokenFile(File tokenFile) Sets the token file (flow-build-info.json) path.
Options.withWebpack(File webappResourcesDirectory, File resourceOutputDirectory) Sets the webpack related properties.
Methods in com.vaadin.flow.server.frontend with parameters of type OptionsModifier and TypeMethodDescriptionstatic voidBundleUtils.copyPackageLockFromBundle(Options options) Copy package-lock.json/.yaml file from existing dev-bundle for building new bundle.
EndpointGeneratorTaskFactory.createTaskGenerateEndpoint(Options options) Create a task for generating TS files based.
EndpointGeneratorTaskFactory.createTaskGenerateOpenAPI(Options options) Create a task for generating OpenAPI spec.
static booleanBundleValidationUtil.frontendImportsFound(elemental.json.JsonObject statsJson, Options options, ClassFinder finder, FrontendDependenciesScanner frontendDependencies) static elemental.json.JsonObjectBundleValidationUtil.getDefaultPackageJson(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder, elemental.json.JsonObject packageJson) static elemental.json.JsonObjectBundleValidationUtil.getPackageJson(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder) Get the package.json file from disk if available else generate in memory.
static booleanBundleValidationUtil.needsBuild(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder, Mode mode) Checks if an application needs a new frontend bundle.
static booleanThemeValidationUtil.themeConfigurationChanged(Options options, elemental.json.JsonObject statsJson, FrontendDependenciesScanner frontendDependencies, ClassFinder finder) Constructors in com.vaadin.flow.server.frontend with parameters of type OptionsModifierConstructorDescriptionGenerateMainImports(ClassFinder classFinder, FrontendDependenciesScanner frontendDepScanner, Options options, elemental.json.JsonObject statsJson) Initialize tasks with the given options.
protectedNodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, Options options) Constructor.
TaskInstallFrontendBuildPlugins(Options options) Copy Flow webpack plugins into
PLUGIN_TARGETunder the build directory.TaskPrepareProdBundle(Options options)