-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Added documentation for the Layout Grid feature and fixed a few issues #4576
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.
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
Conversation
Added docs for the Layout Grid feature and fixed some issues - Updated the `package.json` files to move the `types` definition to the start of each `exports` block to fix some npm warnings - Updated the `LayoutMultiSchemaField` to wrap the `Widget` in a `FieldTemplate` to get the field title displayed properly in several themes - Updated the tests accordingly - This required regenerating snapshots in some themes - Updated the documentation in the `LayoutGridField` to fix some issues - Added the `LayoutGridField.md` file to the `api-reference` section - Added the `layout-grid.md` file to the `usage` section to describe in detail how to use the `LayoutGridField` - Updated the `v6` upgrade guide to add some small changes
"ui:field": "LayoutGridField", | ||
"ui:layoutGrid": { | ||
"ui:row": { | ||
"className": "GridStyle anotherClass", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a convention, I wonder if we should suggest giving the 'placeholder' class name to be replaced a prefix or something like that, so it's clear that it's not a real classname
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the examples? So you mean GridStyle-REPLACE_ME
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, exactly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plenty of suggestions, but this looks great.
Reasons for making this change
Added docs for the Layout Grid feature and fixed some issues
package.json
files to move thetypes
definition to the start of eachexports
block to fix some npm warningsLayoutMultiSchemaField
to wrap theWidget
in aFieldTemplate
to get the field title displayed properly in several themesLayoutGridField
to fix some issuesLayoutGridField.md
file to theapi-reference
sectionlayout-grid.md
file to theusage
section to describe in detail how to use theLayoutGridField
v6
upgrade guide to add some small changesChecklist
npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:update
to update snapshots, if needed.