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

fix: correct docs for contact-summary field appliesIf #1718

Merged
merged 1 commit into from
Nov 20, 2024
+1 −1
Merged

fix: correct docs for contact-summary field appliesIf #1718

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
2 changes: 1 addition & 1 deletion content/en/building/contact-summary/contact-summary-templated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Each field that can be shown on a contact's profile is defined as an object in t
| `width` | `integer` | The horizontal space for the field. Common values are 12 for full width, 6 for half width, or 3 for quarter width. Default 12. | no |
| `translate` | `boolean` | Whether or not to translate the `value`. Defaults to false. | no |
| `context` | `object` | When `translate: true` and `value` uses [translation variables](https://angular-translate.github.io/docs/#/guide/06_variable-replacement), this value should provide the translation variables. | no |
| `appliesIf` | `function()` or `boolean` | Return true if the field should be shown. | no |
| `appliesIf` | `function()` | Return `true` if the field should be shown, and `false` if it should be hidden. Default is `true`. | no |
Copy link
Member

Choose a reason for hiding this comment

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

I dunno how much detail to go into. Smells fine but slightly incomplete... it's a bit more complicated than saying "false if hidden" because visibility is determined by appliesIf && !resolvedIf. I think this is explained somewhat well here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for having a look!

visibility is determined by appliesIf && !resolvedIf

These docs are specifically for the contact-summary fields. Unless I am totally missing something, I think that resolvedIf is just for tasks. In the tasks world, yes, visibility (and everything else 😅) is more complicated, but here for the contact summary fields, I think the logic is more straight forward.

That being said, if I totally misunderstood what you meant, let me know and I can open a new PR to better clarify things!

Copy link
Member

Choose a reason for hiding this comment

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

My mistake

| `appliesToType` | `string[]` | Filters the contacts for which `appliesIf` will be evaluated. For example, `['person']` or `['clinic', 'health_center']`. It defaults to all types if it is not defined. | no |

<!-- TODO: See [How to configure profile pages]() for an example. -->
Expand Down
Loading