Feature: added the ui:enableMarkdownInHelp flag in UiSchema (#4855)

* updated core/Fieldhelp, react-bootstrap/fieldHelpTemplate, antd/HelpField

* added the ui:enableMarkdownInHelp flag in UiSchema

* Updated Changelog.md

* Implemented help field markdown using RichHelp.tsx component, added the tests

* updated the tests

* updated the changes according to descriptionField

* Update CHANGELOG.md

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

* Update CHANGELOG.md

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

* Updated

* Updated

* added the ui:enableMarkdownInHelp flag in UiSchema

* added the ui:enableMarkdownInHelp flag in UiSchema

* added the ui:enableMarkdownInHelp flag in UiSchema

* Updated

* updated to pass the test

* Updated

* updated to pass the test

* updated to pass the test

* fix(antd): update FieldHelpTemplate to match snapshot expectations

* updated the tests

* Updated antd HelpField to consistently use Markdown for help text & restored text-danger logic in Bootstrap FieldHelpTemplate & updated core test to expect div.help-block instead of p.help-block

---------

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Author: Suyog241005

CHANGELOG.md

@@ -15,6 +15,61 @@ it according to semantic versioning. For example, if your PR adds a breaking cha
 should change the heading of the (upcoming) version to include a major version bump.
 
 -->
+# 6.1.0
+
+## @rjsf/antd
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/antd
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/antd
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/mui
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/shadcn
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/primereact
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/react-bootstrap
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/semantic-ui
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/daisyui
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/fluentui-rc
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/chakra-ui
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/mantine
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+## @rjsf/utils
+
+- Added support for rendering `ui:help` as markdown via new `ui:enableMarkdownInHelp` flag in `FieldHelpTemplate`
+
+
 # 6.0.2
 
 ## @rjsf/antd

packages/antd/src/templates/DescriptionField/index.tsx renamed to packages/antd/src/templates/FieldDescriptionTemplate/index.tsx

@@ -0,0 +1,23 @@
+import { helpId, FieldHelpProps, FormContextType, RJSFSchema, StrictRJSFSchema } from '@rjsf/utils';
+import { RichHelp } from '@rjsf/core';
+
+/** The `FieldHelpTemplate` component renders any help desired for a field
+ *
+ * @param props - The `FieldHelpProps` to be rendered
+ */
+export default function FieldHelpTemplate<
+  T = any,
+  S extends StrictRJSFSchema = RJSFSchema,
+  F extends FormContextType = any,
+>(props: FieldHelpProps<T, S, F>) {
+  const { fieldPathId, help, uiSchema, registry } = props;
+  if (!help) {
+    return null;
+  }
+
+  return (
+    <div id={helpId(fieldPathId)} className='help-block'>
+      <RichHelp help={help} registry={registry} uiSchema={uiSchema} />
+    </div>
+  );
+}

packages/antd/src/templates/FieldHelpTemplate/index.tsx

@@ -31,6 +31,7 @@ export default function FieldTemplate<
     displayLabel,
     errors,
     help,
+    rawHelp,
     hidden,
     id,
     label,
@@ -39,7 +40,6 @@ export default function FieldTemplate<
     onRemoveProperty,
     rawErrors,
     rawDescription,
-    rawHelp,
     readonly,
     registry,
     required,

packages/antd/src/templates/FieldTemplate/index.tsx

@@ -3,7 +3,7 @@ import { FormContextType, RJSFSchema, StrictRJSFSchema, TemplatesType } from '@r
 import ArrayFieldItemTemplate from './ArrayFieldItemTemplate';
 import ArrayFieldTemplate from './ArrayFieldTemplate';
 import BaseInputTemplate from './BaseInputTemplate';
-import DescriptionField from './DescriptionField';
+import DescriptionField from './FieldDescriptionTemplate';
 import ErrorList from './ErrorList';
 import { AddButton, CopyButton, MoveDownButton, MoveUpButton, RemoveButton } from './IconButton';
 import FieldErrorTemplate from './FieldErrorTemplate';