Added multiline attribute on Text, RichText, RichTextExt

matteofrana · matteofrana · commit 3901c1560fa7 · 2021-11-01T16:30:37.000+01:00
React Bricks 3.0 (no beta)
diff --git a/pages/api-reference/visual-components/rich-text-ext.mdx b/pages/api-reference/visual-components/rich-text-ext.mdx
@@ -17,6 +17,7 @@ interface RichTextProps {
   renderBlock: (props: RenderElementProps) => JSX.Element
   propName: string
   placeholder: string
+  multiline?: boolean
   plugins?: types.RichTextPlugin[]
 }
 ```
@@ -28,6 +29,7 @@ interface RichTextProps {
 | `renderBlock` | A React functional component used to render each paragraph of text. |
 | `propName`    | The prop of the Brick component corresponding to this text.         |
 | `placeholder` | The placeholder to show when the text is empty.                     |
+| `multiline`   | Default: `true`. If set to `false` it prevents multiline text.      |
 | `plugins`     | An array of plugins extending the rich text functionality.          |
 
 ## Change or create a plugin
diff --git a/pages/api-reference/visual-components/rich-text.mdx b/pages/api-reference/visual-components/rich-text.mdx
@@ -21,6 +21,7 @@ interface RichTextProps {
   renderBlock: (props: RenderElementProps) => JSX.Element
   placeholder: string
   propName: string
+  multiline?: boolean
   allowedFeatures?: types.RichTextFeatures[]
   renderBold?: (props: RenderLeafProps) => JSX.Element
   renderItalic?: (props: RenderLeafProps) => JSX.Element
@@ -47,6 +48,7 @@ interface RichTextProps {
 | `renderBlock`     | A React functional component used to render each paragraph of text.                                                                                                                                                                                        |
 | `propName`        | The prop of the Brick component corresponding to this text.                                                                                                                                                                                                |
 | `placeholder`     | The placeholder to show when the text is empty.                                                                                                                                                                                                            |
+| `multiline`       | Default: `true`. If set to `false` it prevents multiline text.                                                                                                                                                                                             |
 | `allowedFeatures` | An array of allowed rich text features: the available features are of type [`types.RichTextFeatures`](/api-reference/types/enums#richtextfeatures)                                                                                                         |
 | `renderBold`      | The optional render function for the `BOLD` marker.                                                                                                                                                                                                        |
 | `renderItalic`    | The optional render function for the `ITALIC` marker.                                                                                                                                                                                                      |
diff --git a/pages/api-reference/visual-components/text.mdx b/pages/api-reference/visual-components/text.mdx
@@ -16,27 +16,26 @@ interface TextProps {
   propName: string
   renderBlock: React.FC
   placeholder: string
+  multiline?: boolean
 }
 ```
 
 ## Properties definition
 
-| Property | Definition |
-| --- | --- |
-| `propName` | The prop of the Brick component corresponding to this text. |
+| Property      | Definition                                                                                  |
+| ------------- | ------------------------------------------------------------------------------------------- |
+| `propName`    | The prop of the Brick component corresponding to this text.                                 |
 | `renderBlock` | A React functional component used to render the text.<br />Typically it wraps the children. |
-| `placeholder` | The placeholder to show when the text is empty. |
+| `placeholder` | The placeholder to show when the text is empty.                                             |
+| `multiline`   | Default: `false`. If set to `true` allows multiline text.                                   |
 
 ## Usage example
 
 ```tsx
 <Text
   propName="claim"
   renderBlock={(props: any) => (
-    <p
-      className="text-xl font-extrabold"
-      {...props.attributes}
-    >
+    <p className="text-xl font-extrabold" {...props.attributes}>
       {props.children}
     </p>
   )}
diff --git a/pages/meta.json b/pages/meta.json
@@ -1,5 +1,5 @@
 {
-  "index": "React Bricks 3.0-beta",
+  "index": "React Bricks 3.0",
   "docs": "Documentation",
   "advanced": "Advanced Guide",
   "api-reference": "Api Reference"

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "index": "React Bricks 3.0-beta",`
	`2`	`+ "index": "React Bricks 3.0",`
`3`	`3`	`"docs": "Documentation",`
`4`	`4`	`"advanced": "Advanced Guide",`
`5`	`5`	`"api-reference": "Api Reference"`