All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.jknack.handlebars.helper.EmbeddedHelper Maven / Gradle / Ivy

There is a newer version: 2024.11.18751.20241128T090041Z-241100
Show newest version
/**
 * Copyright (c) 2012-2015 Edgar Espina
 *
 * This file is part of Handlebars.java.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.jknack.handlebars.helper;

import com.github.jknack.handlebars.io.TemplateSource;
import static org.apache.commons.lang3.Validate.notEmpty;
import java.io.IOException;
import com.github.jknack.handlebars.Handlebars;
import com.github.jknack.handlebars.Helper;
import com.github.jknack.handlebars.Options;

/**
 *  Given:
 *  home.hbs
 *
 *  
 *  <html>
 *  ...
 *  {{emdedded "user" ["id"]}}
 *  </html>
 *  
* * where user.hbs is: * *
 *  <tr>
 *  <td>{{firstName}}</td>
 *  <td>{{lastName}}</td>
 *  </tr>
 *  
* * expected output is: * *
 *  <script id="user-hbs" type="text/x-handlebars-template">
 *  <tr>
 *  <td>{{firstName}}</td>
 *  <td>{{lastName}}</td>
 *  </tr>
 *  </script>
 *  
* * Optionally, a user can set the template's name: * *
 *  {{emdedded "user" "user-tmpl" }}
 *  
* * expected output is: * *
 *  <script id="user-tmpl" type="text/x-handlebars-template">
 *  <tr>
 *  <td>{{firstName}}</td>
 *  <td>{{lastName}}</td>
 *  </tr>
 *  </script>
 *  
* * @author edgar.espina * @since 0.3.0 * * @deprecated com.github.jknack.handlebars.helper package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM. */ @Deprecated(since = "2024-07-10") public class EmbeddedHelper implements Helper { /** * A singleton instance of this helper. */ public static final Helper INSTANCE = new EmbeddedHelper(); /** * The helper's name. */ public static final String NAME = "embedded"; @Override public Object apply(final String path, final Options options) throws IOException { notEmpty(path, "found '%s', expected 'partial's name'", path); String suffix = options.handlebars.getLoader().getSuffix(); String defaultId = (path + suffix).replace('/', '-').replace('.', '-'); String id = options.param(0, defaultId); TemplateSource source = options.handlebars.getLoader().sourceAt(path); StringBuilder script = new StringBuilder(); script.append(""); return new Handlebars.SafeString(script); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy