Skip to content

Commit ebef6da

Browse files
committed
Reintroduce switchable prop and use diff syntax
1 parent 84d12fe commit ebef6da

File tree

3 files changed

+35
-30
lines changed

3 files changed

+35
-30
lines changed

packages/react-renderer-demo/src/components/code-editor/index.js

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,18 @@ const CodeEditor = ({ value, children, className, inExample }) => {
4848

4949
const lang = className ? className.toLowerCase().replace('language-', '') : undefined;
5050
let content = value || children || '';
51-
content = tranformImports(content);
51+
52+
// read props from code in --- { "key": value } ---\n format
53+
let propsFromMD = content.match(/--- .* ---/);
54+
if (propsFromMD) {
55+
propsFromMD = JSON.parse(propsFromMD[0].replace(/-/g, ''));
56+
content = content.replace(/--- .* ---\n/, '');
57+
}
58+
59+
if (propsFromMD?.switchable !== false) {
60+
content = tranformImports(content);
61+
}
62+
5263
content = content.substring(0, content.length - 1);
5364

5465
return (

packages/react-renderer-demo/src/pages/migration-guide-v3.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ PatternFly 3 mapper is now removed. You can still use the mapper from version 2,
1616

1717
Migration should be simple - most of the components share the same API so replacing imports should work fine in most cases.
1818

19+
```diff
20+
--- { "switchable": false } ---
21+
-import { componentMapper, FormTemplate } from '@data-driven-forms/pf3-component-mapper';
22+
+import { componentMapper, FormTemplate } from '@data-driven-forms/pf4-component-mapper';
23+
```
24+
1925
---
2026

2127
## New build process
@@ -32,37 +38,27 @@ UMD format is no longer supported. The import paths for UMD packages now lead to
3238

3339
Due to the new build process, you have to change your imports path, if you use relative imports of specific components or if you consume the specific module system package. There are no longer module system and the dist folder specified.
3440

35-
**Before**
36-
37-
`import useFieldApi from '@data-driven-forms/react-form-renderer/dist/cjs/use-field-api';`
38-
39-
<br />
40-
41-
**After**
42-
43-
`import useFieldApi from '@data-driven-forms/react-form-renderer/use-field-api';`
44-
45-
<br />
41+
```diff
42+
--- { "switchable": false } ---
43+
-import useFieldApi from '@data-driven-forms/react-form-renderer/dist/cjs/use-field-api';;
44+
+import useFieldApi from '@data-driven-forms/react-form-renderer/use-field-api';
45+
```
4646

4747
You can use [babel-transform-plugin](/optimization#transformingimportsinbabel) to do this change for you.
4848

4949
### FormRenderer is longer a default export
5050

5151
FormRenderer component is no longer a default export of the `react-form-renderer` package.
5252

53-
**Before**
54-
55-
`import FormRenderer from '@data-driven-forms/react-form-renderer';`
56-
57-
<br />
58-
59-
**After**
60-
61-
`import { FormRenderer } from '@data-driven-forms/react-form-renderer';`
53+
```diff
54+
--- { "switchable": false } ---
55+
-import FormRenderer from '@data-driven-forms/react-form-renderer';
56+
+import { FormRenderer } from '@data-driven-forms/react-form-renderer';
6257

63-
or
58+
// or
6459

65-
`import { FormRenderer } from '@data-driven-forms/react-form-renderer/form-renderer';`
60+
+import { FormRenderer } from '@data-driven-forms/react-form-renderer/form-renderer';
61+
```
6662

6763
<br />
6864

packages/react-renderer-demo/src/pages/optimization.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,10 @@ module.exports = {
7272

7373
Result:
7474

75-
76-
`import { useField } from '@data-driven-forms/react-form-renderer';`
77-
78-
will be converted to
79-
80-
`import useField from '@data-driven-forms/react-form-renderer/use-field';`
81-
75+
```diff
76+
--- { "switchable": false } ---
77+
-import { useField } from '@data-driven-forms/react-form-renderer';
78+
+import useField from '@data-driven-forms/react-form-renderer/use-field';
79+
```
8280

8381
</DocPage>

0 commit comments

Comments
 (0)