From 4cb87378665663dd7d43364e510c8d726fe380e9 Mon Sep 17 00:00:00 2001 From: Heath C <51679588+heath-freenome@users.noreply.github.com> Date: Sat, 7 Jan 2023 21:49:35 -0800 Subject: [PATCH] fix: Add typescript documentation to advanced customization (#3355) partially fix: #3072 - Fixed a broken example in `custom-templates.md` - Fixed broken links in the `form-props.md` - Added a new `typescript.md` file to `advanced-customization` to document using custom generics - Updated `mkdocs.yml` to replacing `Contributing` with the new `typescript.md` file under `Advanced Customization`, moving `Contributing` from the bottom to be after `Quickstart` - Also moved all of the `Migration Guides` into its own subsection - Updated the `CHANGELOG.md` file accordingly --- CHANGELOG.md | 4 +- .../custom-templates.md | 9 +- docs/advanced-customization/typescript.md | 273 ++++++++++++++++++ docs/api-reference/form-props.md | 2 +- mkdocs.yml | 13 +- 5 files changed, 288 insertions(+), 13 deletions(-) create mode 100644 docs/advanced-customization/typescript.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 9534259aae..eea1e8c1dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,7 +68,9 @@ should change the heading of the (upcoming) version to include a major version b - Updated the `ArrayFieldTemplateItemType` to add the new `totalItems` and `canAdd` props, fixing [#3315](https://github.com/rjsf-team/react-jsonschema-form/issues/3315) ## Dev / docs / playground -- Fixed the documentation for `ArrayFieldItemTemplate`, `SubmitButtonProps` and `IconButtonProps` as part of the fix for [#3314](https://github.com/rjsf-team/react-jsonschema-form/issues/3314) and [#3315](https://github.com/rjsf-team/react-jsonschema-form/issues/3315) +- Fixed the documentation for `ArrayFieldItemTemplate`, `SubmitButtonProps` and `IconButtonProps` as part of the fix for [#3314](https://github.com/rjsf-team/react-jsonschema-form/issues/3314) and [#3315](https://github.com/rjsf-team/react-jsonschema-form/issues/3315) +- Updated the documentation in `form-props.md` for `children`, fixing [#3322](https://github.com/rjsf-team/react-jsonschema-form/issues/3322) +- Added new `typescript.md` documentation to `Advanced Customization` describing how to use custom generics as part of the fix for [#3072](https://github.com/rjsf-team/react-jsonschema-form/issues/3072) # 5.0.0-beta-15 diff --git a/docs/advanced-customization/custom-templates.md b/docs/advanced-customization/custom-templates.md index 8f99ca150c..5ee3819a17 100644 --- a/docs/advanced-customization/custom-templates.md +++ b/docs/advanced-customization/custom-templates.md @@ -811,11 +811,10 @@ function WrapIfAdditionalTemplate( onBlur={function (event) { onKeyChange(event.target.value) } } defaultValue={label} />