MDB Angular UI Kit Documentation

repository·master·Indexed 22 days ago

https://github.com/mdbootstrap/mdb-angular-ui-kit

A comprehensive collection of over 700 Bootstrap 5 and Material Design components built for Angular 21. The kit includes a wide range of UI elements such as buttons, cards, carousels, dropdowns, tabs, and validation components. It provides an MIT-licensed foundation for developers with installation options via npm, .zip, cdnjs, or the `ng add mdb-angular-ui-kit` schematic.

Tokens
2.5K
Snippets
13
Records
19
Agent score
78%

What's inside MDB Angular UI Kit

  1. Explore MDB Angular UI Kit Components

    master

    The MDB Angular UI Kit provides over 700 components based on Bootstrap 5 and Material Design. Key component categories include:

    • Buttons: Custom styles for various sizes and states.
    • Spinners: Loading indicators built with HTML and CSS (no JavaScript required).
    • Cards: Flexible content containers with headers, footers, and contextual backgrounds.
    • Footer: Navigation components for links, buttons, and company info.
    • Hover Effects: Interactive hover styles for elements.
    • Notes: Small components for inserting additional information (alerts/typography).

    Detailed documentation and practical examples for each component can be found in the MDB Angular Docs.

  2. Install MDB 5 Angular

    master

    To use MDB 5 Angular in your project, follow the official installation guide to set up the components and styles. Detailed steps for different environments are available at the official documentation site.

    https://mdbootstrap.com/docs/angular/getting-started/installation/
  3. Install with MDBGO

    master

    MDBGO is a hosting and deployment solution that provides:

    • Free Hosting and WordPress support
    • Custom domains and SSL support
    • Free database
    • Frontend & backend templates
    • Webpack starter included
    • Git repository, FTP, and Jenkins support

    You can also use MDBGO + e-commerce shop integration for a one-click setup to create WordPress pages, travel blogs, or e-commerce shops.

  4. Use ng add to install MDB Angular UI Kit

    master

    The ngAdd schematic automates the installation of the MDB Angular UI Kit into an Angular project. When executed via ng add mdb-angular-ui-kit, it performs the following actions:

    1. Adds Core Dependencies: Automatically adds @angular/cdk, @angular/forms, and @angular/animations (targeting version ^21.0.0) to your package.json.
    2. Conditional Add-ons:
      • If fontAwesome is enabled in the options, it adds @fortawesome/fontawesome-free (^6.0.0).
      • If charts is enabled in the options, it adds chart.js (^3.1.1).
    3. Dependency Installation: Triggers a NodePackageInstallTask to install the newly added packages.
    4. Post-Installation Setup: Runs a secondary schematic ng-add-mdb-setup after the main dependencies are installed to complete the configuration.
    ng add mdb-angular-ui-kit --fontAwesome --charts
  5. Access Extended MDB Angular Features

    master

    MDB provides extended documentation and specialized components for advanced UI requirements, including:

    • Navigation & Menus: Hamburger Menus, Mega Menus, and Pagination.
    • Data Display: Masonry layouts, Table Search, Table Scroll, Table Responsive, and Table Sort.
    • Content Containers: Jumbotrons, Panels, and Media Objects.
    • Input & Interaction: Multiselect, Textarea, Search, and Contact forms.
    • Visual Styles: Gradients, Social Media Icons & Buttons, and Maps.
  6. Use the MDB Angular Tabs component

    master

    The Tabs component is exported via the projects/mdb-angular-ui-kit/tabs/index.ts entrypoint. To use the Tabs functionality in your Angular application, you must import the exported members from the public API of the tabs module. This component allows for creating navigable tabbed interfaces following Material Design principles.

    import { MdbTabsModule } from 'mdb-angular-ui-kit/tabs';
    
    // Import the module in your Angular NgModule or Standalone Component
    @NgModule({
      imports: [MdbTabsModule],
      // ...
    });
  7. Use the Ripple component

    master

    The Ripple component provides a Material Design-style ripple effect when interacting with elements. The public API for the Ripple component is exported from the ripple entrypoint. To use it, you typically import the necessary modules from the mdb-angular-ui-kit/ripple path and apply the ripple directive to your HTML elements.

    import { MdbRippleModule } from 'mdb-angular-ui-kit/ripple';
    
    // In your Angular module:
    @NgModule({
      imports: [MdbRippleModule],
      // ...
    })
    export class AppModule { }
    
    // In your component template:
    // <button mdbRipple>Click me</button>
  8. Use the Collapse component from MDB Angular UI Kit

    master

    The Collapse component is part of the MDB Angular UI Kit. To use it, you must import the module or the component from the public API. This component is typically used to create expandable/collapsible sections in your UI.

    import { MDBCollapseModule } from 'mdb-angular-ui-kit';
    
    // In your Angular module:
    @NgModule({
      imports: [MDBCollapseModule],
      // ...
    })
    export class AppModule { }