@redis-ui/components 43.0.2 → 44.0.1

package/skills/redis-ui-components/references/Loader.md

@@ -0,0 +1,106 @@
+# Loader
+
+A visual loading indicator with optional text, inline layout, and variant-based coloring.
+
+## Import
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+```
+
+## Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| size | `LoaderSize` | `'XL'` | Predefined loader size |
+| inline | `boolean` | `false` | Renders the loader inline with surrounding content |
+| loaderText | `string` | - | Text shown next to the loader |
+| dataTestId | `string` | - | Deprecated test id for the SVG element |
+| variant | `LoaderVariants` | `regular` | Visual color variant |
+| other div props | `React.HTMLAttributes<HTMLDivElement>` | - | Standard container props forwarded to the loader wrapper |
+
+### `LoaderVariants`
+
+`'regular' | 'pending' | 'inverse'`
+
+### `LoaderSize`
+
+`'XS' | 'S' | 'M' | 'L' | 'XL'`
+
+## Examples
+
+### Playground
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+
+<Loader size="XL" inline={false} loaderText="" variant="regular" />
+```
+
+### Sizes
+
+> Loaders support predefined t-shirt sizes. If you do not provide a value to the `size` prop, the size of the loader will default to `XL`.
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+
+<>
+  <Loader size="XS" />
+  <Loader size="S" />
+  <Loader size="M" />
+  <Loader size="L" />
+  <Loader size="XL" />
+</>
+```
+
+### WithText
+
+> Provide `loaderText` to show text below the loader.
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+
+<Loader loaderText="Loader Text" />
+```
+
+### Inline
+
+> Set `inline` to `true` to place the loader alongside surrounding text.
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+
+<>
+  <span>
+    Hello, all loader learners. This is an example of text with an inline loader:{' '}
+    <Loader inline /> This loader is displayed inline.
+  </span>
+  <Loader />
+</>
+```
+
+### Variants
+
+> The `variant` prop changes the loader and loader text color. The inverse variant is shown on a dark background.
+
+```tsx
+import { Loader } from '@redislabsdev/redis-ui-components';
+import { theme } from '@redislabsdev/redis-ui-styles';
+
+const inverseBackground = theme.semantic.color.icon.neutral500;
+
+<>
+  <Loader variant="regular" loaderText="Regular Loader Text" />
+  <Loader variant="pending" loaderText="Pending Loader Text" />
+  <div style={{ backgroundColor: inverseBackground }}>
+    <Loader variant="inverse" loaderText="Inverse Loader Text" />
+  </div>
+</>
+```
+
+## Notes
+
+- `size` falls back to `M` when omitted.
+- `loaderText` replaces the hidden accessibility label.
+- `inline` changes the layout but not the loading semantics.
+- `dataTestId` is deprecated; use `data-testid` instead.