@rio-cloud/uikit-mcp 1.0.1 → 1.1.1

package/dist/docs/components/divider.md

@@ -0,0 +1,219 @@
+# Divider
+
+*Category:* Components
+*Section:* Misc
+*Source:* https://uikit.developers.rio.cloud/#components/divider
+*Captured:* 2025-12-12T14:20:53.850Z
+
+## Divider
+
+### Example: 2024-01-01
+
+Default divider
+
+Custom spacing value
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Vertical divider
+Some button
+
+Some button
+
+Used as spacer without a line
+
+With a title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Some kind of title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+With a customized title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+2024-01-01
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+#### Summary
+
+Default divider
+
+Custom spacing value
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Vertical divider
+Some button
+
+Some button
+
+Used as spacer without a line
+
+With a title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+Some kind of title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+With a customized title
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+2024-01-01
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.
+
+#### React (tsx)
+
+```tsx
+import { dummyTextShort } from '../../../utils/data';
+
+import Divider from '@rio-cloud/rio-uikit/Divider';
+import Button from '@rio-cloud/rio-uikit/Button';
+
+export default () => (
+    <div className='display-grid gap-50'>
+        <div>
+            <h5>Default divider</h5>
+            <Divider />
+        </div>
+        <div>
+            <h5>Custom spacing value</h5>
+            <div>{dummyTextShort}</div>
+            <Divider spacing={20} />
+            <div>{dummyTextShort}</div>
+        </div>
+        <div>
+            <h5>Vertical divider</h5>
+            <div className='display-flex'>
+                <Button>Some button</Button>
+                <Divider vertical className='padding-y-2' />
+                <Button>Some button</Button>
+            </div>
+        </div>
+        <div>
+            <h5>Used as spacer without a line</h5>
+            <Divider spacing={30} asSpacer className='border border-style-dashed rounded' />
+        </div>
+        <div>
+            <h5>With a title</h5>
+            <div>{dummyTextShort}</div>
+            <Divider spacing={35}>
+                <div className='tag tag-small'>Some kind of title</div>
+            </Divider>
+            <div>{dummyTextShort}</div>
+        </div>
+        <div>
+            <h5>With a customized title</h5>
+            <div>{dummyTextShort}</div>
+            <Divider spacing={30} dividerColor='lighter' dividerWidth={2} titleAlignment='left'>
+                <div className='border border-color-lighter rounded text-color-dark padding-x-10 text-size-12 text-medium'>
+                    2024-01-01
+                </div>
+            </Divider>
+            <div>{dummyTextShort}</div>
+        </div>
+    </div>
+);
+```
+
+#### HTML (html)
+
+```html
+<div class="display-grid gap-50">
+    <div>
+        <h5>Default divider</h5>
+        <div class="Divider position-relative width-100pct" style="padding-top: 15px; padding-bottom: 15px;">
+            <div class="divider-line bg-light" style="width: 100%; height: 1px;">
+            </div>
+        </div>
+    </div>
+    <div>
+        <h5>Custom spacing value</h5>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+        <div class="Divider position-relative width-100pct" style="padding-top: 20px; padding-bottom: 20px;">
+            <div class="divider-line bg-light" style="width: 100%; height: 1px;">
+            </div>
+        </div>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+    </div>
+    <div>
+        <h5>Vertical divider</h5>
+        <div class="display-flex">
+            <button type="button" class="btn btn-default btn-component" tabindex="0">Some button</button>
+            <div class="Divider position-relative padding-y-2" style="padding-left: 15px; padding-right: 15px;">
+                <div class="divider-line bg-light" style="width: 1px; height: 100%;">
+                </div>
+            </div>
+            <button type="button" class="btn btn-default btn-component" tabindex="0">Some button</button>
+        </div>
+    </div>
+    <div>
+        <h5>Used as spacer without a line</h5>
+        <div class="Divider position-relative width-100pct border border-style-dashed rounded" style="padding-top: 30px; padding-bottom: 30px;">
+        </div>
+    </div>
+    <div>
+        <h5>With a title</h5>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+        <div class="Divider position-relative width-100pct" style="padding-top: 35px; padding-bottom: 35px;">
+            <div class="divider-title display-flex align-items-center">
+                <div class="flex-1-0">
+                    <div class="divider-line bg-light" style="width: 100%; height: 1px;">
+                    </div>
+                </div>
+                <div class="">
+                    <div class="tag tag-small">Some kind of title</div>
+                </div>
+                <div class="flex-1-0">
+                    <div class="divider-line bg-light" style="width: 100%; height: 1px;">
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+    </div>
+    <div>
+        <h5>With a customized title</h5>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+        <div class="Divider position-relative width-100pct" style="padding-top: 30px; padding-bottom: 30px;">
+            <div class="divider-title display-flex align-items-center">
+                <div class="">
+                    <div class="border border-color-lighter rounded text-color-dark padding-x-10 text-size-12 text-medium">2024-01-01</div>
+                </div>
+                <div class="flex-1-0">
+                    <div class="divider-line bg-lighter" style="width: 100%; height: 2px;">
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
+    </div>
+</div>
+```
+
+#### Props
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| spacing | number | 15 | The amount of space to either side |
+| dividerWidth | 1 \| 2 \| 3 | 1 | Defines the width of the divider line |
+| dividerColor | 'darkest' \| 'darker' \| 'dark' \| 'gray' \| 'light' \| 'lighter' \| 'lightest'3' | light | Defines the color of the divider line |
+| asSpacer | boolean | false | Use the component as a spacer element without the divider line |
+| vertical | boolean | false | Set the orientation for the divider line to vertical. This may be useful for button toolbars or elements on a single row. |
+| titleAlignment | 'left' \| 'center' \| 'right' | center | Defines where the children are aligned on the divider line |
+| className | string | — | Additional classes to be set on the wrapper element. |