Render method to enable card-like displays in wallets and displayers#39
Render method to enable card-like displays in wallets and displayers#39
Conversation
msporny
left a comment
There was a problem hiding this comment.
At a high level, this looks useful to me. A couple of suggestions:
- Perhaps we can call this the "Summary" or "Card" render suite? I don't know what a "json-card" is and what this is actually doing is providing a fallback summary display.
- What is the Internationalization and Accessibility story here? I don't think we'll pass the i18n and a11y reviews without one.
index.html
Outdated
| "issueDate": "/validFrom", | ||
| "expirationDate": "/validUntil" |
There was a problem hiding this comment.
I don't understand the purpose of these properties?
There was a problem hiding this comment.
Changed them to validFrom and validUntil to match v2 versions now that v2 is standardized. Like name and description, these are "built-in" fields that would be expected to be displayed on every credential card in a predictable location.
| "label": "Institution", | ||
| "value": "/issuer" |
There was a problem hiding this comment.
| "label": "Institution", | |
| "value": "/issuer" | |
| "label": "Institution", | |
| "language": "en", | |
| "value": "/issuer" |
We could do this for i18n?
There was a problem hiding this comment.
Added in [d26a211](https://github.com/w3c/vc-render-method/pull/39/commits/d26a211fead8c35f05737228c33b40be5c459029)
I worry that proliferating a wild number of different language titles for specific fields would make for very large credentials, especially if the credential claims were also expressed in multiple languages, but I guess in large credentials, the need for sensible rendering is even more.
|
+1 to the concept in this PR. I think if any VC has both a "Summary Card JSON" render method and a (forthcoming PR) sandboxed-HTML render method, it should cover the vast majority of rendering cases. The "Summary Card JSON" rendering is useful for interfaces that want to have significant control over their own UX and integrate perhaps many different VCs at once into a unified view (lists, tables, cards, etc.) and the sandboxed-HTML render method provides the issuer's preferred custom view of a single VC (potentially even interactive!). |
|
FWIW, Microsoft has something rather similar in their "Credential Display Definition" format that they support: https://learn.microsoft.com/en-us/entra/verified-id/credential-design#create-a-credential-display-definition It's a ❄️ (unique to them, afaict), but the similarities are strong enough that we should at least be aware which features this proposal covers (or doesn't) for future discussions in the space. |
Co-authored-by: @TallTed <tthibodeau@openlinksw.com> Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
- users are expected to translate core field labels themselves
af35651 to
d26a211
Compare
For discussion and consideration, I don't have any particular product that aims to use this concept imminently. Feel free to edit.
The concept is:
fields, and detail views could display all of thefields.Preview | Diff