Improve label handling in MasterListComponent #1786
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
sdirix requested changes Jul 14, 2021
Comment on lines 252 to 259
| const getFirstUsableProperty = (schema: JsonSchema): string => { | ||
| const prop = Object.entries(schema?.properties).find(e => { | ||
| if(e[1].type === 'object' || e[1].properties) return false; | ||
| if(e[1].type === 'array' || e[1].items) return false; | ||
| return true; | ||
| }); | ||
| return prop ? prop[0] : Object.keys(schema?.properties)[0]; | ||
| } |
There was a problem hiding this comment.
There is a utility for this in @jsonforms/core which you can import: getFirstPrimitiveProp.
Comment on lines 174 to 175
| controlElement.options?.detail || | ||
| findUISchema( |
There was a problem hiding this comment.
Not directly related to this PR but I just noticed this issue here: findUISchema already checks the options.detail, so we don't need to do this manually. Especially as our API also allows the strings DEFAULT, GENERATED and REGISTERED as valid detail values ;)
We can just hand over the controlElement as the next parameter after 'VerticalLayout', i.e.
const detailUISchema = findUISchema( props.uischemas, schema, `${controlElement.scope}/items`, props.path, 'VerticalLayout', controlElement, );The MasterListComponent did only show labels for object lists. Furthermore the options property in the uischema was mandatory. Also the property to use as label for objects had to be provided. The fix now handles primitives, a missing options property and in the case of a missing `labelRef` the first primitive property is used. If no primitive property is available the fallback text 'No label set' will be shown. Fix eclipsesource#1779
sdirix reviewed Jul 15, 2021
| const labelRefInstancePath = controlElement.options?.labelRef && removeSchemaKeywords( | ||
| controlElement.options.labelRef | ||
| ); | ||
| const isPrimitive = d && typeof d !== 'object'; |
There was a problem hiding this comment.
this is false for 0 and empty strings ''
There was a problem hiding this comment.
Will fix, JS and auto conversion of types ...
sdirix reviewed Jul 15, 2021
packages/examples/src/1779.ts Outdated
| registerExamples([ | ||
| { | ||
| name: '1779', | ||
| label: 'List With Detail primitive (string)', |
There was a problem hiding this comment.
Suggested change
| label: 'List With Detail primitive (string)', | |
| label: 'List With Detail primitive (number)', |
sdirix approved these changes Jul 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
The MasterListComponent did only show labels for object lists.
Furthermore the options property in the uischema was mandatory.
Also the property to use as label for objects had to be provided.
The fix now handles primitives, a missing options property and
in the case of a missing
labelRefthe first primitive propertyis used. If no primitive property is available the first property in
the schema is used.
Fix #1779