README.md

Getting started with MudX is easy:

1. Step 1: Install MudBlazor.

2. Step 2: Add the active MudX package via NuGet:

   dotnet add package MudX.MudBlazor.Extension

   Note: The plural MudX.MudBlazor.Extensions package ID is an older package line and is not the active package documented by this repository.

3. Step 3: Include the MudXProvider in your layout -or- reference ./_content/MudX.MudBlazor.Extension/_mudx.min.css and ./_content/MudX.MudBlazor.Extension/mudx.min.js in your project -with- cache busting.

4. Step 4: Start using components - all MudX components are prefixed with MudX, such as MudXOutline.

5. Step 5: Browse the documentation to learn how to use each component.

6. Step 6: Visit the MudX GitHub repo to report issues or request help.

7. Step 7: Try MudX in your browser with no setup required at Try MudBlazor with Extensions. 🚧 Under Construction 🚧

8. Step 8: Optionally update/change your MudBlazor theme at MudBlazor Theme Creator.

Table of Contents

• MudXSecurityCode
• MudXSheet
• MudXChat
• MudXOutline
• MudXCodeBlock
• MudXCopyToClipboard
• MudXBreadcrumbs
• Blazor Lottie Player]
• IdMasker

---

Components

MudXChat

A component for creating a chat interface with customizable MudXChatBubble components and headers and footers. Back to top

---

MudXSecurityCode

A segmented input component for security codes, such as SMS or email verification codes. Configurable placeholders and fixed characters also support segmented pattern masks for values such as dates and formatted identifiers.

Back to top

---

MudXSheet

A sheet component that displays contextual content from the top, bottom, left, right, or center of the screen for mobile and desktop layouts.

Back to top

---

MudXOutline

A scrollspy component that highlights the current section in a sidebar as you scroll through the page.

Back to top

---

MudXCodeBlock

A component for displaying code snippets with Prism syntax highlighting and customizable themes.

Back to top

---

MudXCopyToClipboard

A component that allows users to copy text to the clipboard with access to an extension method.

Back to top

---

MudXBreadcrumbs

A self-navigating breadcrumb navigation component that supports custom separators and icons.

Back to top

---

Blazor Lottie Player

A Blazor component for rendering Lottie animations, downloadable separately from MudX but designed and maintained by the MudX team.
Back to top

---

Utilities

IdMasker

A static utility for creating human-friendly obfuscated IDs with IdMasker.MaskId and restoring them with IdMasker.UnMaskId. The masked values are not cryptographically secure.

Back to top