template_loader - Django-Components" > template_loader - Django-Components" >
Skip to content

template_loader ¤

Template loader that loads templates from each Django app's "components" directory.

Classes:

Loader ¤

Bases: Loader

Methods:

  • get_dirs –

    Prepare directories that may contain component files:

get_dirs ¤

get_dirs(include_apps: bool = True) -> List[Path]

Prepare directories that may contain component files:

Searches for dirs set in COMPONENTS.dirs settings. If none set, defaults to searching for a "components" app. The dirs in COMPONENTS.dirs must be absolute paths.

In addition to that, also all apps are checked for [app]/components dirs.

Paths are accepted only if they resolve to a directory. E.g. /path/to/django_project/my_app/components/.

BASE_DIR setting is required.

Source code in src/django_components/template_loader.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def get_dirs(self, include_apps: bool = True) -> List[Path]:
    """
    Prepare directories that may contain component files:

    Searches for dirs set in `COMPONENTS.dirs` settings. If none set, defaults to searching
    for a "components" app. The dirs in `COMPONENTS.dirs` must be absolute paths.

    In addition to that, also all apps are checked for `[app]/components` dirs.

    Paths are accepted only if they resolve to a directory.
    E.g. `/path/to/django_project/my_app/components/`.

    `BASE_DIR` setting is required.
    """
    return get_component_dirs(include_apps)