Skip to content

Add programmatic token to automate editing browser.html #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gregturn wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add programmatic token to automate editing browser.html #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 54 additions & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,62 @@ HAL.customPostForm = CustomPostForm;
</script>
----

NOTE: To load a custom JavaScript module AND a custom HTML template, you will probably need to create a customized version of `browser.html`.

NOTE: The HAL Browser uses a global `HAL` object, so there is no need to deal with JavaScript packages.

=== Hooking in custom code

To load a custom JavaScript module AND a custom HTML template, you will probably need to create a customized version of `browser.html`. Manually editing the file might be good enough. Just look for the comment at the end of `browser.html`.

But if you need something a little more sophisticated, like hooking into your build system, you can do a token search like this:

[source,xml]
----
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<copy todir="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser">
<fileset dir="${project.build.directory}/hal-browser/META-INF/resources/webjars/hal-browser/${browser.version}" />
</copy>
<copy todir="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser/vendor/js">
<fileset dir="${project.build.directory}/json-editor/META-INF/resources/webjars/json-editor/${json-editor.version}" />
</copy>
<copy file="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser/browser.html"
tofile="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser/index.html" />
<replace file="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser/index.html">
<replacefilter>
<replacetoken>&lt;!-- Need to plugin some custom code? Put it here. --&gt;</replacetoken>
<replacevalue>

&lt;!-- Spring Data REST's plugin --&gt;

&lt;script src="vendor/js/jsoneditor.js" /&gt;
&lt;script src="js/CustomPostForm.js" /&gt;

&lt;/body&gt;</replacevalue>
</replacefilter>
</replace>
<delete file="${project.build.outputDirectory}/META-INF/spring-data-rest/hal-browser/browser.html" />
</target>
</configuration>
</execution>
</executions>
</plugin>
----

This is code from http://projects.spring.io/spring-data-rest/[Spring Data REST]

* The HAL Browser and the JSON Editor are both unpacked from WebJars
* Key files are copied into the target artifacts.
* The custom editor (driven by Spring Data REST's metadata) are then swapped in with a <<Customizing the POST form,custom form>>.

== Usage Instructions

All you should need to do is copy the files into your webroot.
Expand Down
2 changes: 2 additions & 0 deletions browser.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,8 @@ <h2>Embedded Resources</h2>

<script src="js/hal/views/documentation.js"></script>

<!-- Need to plugin some custom code? Put it here. -->

<script>
var browser = new HAL.Browser({
container: $('#browser'),
Expand Down