@tanstack/router-plugin
Version:
Modern and scalable routing for React applications
134 lines (133 loc) • 4.91 kB
TypeScript
import { configSchema, Config } from './core/config.js';
/**
* @example
* ```ts
* export default defineConfig({
* plugins: [TanStackRouterGeneratorVite()],
* // ...
* })
* ```
*/
declare const TanStackRouterGeneratorVite: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
generatedRouteTree: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableTypes: boolean;
addExtensions: boolean;
disableLogging: boolean;
disableManifestGeneration: boolean;
enableRouteTreeFormatting: boolean;
apiBase: string;
routeTreeFileHeader: string[];
routeTreeFileFooter: string[];
indexToken: string;
routeToken: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.js').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
__enableAPIRoutesGeneration?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
apiTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
}> | undefined) => import('vite').Plugin<any> | import('vite').Plugin<any>[];
/**
* @example
* ```ts
* export default defineConfig({
* plugins: [TanStackRouterCodeSplitterVite()],
* // ...
* })
* ```
*/
declare const TanStackRouterCodeSplitterVite: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
generatedRouteTree: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableTypes: boolean;
addExtensions: boolean;
disableLogging: boolean;
disableManifestGeneration: boolean;
enableRouteTreeFormatting: boolean;
apiBase: string;
routeTreeFileHeader: string[];
routeTreeFileFooter: string[];
indexToken: string;
routeToken: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.js').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
__enableAPIRoutesGeneration?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
apiTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
}> | undefined) => import('vite').Plugin<any> | import('vite').Plugin<any>[];
/**
* @example
* ```ts
* export default defineConfig({
* plugins: [TanStackRouterVite()],
* // ...
* })
* ```
*/
declare const TanStackRouterVite: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
generatedRouteTree: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableTypes: boolean;
addExtensions: boolean;
disableLogging: boolean;
disableManifestGeneration: boolean;
enableRouteTreeFormatting: boolean;
apiBase: string;
routeTreeFileHeader: string[];
routeTreeFileFooter: string[];
indexToken: string;
routeToken: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.js').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
__enableAPIRoutesGeneration?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
apiTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
}> | undefined) => import('vite').Plugin<any> | import('vite').Plugin<any>[];
export default TanStackRouterVite;
export { configSchema, TanStackRouterGeneratorVite, TanStackRouterCodeSplitterVite, TanStackRouterVite, };
export type { Config };