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.

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

ANNOUNCEMENT: Breaking changes planned for v3 #2297

Closed
3 of 5 tasks
epicfaace opened this issue Mar 22, 2021 · 17 comments
Closed
3 of 5 tasks

ANNOUNCEMENT: Breaking changes planned for v3 #2297

epicfaace opened this issue Mar 22, 2021 · 17 comments

Comments

@epicfaace
Copy link
Member

epicfaace commented Mar 22, 2021

The next version of rjsf will be v3, and we'll add a few breaking changes to it.

Planned changes

PRs that are nearly ready and will be added in v3:

Other potential changes

If someone makes PRs for these issues, we might be able to get them into v3.

These PRs would be good to add, but still have some work to do on them:

Have suggestions for changes / additional items we should add to this list? Feedback welcome!

cc @ri0ter @erunion @stanlemon @mattcosta7 @zepatrik @wegry @jimmycallin @RoboPhred @bmmpt

@epicfaace epicfaace pinned this issue Mar 22, 2021
@wegry
Copy link
Contributor

wegry commented Mar 22, 2021

@epicfaace I was hoping the react-is bump might make it into v3 as well. #2196.

@epicfaace
Copy link
Member Author

Oh, is that a breaking change? If not, we can still get it in either in v3 or sometime later, but the scope of this issue is just categorizing the breaking changes (because they have to be released on a new major bump).

@wegry
Copy link
Contributor

wegry commented Mar 22, 2021

Sounds good.

Is that a breaking change?

I don't believe so. Just something I've been hankering for.

@mattcosta7
Copy link
Contributor

@epicfaace sounds good to me.

I noticed there's a few things tagged with 'deprecated' in the codebase. might be a good time to clean those as well.

Particularly

  • autocomplete vs autoComplete
  • ui:widget object API, where a widget and options were specified with "ui:widget": {component, options} shape

@jimmycallin
Copy link
Collaborator

Sounds good! Might want to look into the discussions in this PR and consider them as well #2010

@stanlemon
Copy link
Contributor

Some thoughts...

  • Previously we discussed swapping out native controls in the Material UI theme for their provided ones, specifically the date picker.
  • Any widget built around arrays and nesting requires a lot of work in a new theme, it would be great if to make that a lighter lift.
  • This might be controversial, but perhaps we drop the verbose date picker with tons of selects altogether.

@jimmycallin
Copy link
Collaborator

@epicfaace You also mentioned this old PR of mine to be a breaking change #1522

might be time to merge it then (or let me know if you want me to revert the breaking change part). personally i would love to see rjsf to be strict mode valid as a part of v3.

@gsstar9028
Copy link

@epicfaace Please consider including #2272

@epicfaace
Copy link
Member Author

@gsstar9028 no worries, it's already been merged into master, so it will be included!

@epicfaace
Copy link
Member Author

personally i would love to see rjsf to be strict mode valid as a part of v3.

@jimmycallin Agreed, that would be nice! (so we'd need to stop using unsafe component lifecycle methods) Sorry for the delay in responding to your other PR.

@epicfaace
Copy link
Member Author

It's been quite a while since I made this post, so I'm going to go ahead and release v3 soon so we don't have too much time lag between versions. We can release the other pending breaking changes in v4 (which could probably come relatively soon after v3 and have less breaking changes).

@heath-freenome
Copy link
Member

Is there going to be support for the JSON Schema v7 conditionals? https://json-schema.org/understanding-json-schema/reference/conditionals.html

@epicfaace
Copy link
Member Author

Not now, but maybe we can track that in another issue.

@heath-freenome
Copy link
Member

heath-freenome commented Jun 17, 2021

Not now, but maybe we can track that in another issue.

That would be awesome because we might be forced to use it in our schema given some constraints we have

@wegry
Copy link
Contributor

wegry commented Jun 22, 2021

@epicfaace do you need any help with anything prior to v3 going out? I'd like to help carry this over the hump if possible.

@epicfaace
Copy link
Member Author

@wegry Thanks for checking. I'd like to clean up https://github.com/rjsf-team/react-jsonschema-form/blob/master/docs/3.x%20upgrade%20guide.md (ensure that the tone is consistent, everything is clear, etc.) before release because multiple people have added to it and it doesn't read very well at the moment.

@epicfaace
Copy link
Member Author

Thanks for your help @wegry !

v3 is now out! Migrated the pending issues to #2437.

@epicfaace epicfaace unpinned this issue Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants