<cfimport>

The tag import has multiple purposes:

Import components with the attribute path
Import Java classes (Lucee 6.2+) with the attribute path or its alias java
Import CFML/JSP custom tags with the attributes prefix and taglib

In script syntax, you can use:

cfimport(path="org.lucee.example.MyCFC");
import org.lucee.example.MyCFC;
import "org.lucee.example.MyCFC";

For importing multiple components, use the wildcard syntax:

import "org.lucee.example.*";

For Java classes (Lucee 6.2+), the classpath is shared between components and Java classes.

By default, Lucee first looks for cfml components and then for Java classes if not found.

Optionally, you can explicitly specify the type:

import java:java.util.HashMap;
import cfml:org.lucee.cfml.Query;

Note: Imports only affect the current template, not the entire request.

Reference: Import

This tag cannot have a body.

This tag is also supported within <cfscript>


		<cfimport
    taglib=string
    prefix=string
    path=string
>

Attribute Description

Attribute	Description
taglib _{string, optional}	Path to a custom tag library or a JSP tag library descriptor (TLD). As cfimport is a compiler directive, `Application.cfc` mappings won't work, but mappings configured via the admin will. Used in conjunction with the `prefix` attribute to import custom tags: <cfimport prefix="my" taglib="/path/to/tags/"> In script: cfimport(prefix="my", taglib="/path/to/tags/");
prefix _{string, optional}	Prefix by which to access the imported custom CFML or JSP tags. If you import a CFML custom tag directory and specify an empty value, "", for this attribute, you can call the custom tags without using a prefix. You must specify and use a prefix for a JSP tag library. Example usage after import: <my:customTag attribute="value">
path _{string, optional}	Path of components or Java classes to be imported. For components: Import a specific component: `path="org.lucee.example.MyCFC"` Import all components in a package: `path="org.lucee.example.*"` For Java classes (Lucee 6.2+): Standard import: `path="java.util.HashMap"` Type-specific import: `path="java:java.util.HashMap"` (optional) By default, Lucee uses a single classpath that includes both components and Java classes. When there's a naming conflict, Lucee first searches for a component, then for a Java class if the component is not found. Specifying the type prefix (`java:` or `cfml:`) is optional but helpful to resolve ambiguities. In script syntax, the keyword `import` can be used as an alternative: import org.lucee.example.MyCFC; Note: The `java` attribute is an alias for `path` when importing Java classes. _{Alias: java}

taglib

_{string, optional}

Path to a custom tag library or a JSP tag library descriptor (TLD).

As cfimport is a compiler directive, Application.cfc mappings won't work, but mappings configured via the admin will.

Used in conjunction with the prefix attribute to import custom tags:

<cfimport prefix="my" taglib="/path/to/tags/">

In script:

cfimport(prefix="my", taglib="/path/to/tags/");

prefix

_{string, optional}

Prefix by which to access the imported custom CFML or JSP tags.

If you import a CFML custom tag directory and specify an empty value, "", for this attribute, you can call the custom tags without using a prefix.

You must specify and use a prefix for a JSP tag library.

Example usage after import:

<my:customTag attribute="value">

path

_{string, optional}

Path of components or Java classes to be imported.

For components:

Import a specific component: path="org.lucee.example.MyCFC"
Import all components in a package: path="org.lucee.example.*"

For Java classes (Lucee 6.2+):

Standard import: path="java.util.HashMap"
Type-specific import: path="java:java.util.HashMap" (optional)

By default, Lucee uses a single classpath that includes both components and Java classes.

When there's a naming conflict, Lucee first searches for a component, then for a Java class if the component is not found.

Specifying the type prefix (java: or cfml:) is optional but helpful to resolve ambiguities.

In script syntax, the keyword import can be used as an alternative:

import org.lucee.example.MyCFC;

Note: The java attribute is an alias for path when importing Java classes.

_{Alias:
java}

Examples

Format for cfimport

<cfimport taglib="lib" prefix="t">

<cfimport>

Examples

Format for cfimport

See also