@rio-cloud/uikit-mcp 1.0.0

package/data/pages/Components/components/bottomsheet.json

@@ -0,0 +1,601 @@
+{
+  "metadata": {
+    "captured_at": "2025-11-21T12:07:06.258Z",
+    "source": "https://uikit.developers.rio.cloud/#components/bottomSheet",
+    "category": "Components",
+    "section": "Application",
+    "slug": "components/bottomsheet",
+    "version": "v1.13.2",
+    "hash_algorithm": "sha256",
+    "hash": "effff902e08b3c2d6d902b78379167333d96848b8e4ee05b1a85a7d03f4bc720"
+  },
+  "title": "BottomSheet",
+  "lead": "The TimedBottomSheet is a wrapper component for the BottomSheet that allows to control it's visibility via timers and to use the localStorage to save user interaction for handling it's visibility.",
+  "content": [
+    {
+      "heading": "BottomSheet",
+      "body": "",
+      "examples": [
+        {
+          "caption": "Example 1",
+          "rendered_html": "<div class=\"playground-content  bg-white padding-20 padding-bottom-25\" style=\"width: 100%;\"><div><p class=\"margin-top-0\">This demonstrates a small bottom sheet use case on <b>desktop.</b> This can be used for providing additional information, upselling, feedback etc.</p><button class=\"btn btn-primary\" type=\"button\">Trigger small BottomSheet</button></div></div>",
+          "tabs": [
+            {
+              "label": "React",
+              "language": "tsx",
+              "code": "import React, { useState } from 'react';\n\nimport BottomSheet from '@rio-cloud/rio-uikit/BottomSheet';\n\nexport default () => {\n    const [showBottomSheet, setShowBottomSheet] = useState(false);\n    return (\n        <div>\n            <p className='margin-top-0'>\n                This demonstrates a small bottom sheet use case on <b>desktop.</b> This can be used for providing\n                additional information, upselling, feedback etc.\n            </p>\n            <button className='btn btn-primary' type='button' onClick={() => setShowBottomSheet(true)}>\n                Trigger small BottomSheet\n            </button>\n\n            <BottomSheet\n                show={showBottomSheet}\n                width={400}\n                onClose={() => setShowBottomSheet(false)}\n                detach\n                bodyClassName='padding-25 margin-right-25'\n            >\n                {content}\n            </BottomSheet>\n        </div>\n    );\n};\n\nconst content = (\n    <React.Fragment>\n        <div>Hi there! Would you be interested in the latest features?</div>\n        <div className='btn-toolbar margin-top-15 display-flex justify-content-end'>\n            <button type='button' className='btn btn-link btn-sm'>\n                No, thanks\n            </button>\n            <button type='button' className='btn btn-default btn-sm'>\n                <span className='rioglyph rioglyph-heart' />\n                Yes, show me more\n            </button>\n        </div>\n    </React.Fragment>\n);"
+            },
+            {
+              "label": "HTML",
+              "language": "html",
+              "code": "<div>\n    <p class=\"margin-top-0\">This demonstrates a small bottom sheet use case on <b>desktop.</b> This can be used for providing additional information, upselling, feedback etc.</p>\n    <button class=\"btn btn-primary\" type=\"button\">Trigger small BottomSheet</button>\n</div>"
+            },
+            {
+              "label": "Props",
+              "language": "json",
+              "code": null,
+              "props": [
+                {
+                  "heading": null,
+                  "rows": [
+                    {
+                      "name": "show",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen."
+                    },
+                    {
+                      "name": "onClose",
+                      "type": "Function",
+                      "default": "() => {})",
+                      "description": "Callback for when the sheet closes."
+                    },
+                    {
+                      "name": "width",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a \"max-width-xxx\" via className to control it better."
+                    },
+                    {
+                      "name": "height",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The height of the bottom sheet. If no height is given, the height is automatically calculated from the content."
+                    },
+                    {
+                      "name": "title",
+                      "type": "Node / String",
+                      "default": "",
+                      "description": "The title content shown in the header. If no title is given, the bottom sheet header is not shown."
+                    },
+                    {
+                      "name": "showCloseButton",
+                      "type": "Boolean",
+                      "default": "true",
+                      "description": "Defines whether or not the close button is shown."
+                    },
+                    {
+                      "name": "showMaximizeButton",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Defines whether or not the maximize button in the header is shown."
+                    },
+                    {
+                      "name": "onHeightChange",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "The callback function triggered when the maximize button is clicked and the height changes."
+                    },
+                    {
+                      "name": "detach",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to detach the bottom sheet from the left side and the bottom and create a little offset."
+                    },
+                    {
+                      "name": "detachOffset",
+                      "type": "Number",
+                      "default": "15",
+                      "description": "Defines the amount of pixels for the sheet."
+                    },
+                    {
+                      "name": "hasBackdrop",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to render a modal like backdrop to emphasize the bottom sheet."
+                    },
+                    {
+                      "name": "onBackdropClick",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet."
+                    },
+                    {
+                      "name": "bodyRef",
+                      "type": "React Ref",
+                      "default": "",
+                      "description": "A react ref added to the bottom sheet body."
+                    },
+                    {
+                      "name": "bodyClassName",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the body element."
+                    },
+                    {
+                      "name": "className",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the wrapping element."
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "caption": "Example 2",
+          "rendered_html": "<div class=\"playground-content  bg-white padding-20 padding-bottom-25\" style=\"width: 100%;\"><div data-capture-callout=\"true\"><p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile. </b>This can be used for providing additional information on mobile instead of using a sidebar, onboarding, alternative for dialogs etc.</p><p><span class=\"label label-info label-condensed margin-right-5\">Note</span>This example does not make sense on desktop with wider screens. Handle responsive modes and use a dialog or sidebar on desktop instead.</p><button class=\"btn btn-primary\" type=\"button\">Trigger mobile BottomSheet</button></div></div>",
+          "tabs": [
+            {
+              "label": "React",
+              "language": "tsx",
+              "code": "import React, { useState, useRef, useEffect, type MutableRefObject } from 'react';\nimport throttle from 'lodash/fp/throttle';\n\nimport BottomSheet from '@rio-cloud/rio-uikit/BottomSheet';\nimport useElementSize from '@rio-cloud/rio-uikit/useElementSize';\n\nexport default () => {\n    const [showBottomSheet, setShowBottomSheet] = useState(false);\n    const [listHeight, setListHeight] = useState(300);\n\n    const sheetBodyRef = useRef<HTMLDivElement>(null);\n    const [_, bodyHeight] = useElementSize(sheetBodyRef);\n\n    // To adjust the height of the list elements according to the current height of the bottom sheet body,\n    // we use the element size hook and check for the body height. When it changes, we set the height of the\n    // list throttled to skip some renderings in between\n    useEffect(() => {\n        // Note that we need to subtract the height of the menu from the sheet body height since it fix.\n        // In this example we assume roughly a height of 130 pixels for the nav pills menu\n        const navPillsHeight = 130;\n        const throttledHeightChange = throttle(1000, newHeight => setListHeight(newHeight - navPillsHeight));\n\n        if (bodyHeight) {\n            throttledHeightChange(bodyHeight);\n        }\n    }, [bodyHeight]);\n\n    return (\n        <div>\n            <p className='margin-top-0'>\n                {'This demonstrates a bottom sheet use case on '}\n                <b>{'mobile. '}</b>\n                {'This can be used for providing additional information on mobile instead of using a sidebar, '}\n                onboarding, alternative for dialogs etc.\n            </p>\n            <p>\n                <span className='label label-info label-condensed margin-right-5'>Note</span>\n                {'This example does not make sense on desktop with wider screens. '}\n                Handle responsive modes and use a dialog or sidebar on desktop instead.\n            </p>\n            <button className='btn btn-primary' type='button' onClick={() => setShowBottomSheet(true)}>\n                Trigger mobile BottomSheet\n            </button>\n\n            <BottomSheet\n                show={showBottomSheet}\n                onClose={() => setShowBottomSheet(false)}\n                title={\n                    <div>\n                        <div className='text-medium'>Lorem ipsum dolor sit amet</div>\n                        <div className='text-size-14 text-color-darker'>consectetur adipiscing elit</div>\n                    </div>\n                }\n                height={500}\n                showMaximizeButton\n                className='max-width-800'\n                bodyRef={sheetBodyRef}\n            >\n                <div>\n                    <div className='padding-15'>\n                        <ul className='nav nav-pills nav-pills-filled nav-justified'>\n                            <li className='active shadow-default'>\n                                <span>First tab</span>\n                            </li>\n                            <li>\n                                <span>Second tab with longer content</span>\n                            </li>\n                            <li>\n                                <span>Third tab</span>\n                            </li>\n                        </ul>\n                    </div>\n                    <div\n                        className='padding-15 padding-top-0 padding-bottom-25 overflow-scroll'\n                        style={{ height: listHeight }}\n                    >\n                        <div>Content for Pill 1 ...</div>\n                        <ul className='panel-list margin-top-10 margin-bottom-0'>\n                            {Array.from({ length: 15 }, (_, index) => (\n                                <li key={index}>\n                                    <div className='text-medium'>{`${index + 1}. Lorem ipsum dolor sit amet`}</div>\n                                    <div>\n                                        {'consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam '}\n                                        condimentum in felis.\n                                    </div>\n                                </li>\n                            ))}\n                        </ul>\n                    </div>\n                </div>\n            </BottomSheet>\n        </div>\n    );\n};"
+            },
+            {
+              "label": "HTML",
+              "language": "html",
+              "code": "<div data-capture-callout=\"true\">\n    <p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile. </b>This can be used for providing additional information on mobile instead of using a sidebar, onboarding, alternative for dialogs etc.</p>\n    <p>\n        <span class=\"label label-info label-condensed margin-right-5\">Note</span>This example does not make sense on desktop with wider screens. Handle responsive modes and use a dialog or sidebar on desktop instead.\n    </p>\n    <button class=\"btn btn-primary\" type=\"button\">Trigger mobile BottomSheet</button>\n</div>"
+            },
+            {
+              "label": "Props",
+              "language": "json",
+              "code": null,
+              "props": [
+                {
+                  "heading": null,
+                  "rows": [
+                    {
+                      "name": "show",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen."
+                    },
+                    {
+                      "name": "onClose",
+                      "type": "Function",
+                      "default": "() => {})",
+                      "description": "Callback for when the sheet closes."
+                    },
+                    {
+                      "name": "width",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a \"max-width-xxx\" via className to control it better."
+                    },
+                    {
+                      "name": "height",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The height of the bottom sheet. If no height is given, the height is automatically calculated from the content."
+                    },
+                    {
+                      "name": "title",
+                      "type": "Node / String",
+                      "default": "",
+                      "description": "The title content shown in the header. If no title is given, the bottom sheet header is not shown."
+                    },
+                    {
+                      "name": "showCloseButton",
+                      "type": "Boolean",
+                      "default": "true",
+                      "description": "Defines whether or not the close button is shown."
+                    },
+                    {
+                      "name": "showMaximizeButton",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Defines whether or not the maximize button in the header is shown."
+                    },
+                    {
+                      "name": "onHeightChange",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "The callback function triggered when the maximize button is clicked and the height changes."
+                    },
+                    {
+                      "name": "detach",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to detach the bottom sheet from the left side and the bottom and create a little offset."
+                    },
+                    {
+                      "name": "detachOffset",
+                      "type": "Number",
+                      "default": "15",
+                      "description": "Defines the amount of pixels for the sheet."
+                    },
+                    {
+                      "name": "hasBackdrop",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to render a modal like backdrop to emphasize the bottom sheet."
+                    },
+                    {
+                      "name": "onBackdropClick",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet."
+                    },
+                    {
+                      "name": "bodyRef",
+                      "type": "React Ref",
+                      "default": "",
+                      "description": "A react ref added to the bottom sheet body."
+                    },
+                    {
+                      "name": "bodyClassName",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the body element."
+                    },
+                    {
+                      "name": "className",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the wrapping element."
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "caption": "Example 3",
+          "rendered_html": "<div class=\"playground-content  bg-white padding-20 padding-bottom-25\" style=\"width: 100%;\"><div><p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile.</b> It demonstrates a bottom sheet for smartphones to perform an action.</p><button class=\"btn btn-primary\" type=\"button\">Trigger mobile BottomSheet</button></div></div>",
+          "tabs": [
+            {
+              "label": "React",
+              "language": "tsx",
+              "code": "import React, { useState } from 'react';\n\nimport BottomSheet from '@rio-cloud/rio-uikit/BottomSheet';\nimport Switch from '@rio-cloud/rio-uikit/Switch';\nimport RadioButton from '@rio-cloud/rio-uikit/RadioButton';\nimport Button from '@rio-cloud/rio-uikit/Button';\n\nexport default () => {\n    const [showBottomSheet, setShowBottomSheet] = useState(false);\n\n    return (\n        <div>\n            <p className='margin-top-0'>\n                This demonstrates a bottom sheet use case on <b>mobile.</b> It demonstrates a bottom sheet for\n                smartphones to perform an action.\n            </p>\n            <button className='btn btn-primary' type='button' onClick={() => setShowBottomSheet(true)}>\n                Trigger mobile BottomSheet\n            </button>\n\n            <BottomSheet\n                show={showBottomSheet}\n                onClose={() => setShowBottomSheet(false)}\n                title='New Collection'\n                hasBackdrop\n                onBackdropClick={() => console.log('foobar')}\n                className='max-width-400'\n            >\n                <div className='padding-15'>\n                    <div className='display-flex justify-content-between align-items-center margin-top-15 margin-bottom-15 padding-15 bg-lightest rounded'>\n                        <div>\n                            <div className='text-medium text-size-16 text-color-darker'>Private</div>\n                            <div className='text-size-12 text-color-dark margin-top-5'>\n                                Only viewable by people you invite\n                            </div>\n                        </div>\n                        <Switch checked />\n                    </div>\n\n                    <label className='margin-left-10 margin-top-20 margin-bottom-0'>Contribution Settings</label>\n                    <div className='display-flex justify-content-between align-items-center margin-top-15 margin-bottom-15 padding-15 bg-lightest rounded'>\n                        <div>\n                            <div className='text-medium text-size-16 text-color-darker'>Controlled</div>\n                            <div className='text-size-12 text-color-dark margin-top-5'>\n                                Only allow members that are contributors to add content\n                            </div>\n                        </div>\n                        <RadioButton name='radioGroup' id='onlyMember' defaultChecked />\n                    </div>\n                    <div className='display-flex justify-content-between align-items-center margin-top-15 margin-bottom-15 padding-15 bg-lightest rounded'>\n                        <div>\n                            <div className='text-medium text-size-16 text-color-darker'>Open</div>\n                            <div className='text-size-12 text-color-dark margin-top-5'>\n                                Allow all members to add content\n                            </div>\n                        </div>\n                        <RadioButton name='radioGroup' id='open' />\n                    </div>\n\n                    <Button\n                        bsStyle='primary'\n                        bsSize={Button.LG}\n                        block\n                        className='margin-top-25'\n                        onClick={() => setShowBottomSheet(false)}\n                    >\n                        Create Collection\n                    </Button>\n                </div>\n            </BottomSheet>\n        </div>\n    );\n};"
+            },
+            {
+              "label": "HTML",
+              "language": "html",
+              "code": "<div>\n    <p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile.</b> It demonstrates a bottom sheet for smartphones to perform an action.</p>\n    <button class=\"btn btn-primary\" type=\"button\">Trigger mobile BottomSheet</button>\n</div>"
+            },
+            {
+              "label": "Props",
+              "language": "json",
+              "code": null,
+              "props": [
+                {
+                  "heading": null,
+                  "rows": [
+                    {
+                      "name": "show",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen."
+                    },
+                    {
+                      "name": "onClose",
+                      "type": "Function",
+                      "default": "() => {})",
+                      "description": "Callback for when the sheet closes."
+                    },
+                    {
+                      "name": "width",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a \"max-width-xxx\" via className to control it better."
+                    },
+                    {
+                      "name": "height",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The height of the bottom sheet. If no height is given, the height is automatically calculated from the content."
+                    },
+                    {
+                      "name": "title",
+                      "type": "Node / String",
+                      "default": "",
+                      "description": "The title content shown in the header. If no title is given, the bottom sheet header is not shown."
+                    },
+                    {
+                      "name": "showCloseButton",
+                      "type": "Boolean",
+                      "default": "true",
+                      "description": "Defines whether or not the close button is shown."
+                    },
+                    {
+                      "name": "showMaximizeButton",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Defines whether or not the maximize button in the header is shown."
+                    },
+                    {
+                      "name": "onHeightChange",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "The callback function triggered when the maximize button is clicked and the height changes."
+                    },
+                    {
+                      "name": "detach",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to detach the bottom sheet from the left side and the bottom and create a little offset."
+                    },
+                    {
+                      "name": "detachOffset",
+                      "type": "Number",
+                      "default": "15",
+                      "description": "Defines the amount of pixels for the sheet."
+                    },
+                    {
+                      "name": "hasBackdrop",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to render a modal like backdrop to emphasize the bottom sheet."
+                    },
+                    {
+                      "name": "onBackdropClick",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet."
+                    },
+                    {
+                      "name": "bodyRef",
+                      "type": "React Ref",
+                      "default": "",
+                      "description": "A react ref added to the bottom sheet body."
+                    },
+                    {
+                      "name": "bodyClassName",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the body element."
+                    },
+                    {
+                      "name": "className",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the wrapping element."
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "caption": "Example 4",
+          "rendered_html": "<div class=\"playground-content  bg-white padding-20 padding-bottom-25\" style=\"width: 100%;\"><div><p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile. </b>It demonstrates a bottom sheet for an example of how you could do onboarding on smartphones.</p><button class=\"btn btn-primary\" type=\"button\">Trigger mobile onboarding BottomSheet</button></div></div>",
+          "tabs": [
+            {
+              "label": "React",
+              "language": "tsx",
+              "code": "import React, { useState } from 'react';\n\nimport imageSliderDemoService1 from '../../demoService/assets/imageSliderDemoService1.png';\nimport imageSliderDemoService2 from '../../demoService/assets/imageSliderDemoService2.png';\nimport imageSliderDemoService3 from '../../demoService/assets/imageSliderDemoService3.png';\nimport imageSliderDemoService4 from '../../demoService/assets/imageSliderDemoService4.png';\n\nimport BottomSheet from '@rio-cloud/rio-uikit/BottomSheet';\nimport Carousel from '@rio-cloud/rio-uikit/Carousel';\n\nexport default () => {\n    const [showBottomSheet, setShowBottomSheet] = useState(false);\n    return (\n        <div>\n            <p className='margin-top-0'>\n                {'This demonstrates a bottom sheet use case on '}\n                <b>{'mobile. '}</b>\n                It demonstrates a bottom sheet for an example of how you could do onboarding on smartphones.\n            </p>\n            <button className='btn btn-primary' type='button' onClick={() => setShowBottomSheet(true)}>\n                Trigger mobile onboarding BottomSheet\n            </button>\n\n            <BottomSheet\n                show={showBottomSheet}\n                onClose={() => setShowBottomSheet(false)}\n                hasBackdrop\n                className='max-width-400'\n            >\n                <div className='padding-25 padding-bottom-10 margin-top-20'>\n                    <Carousel className='arrow-color-dark show-indicators offset-indicators shadow-default'>\n                        <Carousel.Item>\n                            <div className='panel panel-default margin-bottom-0 overflow-hidden'>\n                                <img className='img-responsive' src={imageSliderDemoService1} />\n                            </div>\n                        </Carousel.Item>\n\n                        <Carousel.Item>\n                            <div className='panel panel-default margin-bottom-0 overflow-hidden'>\n                                <img className='img-responsive' src={imageSliderDemoService2} />\n                            </div>\n                        </Carousel.Item>\n\n                        <Carousel.Item>\n                            <div className='panel panel-default margin-bottom-0 overflow-hidden'>\n                                <img className='img-responsive' src={imageSliderDemoService3} />\n                            </div>\n                        </Carousel.Item>\n\n                        <Carousel.Item>\n                            <div className='panel panel-default margin-bottom-0 overflow-hidden'>\n                                <img className='img-responsive' src={imageSliderDemoService4} />\n                            </div>\n                        </Carousel.Item>\n                    </Carousel>\n                </div>\n            </BottomSheet>\n        </div>\n    );\n};"
+            },
+            {
+              "label": "HTML",
+              "language": "html",
+              "code": "<div>\n    <p class=\"margin-top-0\">This demonstrates a bottom sheet use case on <b>mobile. </b>It demonstrates a bottom sheet for an example of how you could do onboarding on smartphones.</p>\n    <button class=\"btn btn-primary\" type=\"button\">Trigger mobile onboarding BottomSheet</button>\n</div>"
+            },
+            {
+              "label": "Props",
+              "language": "json",
+              "code": null,
+              "props": [
+                {
+                  "heading": null,
+                  "rows": [
+                    {
+                      "name": "show",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen."
+                    },
+                    {
+                      "name": "onClose",
+                      "type": "Function",
+                      "default": "() => {})",
+                      "description": "Callback for when the sheet closes."
+                    },
+                    {
+                      "name": "width",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a \"max-width-xxx\" via className to control it better."
+                    },
+                    {
+                      "name": "height",
+                      "type": "Number / String",
+                      "default": "",
+                      "description": "The height of the bottom sheet. If no height is given, the height is automatically calculated from the content."
+                    },
+                    {
+                      "name": "title",
+                      "type": "Node / String",
+                      "default": "",
+                      "description": "The title content shown in the header. If no title is given, the bottom sheet header is not shown."
+                    },
+                    {
+                      "name": "showCloseButton",
+                      "type": "Boolean",
+                      "default": "true",
+                      "description": "Defines whether or not the close button is shown."
+                    },
+                    {
+                      "name": "showMaximizeButton",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Defines whether or not the maximize button in the header is shown."
+                    },
+                    {
+                      "name": "onHeightChange",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "The callback function triggered when the maximize button is clicked and the height changes."
+                    },
+                    {
+                      "name": "detach",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to detach the bottom sheet from the left side and the bottom and create a little offset."
+                    },
+                    {
+                      "name": "detachOffset",
+                      "type": "Number",
+                      "default": "15",
+                      "description": "Defines the amount of pixels for the sheet."
+                    },
+                    {
+                      "name": "hasBackdrop",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Set to \"true\" to render a modal like backdrop to emphasize the bottom sheet."
+                    },
+                    {
+                      "name": "onBackdropClick",
+                      "type": "Function",
+                      "default": "() => {}",
+                      "description": "Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet."
+                    },
+                    {
+                      "name": "bodyRef",
+                      "type": "React Ref",
+                      "default": "",
+                      "description": "A react ref added to the bottom sheet body."
+                    },
+                    {
+                      "name": "bodyClassName",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the body element."
+                    },
+                    {
+                      "name": "className",
+                      "type": "String",
+                      "default": "",
+                      "description": "Additional classes to be set on the wrapping element."
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "heading": "TimedBottomSheet",
+      "body": "",
+      "examples": [
+        {
+          "caption": "Example 5",
+          "rendered_html": "<div class=\"playground-content  bg-white padding-20 padding-bottom-25\" style=\"width: 100%;\"><p>Showcase of a timed bottom sheet used for requesting feedback from the user after a major feature was released or updated.</p><button type=\"button\" class=\"btn btn-primary btn-component\" tabindex=\"0\">Trigger timed bottom sheet</button></div>",
+          "tabs": [
+            {
+              "label": "React",
+              "language": "tsx",
+              "code": "import { useState, useRef, useEffect, type MutableRefObject } from 'react';\nimport throttle from 'lodash/fp/throttle';\n\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport ToggleButton from '@rio-cloud/rio-uikit/ToggleButton';\nimport SimpleTooltip from '@rio-cloud/rio-uikit/SimpleTooltip';\nimport TimedBottomSheet from '@rio-cloud/rio-uikit/TimedBottomSheet';\nimport { motion } from '@rio-cloud/rio-uikit/framer-motion';\nimport useLocalStorage from '@rio-cloud/rio-uikit/useLocalStorage';\n\n/*\n * Don't forget to cleanup the localStorage for the user when removing a feature\n * by setting \"cleanupLocalStorage\" to \"true\" and deploy it like this.\n * The cleanup will remove the localStorage flag on mount and will not show the bottom sheet.\n */\n\nconst IS_DISABLED = false;\n\nconst SHOW_AFTER_IN_MS = 2_000; // 2 seconds\nconst HIDE_AFTER_IN_MS = 120_000; // 2 minutes\nconst HIDE_AFTER_SUBMIT_IN_MS = 2_000;\n\nexport const FeedbackBottomSheet = ({ onClose }: { onClose: VoidFunction }) => {\n    const [isDismissed, setIsDismissed] = useState(false);\n    const [isSubmitted, setIsSubmitted] = useState(false);\n    const [isPostponed, setIsPostponed] = useState(false);\n\n    const [rating, setRating] = useState<number>();\n\n    // Don't close itself if the user types in into the textfield or\n    // interacts with the bottom sheet\n    const [isDirty, setIsDirty] = useState(false);\n\n    const handleCloseBottomSheet = () => {\n        setIsDismissed(true);\n        onClose();\n    };\n\n    const handlePostpone = () => {\n        setIsPostponed(true);\n        onClose();\n    };\n\n    const handleRating = (value: number | undefined) => {\n        setIsDirty(true);\n        setRating(value);\n    };\n\n    const handleSubmit = (event: React.FormEvent<HTMLFormElement>) => {\n        // Avoid page reload on submit\n        event.preventDefault();\n\n        // Get form data of all inputs\n        const data = new FormData(event.target as HTMLFormElement);\n        console.log(Object.fromEntries(data.entries()));\n\n        sendFeedback(data.get('mapFeedbackText')?.toString() || '', rating);\n\n        // show thank you message and close bottom sheet after 5 sec\n        setIsSubmitted(true);\n\n        // After showing the thank you message, set the bottom sheet to dismissed, so it won't be\n        // shown again on next page load\n        setTimeout(() => {\n            setIsDismissed(true);\n            onClose();\n        }, HIDE_AFTER_SUBMIT_IN_MS);\n    };\n\n    const sendFeedback = (messageToSend: string, featureRating: number | undefined) => {\n        console.log(`Sending email with message \\n${messageToSend}`);\n    };\n\n    let hideTimeout: number | undefined = isSubmitted ? HIDE_AFTER_SUBMIT_IN_MS : HIDE_AFTER_IN_MS;\n    if (isDirty) {\n        hideTimeout = undefined;\n    }\n\n    if (isPostponed) {\n        return null;\n    }\n\n    return (\n        <TimedBottomSheet\n            featureName='mapUpdateFeedbackBottomSheet'\n            localStoragePrefix='uikit.'\n            dismissed={isDismissed}\n            showAfter={SHOW_AFTER_IN_MS}\n            hideAfter={hideTimeout}\n            onClose={handleCloseBottomSheet}\n            bodyClassName='padding-25'\n            className='width-400'\n            cleanupLocalStorage={IS_DISABLED}\n        >\n            {!isSubmitted && !isPostponed && (\n                <form onSubmit={handleSubmit}>\n                    <div className='text-size-18 text-medium'>Map update feedback</div>\n                    <p className='margin-top-5 margin-bottom-25 text-color-darker'>\n                        Please take a moment to tell us what you think of the new map update. Haven't noticed a change?{' '}\n                        <a href='#'>Read here what's new...</a>\n                    </p>\n                    <div className='text-color-darker text-medium'>Rate your experience with the map</div>\n                    <div className='btn-toolbar text-size-14 align-items-center margin-top-5 margin-bottom-25'>\n                        <div className='text-size-200pct text-color-danger rioglyph rioglyph-thumbs-down' />\n                        <ToggleButton\n                            active={rating === 1}\n                            onClick={(toggled: boolean) => handleRating(toggled ? 1 : undefined)}\n                        >\n                            1\n                        </ToggleButton>\n                        <ToggleButton\n                            active={rating === 2}\n                            onClick={(toggled: boolean) => handleRating(toggled ? 2 : undefined)}\n                        >\n                            2\n                        </ToggleButton>\n                        <ToggleButton\n                            active={rating === 3}\n                            onClick={(toggled: boolean) => handleRating(toggled ? 3 : undefined)}\n                        >\n                            3\n                        </ToggleButton>\n                        <ToggleButton\n                            active={rating === 4}\n                            onClick={(toggled: boolean) => handleRating(toggled ? 4 : undefined)}\n                        >\n                            4\n                        </ToggleButton>\n                        <ToggleButton\n                            active={rating === 5}\n                            onClick={(toggled: boolean) => handleRating(toggled ? 5 : undefined)}\n                        >\n                            5\n                        </ToggleButton>\n                        <div className='text-size-200pct text-color-success rioglyph rioglyph-thumbs-up' />\n                    </div>\n                    <div className='margin-bottom-15'>\n                        <div className='text-color-darker text-medium margin-bottom-5 margin-right-20'>\n                            Anything that can be improved or something you want to tell us\n                        </div>\n                        <textarea\n                            name='mapFeedbackText'\n                            className='form-control'\n                            cols={3}\n                            placeholder='Your feedback (optional)'\n                            onClick={() => setIsDirty(true)}\n                        />\n                    </div>\n                    <div className='btn-toolbar display-flex justify-content-end align-items-center margin-top-15'>\n                        <Button\n                            bsStyle='muted'\n                            className='hover-bg-lightest text-color-dark hover-text-color-darker'\n                            onClick={handlePostpone}\n                        >\n                            Ask me later\n                        </Button>\n                        {rating === undefined ? (\n                            <SimpleTooltip content='Please give a rating' placement='top'>\n                                <div>\n                                    <Button bsStyle='primary' type='submit' disabled>\n                                        Send feedback\n                                    </Button>\n                                </div>\n                            </SimpleTooltip>\n                        ) : (\n                            <Button bsStyle='primary' type='submit'>\n                                Send feedback\n                            </Button>\n                        )}\n                    </div>\n                </form>\n            )}\n            {isSubmitted && (\n                <motion.div\n                    initial={{ opacity: 0, x: 20 }}\n                    animate={{ opacity: 1, x: 0 }}\n                    className='display-flex gap-10 align-items-center'\n                >\n                    <div className='text-color-success text-size-20'>\n                        <span className='rioglyph rioglyph-ok-sign' />\n                    </div>\n                    <div className='text-medium text-color-darker text-size-16'>Thank you for your feedback</div>\n                </motion.div>\n            )}\n        </TimedBottomSheet>\n    );\n};\n\nexport default () => {\n    const [showFeedback, setShowFeedback] = useState(false);\n\n    // For demo purpose, we have to cleanup the local storage to show the bottom sheet again\n    const [, , removeFlag] = useLocalStorage('uikit.hideMapUpdateFeedbackBottomSheet', false);\n\n    const handleShowFeedback = () => {\n        removeFlag();\n\n        setTimeout(() => {\n            setShowFeedback(true);\n        });\n    };\n\n    const handleCloseFeedback = () => {\n        removeFlag();\n        setShowFeedback(false);\n    };\n\n    return (\n        <>\n            <p>\n                Showcase of a timed bottom sheet used for requesting feedback from the user after a major feature was\n                released or updated.\n            </p>\n            <Button bsStyle='primary' onClick={handleShowFeedback}>\n                Trigger timed bottom sheet\n            </Button>\n            {showFeedback && <FeedbackBottomSheet onClose={handleCloseFeedback} />}\n        </>\n    );\n};"
+            },
+            {
+              "label": "HTML",
+              "language": "html",
+              "code": "<p>Showcase of a timed bottom sheet used for requesting feedback from the user after a major feature was released or updated.</p>\n<button type=\"button\" class=\"btn btn-primary btn-component\" tabindex=\"0\">Trigger timed bottom sheet</button>"
+            },
+            {
+              "label": "Props",
+              "language": "json",
+              "code": null,
+              "props": [
+                {
+                  "heading": null,
+                  "rows": [
+                    {
+                      "name": "dismissed",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "The \"dismissed\" flag can be used to tell this component that the user has clicked on the content of the component like a button or a link. In this case, the bottom sheet will store a flag in the localStorage to hide the bottom sheet for the next time and it will close the sheet right away."
+                    },
+                    {
+                      "name": "featureName",
+                      "type": "String",
+                      "default": "0",
+                      "description": "The \"featureName\" prop is used to name the localStorage flag that is used to control the visibility. It should be unique to avoid conflicts with other timed bottom sheets."
+                    },
+                    {
+                      "name": "localStoragePrefix",
+                      "type": "String",
+                      "default": "",
+                      "description": "A prefix that will be used for the local storage flag to store whether the bottom sheet should be hidden. Use this prefix for your service name for instance."
+                    },
+                    {
+                      "name": "showAfter",
+                      "type": "Number",
+                      "default": "0",
+                      "description": "Defines the time in milliseconds when the bottom sheet shall be shown. Default value is 0 to show it right away."
+                    },
+                    {
+                      "name": "hideAfter",
+                      "type": "Number",
+                      "default": "3_600_000",
+                      "description": "Defines the time in milliseconds when the bottom sheet hides itself automatically. Default value is 3_600_000 to hide it after 1 hour. In this case, the localStorage flag is not set and the bottom sheet will be shown on the next page load."
+                    },
+                    {
+                      "name": "alwaysOn",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "With this enabled, the BottomSheet will not hide automatically."
+                    },
+                    {
+                      "name": "showCloseButton",
+                      "type": "Boolean",
+                      "default": "true",
+                      "description": "Enables or disabled the close button."
+                    },
+                    {
+                      "name": "width",
+                      "type": "Number",
+                      "default": "",
+                      "description": "Optional width of the bottom sheet. Alternatively, you can set a `max-width-xxx` via className instead."
+                    },
+                    {
+                      "name": "cleanupLocalStorage",
+                      "type": "Boolean",
+                      "default": "false",
+                      "description": "Flag to allow to remove the localStorage flag again once the component is not needed anymore."
+                    },
+                    {
+                      "name": "onClose",
+                      "type": "() => void",
+                      "default": "",
+                      "description": "Callback function that gets triggered when the user closed the bottom sheet with the close button."
+                    },
+                    {
+                      "name": "bodyClassName",
+                      "type": "String",
+                      "default": "",
+                      "description": "Optional className to be set on the body."
+                    },
+                    {
+                      "name": "className",
+                      "type": "String",
+                      "default": "",
+                      "description": "Optional className to be set on the component. Use this to define a max-width value."
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "see_also": []
+}