Merge pull request #11014 from marmelab/doc-multiLine-notification

[Doc] Document how to support line-breaks in notifications

Author: djhi

docs/useNotify.md

@@ -145,6 +145,15 @@ notify(
 );
 ```
 
+You also need to set the `multiLine` option to `true` when your message contains line breaks (`\n`):
+
+```jsx
+notify(
+    'Line 1\nLine 2\nLine 3',
+    { multiLine: true }
+);
+```
+
 ## `type`
 
 This option lets you choose the notification type. It can be `info`, `success`, `warning` or `error`. The default is `info`.

packages/ra-ui-materialui/src/layout/Notification.stories.tsx

@@ -81,6 +81,25 @@ export const Multiline = () => (
     </Wrapper>
 );
 
+const LineBreakNotification = () => {
+    const notify = useNotify();
+    React.useEffect(() => {
+        notify(
+            'Lorem ipsum dolor sit amet, consectetur adipiscing elit.\nSed euismod, nisl nec ultricies aliquam, nisl nisl aliquet nisl, eget aliquet nisl nisl eu nisl.\nSed euismod, nisl nec ultricies aliquam, nisl nisl aliquet nisl, eget aliquet nisl nisl eu nisl.',
+            {
+                multiLine: true,
+            }
+        );
+    }, [notify]);
+    return null;
+};
+
+export const LineBreak = () => (
+    <Wrapper>
+        <LineBreakNotification />
+    </Wrapper>
+);
+
 const AutoHideDurationNotification = () => {
     const notify = useNotify();
     React.useEffect(() => {