https://github.com/bluecadet/timber-fractal-paths

Use Fractal with Timber in WordPress
https://github.com/bluecadet/timber-fractal-paths

Last synced: 4 days ago
JSON representation

Use Fractal with Timber in WordPress

• Host: GitHub
• URL: https://github.com/bluecadet/timber-fractal-paths
• Owner: bluecadet
• Created: 2019-09-19T21:41:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-14T15:11:12.000Z (over 1 year ago)
• Last Synced: 2024-11-07T05:44:30.974Z (13 days ago)
• Language: PHP
• Size: 10.7 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# timber-fractal-paths

Custom loader that allows Fractal paths to reroute to Fractal files.

## Fractal

Your [Fractal](https://fractal.build/) build should use a [twig

engine](https://github.com/frctl/twig). You can then call your fractal patterns as is

typical of Fractal:

```

{% include

  '@patterns/components/awesome-pattern' with {

    data: {

      title: 'Hi',

      content: 'Am content'

    }

  }

%}

{% include

  '@patterns/components/cool-patterns/real-cool-pattern' with {

    data: {

      title: 'Hi',

      content: 'Am content'

    }

  }

%}

```

The loader will attempt to load a `.twig` file matching the parent folders name, which is

the last item in the include path. This

assumes that you have the following file structure (given the above example):

```

THEME_DIR

- fractal

  - patterns

    - awesome-pattern

      - awesome-pattern.twig

    - cool-patterns

      - really-cool-pattern

        - really-cool-pattern.twig

```

`@patterns` is the default namespace used in this plugin, but `@components` is typical for Fractal.

## Configuration

Namespace defaults to '@patterns'. Define `FRACTAL_HANDLE` in your theme to change the

handle (DO NOT use @ in the definition, i.e. 'patterns' _not_ '@patterns').

```

define('FRACTAL_HANDLE', 'patterns' );

```

Path defaults to 'THEME_PATH/fractal/patterns' (`get_stylesheet_directory() . '/fractal/patterns'`). Define `FRACTAL_PATH` in your theme to change the

handle (DO NOT use @ in the definition, i.e. 'patterns' _not_ '@patterns').

```

define('FRACTAL_PATH', get_stylesheet_directory() . '/fractal/patterns' );

```

## Want to add other Custom Loaders?

The `timber_fractal_paths/loaders` provides and array of loaders before they are pushed

into the custom chain loader. Create your loader, add it to the array, and return it.

```

add_filter('timber_fractal_paths/loaders', function($loaders) {

  $loaders[] = new SomeCustomLoaderClass($paths);

  return $loaders;

}));

```

---------------------

The scaffolding of this plugin came from [weareindi/timber-custom-loader](https://github.com/weareindi/timber-custom-loader)