Skip to content
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

#1158 allow full-row field templates in embedded view #1170

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

#1158 allow full-row field templates in embedded view #1170

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
5 changes: 5 additions & 0 deletions doc/Relationships.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,11 @@ When displaying a post:

![embedded_list in editionView](images/embedded_list_in_editionView.png)

Caution: If you want to use [`Field.template()`](./Theming.md#customizing-the-template-for-a-given-field)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is not clear to me. What do you mean? :)

Copy link
Contributor Author

@RichardBradley RichardBradley Nov 14, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs for the "Field.template()" config in Theming.md suggest using it with an "<ma-field>" tag with 6 "magic" attrs that must be quoted verbatim, i.e. (ignoring the "ng-if" here)

.template('<ma-field ng-if="entry.values.category" field="::field" value="entry.values[field.name()]" entry="entry" entity="::entity" form="formController.form" datastore="::formController.dataStore"></ma-field>', true)

Those 6 attrs expose the implementation details of ng-admin and they must be gotten exactly right for things to work. To make this even harder for users, the magic attrs that you must quote are different for "regular" fields to "embedded" fields.

Actually fixing this is out of scope here, but I thought users might benefit from a warning about this, in case they try to use "template()" on an embedded field with the recipe from "Theming.md" and can't figure out why it didn't work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right: we should think to fix this black magic. 👍

Can you add your explanation directly into the README?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd be happy to, but I'm not quite clear where you want this explanation. or what text you want in addition to what I've already put, sorry. Perhaps you should add an explanation that makes sense to you directly to the code? Or let me know in more detail what changes you had in mind, and I'll make them.

(Also perhaps this issue about template() would be better addressed on its own Issue thread, as it's separate from the problem in #1158)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(bump)

to customise the view of an embedded field, be aware that the default "<ma-field>" template string takes
different attribute values in embedded view to the regular view.
See the [maEmbeddedListField source](../src/javascripts/ng-admin/crud/field/maEmbeddedListField.js).

## Embedded entity

APIs may render a many-to-one relationship by embedding the related entry in the main entry:
Expand Down
2 changes: 1 addition & 1 deletion src/javascripts/ng-admin/Crud/field/maEmbeddedListField.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export default function maEmbeddedListField() {
<div class="remove_button_container">
<a class="btn btn-default btn-sm" ng-click="remove(entry)"><span class="glyphicon glyphicon-minus-sign" aria-hidden="true"></span>&nbsp;<span translate="REMOVE"></span></a>
</div>
<div class="form-field form-group" ng-repeat="field in ::fields track by $index">
<div ng-repeat="field in ::fields track by $index" compile="::field.getTemplateValueWithLabel(entry)">
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "form-field" and "form-group" classes here are redundant, since "ma-field" inside this div also creates a div with those classes. Having them repeated here interferes with hiding rows based on entity values.

<ma-field field="::field" value="entry.values[field.name()]" entry="entry" entity="::targetEntity" form="formName" datastore="::datastore()"></ma-field>
</div>
<hr/>
Expand Down