Skip to content

Conversation

heath-freenome
Copy link
Member

@heath-freenome heath-freenome commented Apr 23, 2025

Reasons for making this change

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

Checklist

  • I'm updating documentation
  • I'm adding or updating code
    • I've added and/or updated tests. I've run npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:update to update snapshots, if needed.
    • I've updated docs if needed
    • I've updated the changelog with a description of the PR
  • I'm adding a new feature
    • I've updated the playground with an example use of the feature

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
@heath-freenome heath-freenome requested a review from nickgros April 23, 2025 20:26
"ui:field": "LayoutGridField",
"ui:layoutGrid": {
"ui:row": {
"className": "GridStyle anotherClass",
Copy link
Contributor

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

Copy link
Member Author

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?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, exactly

Copy link
Contributor

@nickgros nickgros left a 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.

@heath-freenome heath-freenome merged commit f8e9691 into rjsf-v6 Apr 24, 2025
4 checks passed
@heath-freenome heath-freenome deleted the document-LayoutGridField branch April 24, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants