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

Documentation > API Reference > <Form /> Props is showing ErrorList #3758

Closed
4 tasks done
LunaFidalgo opened this issue Jul 10, 2023 · 0 comments · Fixed by #3770
Closed
4 tasks done

Documentation > API Reference > <Form /> Props is showing ErrorList #3758

LunaFidalgo opened this issue Jul 10, 2023 · 0 comments · Fixed by #3770

Comments

@LunaFidalgo
Copy link

LunaFidalgo commented Jul 10, 2023

Prerequisites

What theme are you using?

core

Version

5.x

Current Behavior

Hello,
I was checking the documentation, particularly the section: API Reference > <Form /> Props. There, you can find ErrorList as an available option, but it should be added as part of a custom template (Template).

What the documentation suggests:

<Form ErrorList={() => <div> my custom error list </div>} />

What it should be:

<Form templates={{ ErrorListTemplate: MyCustomErrorList }} />

Expected Behavior

Remove ErrorList from <Form /> Props documentation. It is already listed in Advanced Customization > Custom Templates.

Steps To Reproduce

  1. Go to "https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/form-props"
  2. Check the ErrorList field is listed
  3. You can check here that ErrorList is not a valid prop
    image

Environment

- OS:
- Node:
- npm:

Anything else?

No response

@LunaFidalgo LunaFidalgo added bug needs triage Initial label given, to be assigned correct labels and assigned labels Jul 10, 2023
nickgros added a commit to nickgros/react-jsonschema-form that referenced this issue Jul 14, 2023
…ve been removed when v5 was released
@nickgros nickgros added docs and removed needs triage Initial label given, to be assigned correct labels and assigned labels Jul 14, 2023
heath-freenome added a commit that referenced this issue Jul 14, 2023
…3770)

* Fix #3758 by removing `ErrorList` from docs, which should have been removed when v5 was released

* Fix #3670 - fix bad theme imports in docs

---------

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants