@fundamental-styles/mcp 0.41.7-rc.8 → 0.41.7

package/data/components/dialog-docs-static-busy-indicator.md

@@ -0,0 +1,165 @@
+---
+component: fd-dialog-docs-static
+title: Components/Busy Indicator
+category: Components
+selector: fd-dialog-docs-static
+cssFile: dialog-docs-static.css
+sourcePath: packages/styles/stories/Components/busy-indicator/busy-indicator.stories.js
+tags: []
+dependencies: ["bar","busy-indicator","button","dialog","message-toast","text","title"]
+relatedComponents: ["bar","busy-indicator","button","dialog","message-toast","text","title"]
+stability: stable
+generatedAt: 2026-06-09T18:29:01.580Z
+---
+
+# Components/Busy Indicator
+
+The busy indicator component informs the user about an ongoing operation. Only one busy indicator should be shown at a time.
+
+## Sizes
+
+| **Size** |    **rem**    | **Modifier class** |
+| :------- | :-------------------------------- | -----------------: |
+| Default  |    0.5 rem                | none               |
+| M        |    1 rem                | \
+
+## Dependencies
+
+This component depends on the following CSS files:
+
+- `bar.css`
+- `busy-indicator.css`
+- `button.css`
+- `dialog.css`
+- `message-toast.css`
+- `text.css`
+- `title.css`
+
+## Installation
+
+```bash
+npm install fundamental-styles
+```
+
+```html
+<!-- Include theme -->
+<link href="node_modules/fundamental-styles/dist/theming/sap_horizon.css" rel="stylesheet">
+
+<!-- Include component CSS -->
+<link href="node_modules/fundamental-styles/dist/dialog-docs-static.css" rel="stylesheet">
+
+<!-- Include dependencies -->
+<link href="node_modules/fundamental-styles/dist/bar.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/busy-indicator.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/button.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/dialog.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/message-toast.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/text.css" rel="stylesheet">
+<link href="node_modules/fundamental-styles/dist/title.css" rel="stylesheet">
+```
+
+## Basic Usage
+
+```html
+
+```
+
+## Related Components
+
+This component works with or depends on:
+
+- `bar`
+- `busy-indicator`
+- `button`
+- `dialog`
+- `message-toast`
+- `text`
+- `title`
+
+## Examples
+
+### Standard
+
+The standard busy indicator animates a sequence of cascading dots expanding and shrinking in a loop. The component comes in three sizes detailed above. To display the busy indicator, use the `fd-busy-indicator` class. If you want to display a certain size, add the modifier class of the desired size i.e. `--m` to the element.
+
+```html
+
+```
+
+### ContrastMode
+
+The busy indicator also comes in contrast mode and displays white dots against a dark background. To apply contrast mode, add `contrast` into the element i.e. `fd-busy-indicator--m contrast`.
+
+```html
+
+```
+
+### ExtendedBusyIndicator
+
+If more information needs to be displayed with the loading animation, it is replaced by the Extended Busy Indicator `fd-busy-indicator-extended`. The additional information is wrapped in an element with `fd-busy-indicator-extended__label` class.
+
+```html
+<div class="fd-busy-indicator-extended">
+
+    <div class="fd-busy-indicator-extended__label">loading data...</div>
+</div>
+```
+
+### ExtendedBusyIndicatorInsideMessageToast
+
+At the Page level the Busy Indicator should always be placed in a container. The simplest form of container will be centred on the page and inherit the color values from Message Toast.
+
+```html
+<div class="fd-message-toast fd-busy-indicator-extended fd-busy-indicator-extended--message-toast">
+
+    <div class="fd-busy-indicator-extended__label">loading data...</div>
+</div>
+```
+
+### BusyDialog
+
+The busy dialog informs the user about an ongoing operation. During the operation, the entire screen is blocked.
+
+```html
+<section class="fd-dialog-docs-static fd-dialog fd-dialog--active">
+    <div class="fd-dialog__content fd-dialog__content--s" role="dialog" aria-modal="true"
+        aria-labelledby="dialog-title-2">
+        <header class="fd-dialog__header fd-bar fd-bar--header">
+            <div class="fd-bar__left">
+                <div class="fd-bar__element">
+                    <h2 class="fd-title fd-title--h5" id="dialog-title-2">
+                        Loading Data
+                    </h2>
+                </div>
+            </div>
+        </header>
+        <div class="fd-dialog__body">
+            <div class="fd-busy-indicator-dialog">
+                <p class="fd-text">
+                    ... now loading data from a far far away server from far far away.
+                </p>
+
+            </div>
+        </div>
+        <footer class="fd-dialog__footer fd-bar fd-bar--footer">
+            <div class="fd-bar__right">
+                <div class="fd-bar__element">
+                    <button class="fd-dialog__decisive-button fd-button fd-button--transparent">Cancel</button>
+                </div>
+            </div>
+        </footer>
+    </section>
+```
+
+## Accessibility
+
+- Use semantic HTML elements where appropriate
+- Include proper ARIA attributes for interactive elements
+- Ensure keyboard navigation support
+- Provide adequate color contrast
+
+## Source
+
+This documentation was automatically generated from: `packages/styles/stories/Components/busy-indicator/busy-indicator.stories.js`
+
+For the latest updates and interactive examples, see [Storybook](https://sap.github.io/fundamental-styles/).