Laravel Metronic

https://preview.keenthemes.com/laravel/metronic/docs/
Admin
Metronic is an advanced Bootstrap 5 foundation and theme designed to rapidly build modern Laravel...
Tokens:19,272
Snippets:145
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Metronic Laravel Getting Started

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Guide to setting up and running a Metronic-based Laravel project quickly. Assumes Metronic purchase and download.

```APIDOC
Getting Started:
  Purpose: Create and run your Metronic based Laravel project in 5 minutes.
  Prerequisites:
    - Purchased and downloaded Metronic.
  Steps:
    - Follow the instructions in this section to set up your project.
  Related Sections:
    - Overview
    - File Structure
    - Settings
```

--------------------------------

### Metronic Laravel Quick Installation

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Instructions for quickly setting up a Laravel project with Metronic using Composer and Webpack Mix build tools. This process is designed to get your project running in minutes.

```APIDOC
Quick Installation:
  - Install latest Composer.
  - Use custom Webpack Mix build tools.
  - Get project up and running quickly.
```

--------------------------------

### Controller Helper Usage Example - Get Asset Path

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `asset` from a controller to get an asset path.

```php
helpers.asset('media/logos/logo.svg')
```

--------------------------------

### View Helper Usage Example - Get Vendors

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getVendors` to retrieve vendor files from settings in a Blade view.

```html
{{ getVendors('js') }}
```

--------------------------------

### Keenthemes Laravel Metronic Documentation Navigation

Source: https://preview.keenthemes.com/laravel/metronic/docs/updates

Provides links to various sections of the Keenthemes Laravel Metronic documentation, including overview, getting started, file structure, settings, RTL, theme API, assets, views, updates, and changelog.

```APIDOC
Overview: https://preview.keenthemes.com/laravel/metronic/docs/index
Getting Started: https://preview.keenthemes.com/laravel/metronic/docs/getting-started
File Structure: https://preview.keenthemes.com/laravel/metronic/docs/file-structure
Settings: https://preview.keenthemes.com/laravel/metronic/docs/settings
RTL: https://preview.keenthemes.com/laravel/metronic/docs/rtl
Theme API: https://preview.keenthemes.com/laravel/metronic/docs/theme-api
Assets: https://preview.keenthemes.com/laravel/metronic/docs/assets
Views: https://preview.keenthemes.com/laravel/metronic/docs/views
Updates: https://preview.keenthemes.com/laravel/metronic/docs/updates
Changelog: https://preview.keenthemes.com/laravel/metronic/docs/changelog
```

--------------------------------

### Controller Helper Usage Example - Get Icon

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getIcon` from a controller to get SVG icon content.

```php
helpers.getIcon('calendar', 'fs-1 text-primary', 'duotone')
```

--------------------------------

### Install Node Modules

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Installs all the JavaScript dependencies required for the project, as defined in the 'package.json' file, using NPM.

```bash
npm install
```

--------------------------------

### Controller Helper Usage Example - Get Name

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of calling the `getName` helper function from a Laravel controller.

```php
helpers.getName()
```

--------------------------------

### Install Composer Dependencies

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Installs all the PHP dependencies required by the Laravel project as defined in the 'composer.json' file.

```bash
composer install
```

--------------------------------

### Controller Helper Usage Example - Get Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getDirection` from a controller to get the style direction.

```php
helpers.getDirection()
```

--------------------------------

### View Helper Usage Example - Get Asset Path

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `asset` to get the path to an asset file in a Blade view.

```html
{{ asset('media/logos/logo.svg') }}
```

--------------------------------

### Metronic Settings

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Guide to theme configuration and settings for Metronic.

```APIDOC
Settings:
  Description: Covers theme configuration and settings for Metronic.
  Purpose:
    - Allows customization of theme appearance and behavior.
  Related Sections:
    - Overview
    - Theme API
    - Assets
```

--------------------------------

### Create .env File (Windows)

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Copies the example environment file to create a new '.env' file on Windows systems.

```bash
copy .env.example .env
```

--------------------------------

### View Helper Usage Example - Get Global Assets

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getGlobalAssets` to retrieve global assets in a Blade view.

```html
{{ getGlobalAssets('css') }}
```

--------------------------------

### View Helper Usage Example - Get Icon

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getIcon` to display a Keenicon with specific classes and type in a Blade view.

```html
{{ getIcon('calendar', 'fs-1 text-primary', 'duotone') }}
```

--------------------------------

### View Helper Usage Example - Get Custom JS

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getCustomJs` to retrieve custom JavaScript files from settings in a Blade view.

```html
{{ getCustomJs }}
```

--------------------------------

### View Helper Usage Example

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of how to use the `getName` helper function within a Blade view.

```html
{{ getName() }}
```

--------------------------------

### Verify Composer Installation

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Checks if Composer is installed and displays its version. This is a crucial first step to ensure package management is set up correctly.

```bash
composer --version
```

--------------------------------

### Create .env File (Linux/Mac)

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Copies the example environment file to create a new '.env' file, which will store application-specific configuration settings.

```bash
cp .env.example .env
```

--------------------------------

### Serve Laravel Application

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Starts the local development server for the Laravel application. This command will listen for file changes and automatically reload the application.

```bash
php artisan serve
```

--------------------------------

### View Helper Usage Example - Add Vendor

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addVendor` to add a single vendor asset to the page in a Blade view.

```html
{{ addVendor('apexcharts') }}
```

--------------------------------

### View Helper Usage Example - Add Vendors

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addVendors` to add multiple vendor assets to the page in a Blade view.

```html
{{ addVendors(['datatables', 'select2']) }}
```

--------------------------------

### View Helper Usage Example - Get Custom CSS

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getCustomCss` to retrieve custom CSS files from settings in a Blade view.

```html
{{ getCustomCss }}
```

--------------------------------

### Controller Helper Usage Example - Get Default Mode

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getModeDefault` from a controller to get the current default theme mode.

```php
helpers.getModeDefault()
```

--------------------------------

### Controller Helper Usage Example - Print HTML Classes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `printHtmlClasses` from a controller to render HTML classes for a scope.

```php
helpers.printHtmlClasses('content', false)
```

--------------------------------

### View Helper Usage Example - Include Favicon

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `includeFavicon` to include the favicon in a Blade view.

```html
{{ includeFavicon() }}
```

--------------------------------

### View Helper Usage Example - Get Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getDirection` to retrieve the current layout direction in a Blade view.

```html
{{ getDirection() }}
```

--------------------------------

### Controller Helper Usage Example - Set Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setDirection` from a controller to set the style direction.

```php
helpers.setDirection('rtl')
```

--------------------------------

### Metronic Theme API Documentation

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Details on the Metronic Theme API, including available functions, parameters, and usage examples for theme customization and integration.

```APIDOC
Theme API:
  - Provides access to theme functionalities for customization and control.
  - Key areas include layout configuration, component management, and utility functions.

Example Usage:
  // Initialize a specific theme component
  KTLayout.init();

  // Configure layout settings
  KTLayout.setConfig({
    'header': {
      'display': true,
      'fixed': true
    }
  });

  // Access theme assets
  const themeAssets = KTTheme.getAssets();

```

--------------------------------

### Controller Helper Usage Example - Print HTML Attributes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `printHtmlAttributes` from a controller to render HTML attributes for a scope.

```php
helpers.printHtmlAttributes('body')
```

--------------------------------

### Controller Helper Usage Example - Set Default Mode

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setModeDefault` from a controller to set the default theme mode.

```php
helpers.setModeDefault('dark')
```

--------------------------------

### View Helper Usage Example - Include Fonts

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `includeFonts` to include theme fonts in a Blade view.

```html
{{ includeFonts() }}
```

--------------------------------

### View Helper Usage Example - Add Javascript File

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addJavascriptFile` to add a custom JavaScript file in a Blade view.

```html
{{ addJavascriptFile('js/custom/my-script.js') }}
```

--------------------------------

### View Helper Usage Example - Add CSS File

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addCssFile` to add a custom CSS file in a Blade view.

```html
{{ addCssFile('css/custom/my-styles.css') }}
```

--------------------------------

### Metronic Update Steps

Source: https://preview.keenthemes.com/laravel/metronic/docs/updates

Provides a step-by-step guide for updating Metronic in a Laravel project. This includes backing up files, reviewing changelogs, replacing source folders, updating dependencies, and manually comparing/updating code.

```bash
1. Backup all your files (your project folder and Metronic's's older version).
2. Review Metronics changelog to have a quick preview on what has been updated.
3. Unzip the latest version of Metronic and then browse through the elements (layout, widgets, plugins, etc) that you have used on your project.
4. Get the latest version use it instead the previous version.
5. Manually replace the `src` folder.
6. Run `npm install install` task to update 3rd party plugins with their latest versions.
7. Compare your project's code vs the latest version of Metronics code.
8. Manually update the HTML code where necessary by using code compare tools.
9. Save and test your project files with Metronic's updated elements.
```

--------------------------------

### View Helper Usage Example - Get HTML Attribute

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getHtmlAttribute` to retrieve a specific HTML attribute for a scope in a Blade view.

```html
{{ getHtmlAttribute('body', 'data-theme') }}
```

--------------------------------

### Controller Helper Usage Example - Set Dark Mode Switch

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setModeSwitch` from a controller to set the dark mode enabled status.

```php
helpers.setModeSwitch(true)
```

--------------------------------

### View Helper Usage Example - Get Default Mode

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `getModeDefault` to retrieve the current default theme mode in a Blade view.

```html
{{ getModeDefault() }}
```

--------------------------------

### Controller Helper Usage Example - Add HTML Class

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlClass` from a controller to add a CSS class to a scope.

```php
helpers.addHtmlClass('sidebar', 'menu-active')
```

--------------------------------

### View Helper Usage Example - Print HTML Classes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `printHtmlClasses` to render HTML classes for a scope in a Blade view.

```html
{{ printHtmlClasses('content', false) }}
```

--------------------------------

### Controller Helper Usage Example - Add HTML Attribute

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlAttribute` from a controller to add an HTML attribute to a scope.

```php
helpers.addHtmlAttribute('body', 'data-theme', 'dark')
```

--------------------------------

### Controller Helper Usage Example - Check RTL Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `isRtlDirection` from a controller to check if the style direction is RTL.

```php
helpers.isRtlDirection()
```

--------------------------------

### View Helper Usage Example - Print HTML Attributes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `printHtmlAttributes` to render HTML attributes for a scope in a Blade view.

```html
{{ printHtmlAttributes('body') }}
```

--------------------------------

### View Helper Usage Example - Set Default Mode

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setModeDefault` to set the initial theme mode (dark or light) in a Blade view.

```html
{{ setModeDefault('dark') }}
```

--------------------------------

### Controller Helper Usage Example - Add Multiple HTML Attributes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlAttributes` from a controller to add multiple HTML attributes to a scope.

```php
helpers.addHtmlAttributes('header', ['data-bs-theme' => 'dark', 'data-layout' => 'compact'])
```

--------------------------------

### Controller Helper Usage Example - Check Dark Mode Status

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `isModeSwitchEnabled` from a controller to check the dark mode status.

```php
helpers.isModeSwitchEnabled()
```

--------------------------------

### View Helper Usage Example - Set Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setDirection` to set the layout direction (RTL or LTR) in a Blade view.

```html
{{ setDirection('rtl') }}
```

--------------------------------

### Metronic Theme API Documentation

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

Details on the Metronic Theme API, which allows for programmatic control and customization of theme features. This includes available functions, parameters, and usage examples for integrating Metronic's capabilities into your Laravel application.

```APIDOC
Theme API:
  - Provides programmatic access to Metronic's features.
  - Enables customization and integration within Laravel applications.
  - Refer to the official documentation for specific function signatures and usage examples.
```

--------------------------------

### View Helper Usage Example - Set Dark Mode Switch

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `setModeSwitch` to enable or disable the dark mode toggle in a Blade view.

```html
{{ setModeSwitch(true) }}
```

--------------------------------

### View Helper Usage Example - Extend CSS Filename

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `extendCssFilename` to modify a CSS filename in a Blade view.

```html
{{ extendCssFilename('style.css') }}
```

--------------------------------

### View Helper Usage Example - Add HTML Class

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlClass` to add a CSS class to a scope in a Blade view.

```html
{{ addHtmlClass('sidebar', 'menu-active') }}
```

--------------------------------

### View Helper Usage Example - Add HTML Attribute

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlAttribute` to add an HTML attribute to a scope in a Blade view.

```html
{{ addHtmlAttribute('body', 'data-theme', 'dark') }}
```

--------------------------------

### View Helper Usage Example - Add Multiple HTML Attributes

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `addHtmlAttributes` to add multiple HTML attributes to a scope in a Blade view.

```html
{{ addHtmlAttributes('header', {'data-bs-theme': 'dark', 'data-layout': 'compact'}) }}
```

--------------------------------

### View Helper Usage Example - Check Dark Mode Status

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `isModeSwitchEnabled` to check if dark mode is enabled in a Blade view.

```html
{{ isModeSwitchEnabled() }}
```

--------------------------------

### Metronic Laravel Starter Kit

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

A powerful starter kit for Laravel projects based on the Metronic theme. It aims to save development time by providing a pre-configured foundation with essential components and utilities.

```APIDOC
Starter Kit:
  - Foundation for new Laravel projects.
  - Based on Metronic theme.
  - Accelerates development by providing pre-built components and structure.
```

--------------------------------

### Navigate to Starter Kit Directory

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Changes the current directory in the terminal to the 'starterkit' folder, which is necessary for executing subsequent project-specific commands.

```bash
cd starterkit
```

--------------------------------

### Metronic Updates

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Information on Metronic theme updates and how to apply them.

```APIDOC
Updates:
  Description: Details on Metronic theme updates, including changelogs and update procedures.
  Purpose:
    - To stay informed about new features, bug fixes, and improvements.
  Related Sections:
    - Changelog
    - Getting Started
```

--------------------------------

### Theme API - HTML Attribute Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Functions for adding, getting, and printing HTML attributes and classes by scope. These helpers allow dynamic manipulation of HTML elements within the theme.

```APIDOC
addHtmlAttribute(scope, name, value)
  - Adds a single HTML attribute to a specified scope.
  - Parameters:
    - scope: The scope identifier (e.g., 'body', 'header').
    - name: The name of the HTML attribute (e.g., 'class', 'id').
    - value: The value of the HTML attribute.

addHtmlAttributes(scope, attributes)
  - Adds multiple HTML attributes to a specified scope.
  - Parameters:
    - scope: The scope identifier.
    - attributes: An associative array of attribute names and values.

addHtmlClass(scope, value)
  - Adds a single HTML class to a specified scope.
  - Parameters:
    - scope: The scope identifier.
    - value: The HTML class to add.

printHtmlAttributes(scope)
  - Prints all HTML attributes for a given scope.
  - Parameters:
    - scope: The scope identifier.
  - Returns: A string of HTML attributes.

printHtmlClasses(scope, full = true)
  - Prints HTML classes for a given scope.
  - Parameters:
    - scope: The scope identifier.
    - full: Boolean to determine if full class string is returned (defaults to true).
  - Returns: A string of HTML classes.

getHtmlAttribute(scope, attribute)
  - Retrieves a specific HTML attribute based on the scope.
  - Parameters:
    - scope: The scope identifier.
    - attribute: The name of the attribute to retrieve.
  - Returns: The value of the specified attribute.
```

--------------------------------

### Metronic View Templates

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Documentation on Metronic's view templates.

```APIDOC
Views:
  Description: Information about the view templates provided by Metronic.
  Purpose:
    - To understand the structure and usage of pre-built UI components and layouts.
  Related Sections:
    - Overview
    - File Structure
```

--------------------------------

### Metronic Templates Usage

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Instructions on building dynamic interfaces with pre-made Metronic layouts and partials.

```APIDOC
Metronic Templates:
  Functionality: Build dynamic interfaces with pre-made Metronic layouts and partials.
  Documentation Link: https://preview.keenthemes.com/laravel/metronic/docs/views
```

--------------------------------

### Metronic Theme API

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Documentation for the Metronic Theme API, detailing its functionalities and usage.

```APIDOC
Theme API:
  Description: Provides access to Metronic's theme functionalities and configurations.
  Usage:
    - Refer to the Theme API documentation for specific methods and parameters.
  Related Sections:
    - Overview
    - Settings
    - Assets
```

--------------------------------

### Run Laravel Migrations and Seeders

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Applies all database migrations and runs seeders to populate the database with initial data. The '--fresh' flag ensures the database is reset before migrations are run.

```bash
php artisan migrate:fresh --seed
```

--------------------------------

### KTTheme API Overview

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Provides an overview of the KTTheme API class for efficiently using Metronic templates in Laravel projects.

```APIDOC
KTTheme API Class:
  Purpose: Efficiently use Metronic templates in Laravel projects of any complexity.
  Language: Python
  Documentation Link: https://preview.keenthemes.com/laravel/metronic/docs/theme-api
```

--------------------------------

### Metronic RTL Support

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Instructions on enabling Right-to-Left (RTL) support in Metronic.

```APIDOC
RTL:
  Description: Instructions for enabling Right-to-Left (RTL) layout support in Metronic.
  Purpose:
    - To adapt the theme for languages that read from right to left.
  Related Sections:
    - Overview
    - Settings
```

--------------------------------

### Keenthemes Laravel Metronic Theme Appearance Options

Source: https://preview.keenthemes.com/laravel/metronic/docs/updates

Provides links to documentation for different theme appearance modes in Keenthemes Laravel Metronic, including Light, Dark, and System default.

```APIDOC
Light: https://preview.keenthemes.com/laravel/metronic/docs/updates
Dark: https://preview.keenthemes.com/laravel/metronic/docs/updates
System: https://preview.keenthemes.com/laravel/metronic/docs/updates
```

--------------------------------

### Build Theme Assets

Source: https://preview.keenthemes.com/laravel/metronic/docs/assets

Commands to build the theme assets for the Metronic Laravel project. This process compiles SASS, JavaScript, and media files into the `public` folder, preparing the application for deployment or development.

```bash
cd starterkit
```

```bash
npm install
```

```bash
npm run dev
```

--------------------------------

### Livewire Version Updates and Refactoring

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Details updates to Livewire versions and refactoring of mutation handling. Includes implementation of `wire:current` directive for active link highlighting and conditional update routes.

```javascript
Refactor mutation handling in livewire.esm.js.
Implement wire:current directive for active link highlighting.
Modify Livewire update route to be conditional based on the production environment.
```

```laravel
Update Livewire to version 3.14.7.
Upgrade Livewire version 3.5.
Upgrade Livewire v3
```

--------------------------------

### View Helper Usage Example - Check RTL Direction

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Example of using `isRtlDirection` to check if the layout direction is RTL in a Blade view.

```html
{{ isRtlDirection() }}
```

--------------------------------

### Metronic Changelog

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

The changelog for Metronic theme versions.

```APIDOC
Changelog:
  Description: A record of changes, new features, and bug fixes for each Metronic version.
  Purpose:
    - To track the evolution of the theme and understand changes between versions.
  Related Sections:
    - Updates
    - Getting Started
```

--------------------------------

### Theme API - Product and Asset Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Functions for retrieving product information and managing asset paths, including icons and custom files.

```APIDOC
getName()
  - Gets the product name.
  - Returns: The product name string.

getIcon($name, $class = '', $type = '')
  - Gets the Keenicons icon code.
  - Parameters:
    - name: The name of the icon.
    - class: Optional CSS classes for the icon.
    - type: Optional icon type (e.g., 'duotone').
  - Returns: SVG icon code string.

asset(path)
  - Gets an asset path within the assets folder.
  - Parameters:
    - path: The relative path to the asset.
  - Returns: The full asset path string.

addJavascriptFile(file)
  - Adds a custom JavaScript file to the page.
  - Parameters:
    - file: The path to the JavaScript file.

addCssFile(file)
  - Adds a custom CSS file to the page.
  - Parameters:
    - file: The path to the CSS file.
```

--------------------------------

### Keenthemes Metronic Framework Options

Source: https://preview.keenthemes.com/laravel/metronic/docs/updates

Lists the available framework integrations for Keenthemes Metronic, including HTML, Vue, React, Angular, ASP.NET Core, Node.js, Blazor, Spring, Laravel, Django, Rails, Flask, and Symfony. Some integrations are marked as 'Soon'.

```APIDOC
HTML: https://preview.keenthemes.com/html/metronic/docs/
Vue: https://preview.keenthemes.com/metronic8/vue/docs/#/doc-overview
React: https://preview.keenthemes.com/metronic8/react/docs/quick-start
Angular: https://preview.keenthemes.com/metronic8/angular/docs/quick-start
ASP.NET Core: https://preview.keenthemes.com/asp.net-core/metronic/docs/
Node.js: https://preview.keenthemes.com/nodejs/metronic/docs/
Blazor: https://preview.keenthemes.com/blazor/metronic/docs/
Spring: https://preview.keenthemes.com/spring/metronic/docs/
Laravel: https://preview.keenthemes.com/laravel/metronic/docs/
Django: https://preview.keenthemes.com/django/metronic/docs/
Rails: https://preview.keenthemes.com/rails/metronic/docs/
Flask: https://preview.keenthemes.com/flask/metronic/docs/
Symfony: https://preview.keenthemes.com/symfony/metronic/docs/
Codeigniter: Soon
Yii: Soon
Play: Soon
```

--------------------------------

### Keenthemes Metronic Theme API Documentation

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

This section details the Theme API for Keenthemes Metronic, covering various functionalities and configurations. It includes information on theme settings, assets, and views.

```APIDOC
Theme API:
  - Overview: Provides a general overview of the Theme API.
  - Settings: Details theme configuration and settings.
  - Assets: Information on managing theme assets.
  - Views: Documentation on theme view templates.
  - RTL: Instructions for enabling Right-to-Left support.
  - Updates: Information regarding theme updates.
  - Changelog: A record of changes in different versions.
```

--------------------------------

### Metronic Laravel Directory Overview

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Provides a high-level overview of the Metronic Laravel project's directory structure. Each entry describes the purpose of a specific folder or file within the project.

```Markdown
File/Folder | Description  
---|---
`starterkit` |  The root folder that contains Metronic Laravel folder.   
`_keenthemes` |  This is a Core folder for Keenthemes products.   
`src` |  The source folder which located the raw version of HTML templates. The assets will be used for assets bundling.   
`tools` |  The build tools for assets.   
`app` |  It organizes your application components. It's got subdirectories that hold the view (views and helpers), controller (controllers), and the backend business logic (models).   
`bootstrap` |  The `bootstrap` directory contains the `app.php` file which bootstraps the framework. This directory also houses a `cache` directory which contains framework generated files for performance optimization such as the route and services cache files. You should not typically need to modify any files within this directory.   
`config` |  The `config` directory, as the name implies, contains all of your application's configuration files. It's a great idea to read through all of these files and familiarize yourself with all of the options available to you.   
`database` |  The `database` directory contains your database migrations, model factories, and seeds. If you wish, you may also use this directory to hold an SQLite database   
`public` |  Like the public directory for a web server, this directory has web files that don't change, such as JavaScript files (public/javascripts), graphics (public/images), stylesheets (public/stylesheets), and HTML files (public).   
`resources` |  The `resources` directory contains your [views](https://laravel.com/docs/8.x/views) as well as your raw, un-compiled assets such as CSS or JavaScript. This directory also houses all of your language files.   
`routes` |  The `routes` directory contains all of the route definitions for your application. By default, several route files are included with Laravel: `web.php`, `api.php`, `console.php`, and `channels.php`.   
`storage` |  The `storage` directory contains your logs, compiled Blade templates, file based sessions, file caches, and other files generated by the framework. This directory is segregated into `app`, `framework`, and `logs`directories. The `app` directory may be used to store any files generated by your application. The `framework` directory is used to store framework generated files and caches. Finally, the `logs` directory contains your application's log files. The `storage/app/public` directory may be used to store user-generated files, such as profile avatars, that should be publicly accessible. You should create a symbolic link at `public/storage` which points to this directory. You may create the link using the `php artisan storage:link` Artisan command.  
`tests` |  The `tests` directory contains your automated tests. Example [PHPUnit](https://phpunit.de/) unit tests and feature tests are provided out-of-the-box. Each test class should be suffixed with the word `Test`. You may run your tests using the `phpunit` or `php vendor/bin/phpunit` commands. Or, if you would like a more detailed and beautiful representation of your test results, you may run your tests using the `php artisan test` Artisan command.  
`vendor` |  The `vendor` directory contains your [Composer](https://getcomposer.org) dependencies.  
`.gitignore` |  A gitignore file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected   
`documentation.html` |  The documentation file.   
`README.md` |  README file as a quick guide that gives a detailed description   
```

--------------------------------

### Metronic File Structure

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Explanation of the file structure and organization within a Metronic Laravel project.

```APIDOC
File Structure:
  Description: Details the organization of files and directories in the Metronic Laravel project.
  Purpose:
    - Helps users understand where to find specific components, assets, and configurations.
  Related Sections:
    - Overview
    - Getting Started
    - Assets
```

--------------------------------

### Webpack and Build Process Improvements

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Updates and fixes concerning the Webpack build process, including mix warnings, missing theme mode dropdowns, and issues with plugins like FormValidation and Draggable.

```webpack
Fixes webpack mix warning
Fixes missing theme mode dropdown
Fix webpack mix build NULL error on Windows.
Fix Typed.js plugin error in webpack
Fix webpack mix issue with latest draggable plugin issue
Fix theme mode option
Update FormValidation webpack build
```

--------------------------------

### Get Icon Function

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

Introduces a new function `getIcon` to retrieve icons by name, class, and type. This function is part of the global icons migration to Keenicons.

```php
function getIcon($name, $class, $type) {
  // Returns the specified icon
}
```

--------------------------------

### Get Icon Function

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Introduces a new function `getIcon` to retrieve icons by name, class, and type. This function is part of the global icons migration to Keenicons.

```php
function getIcon($name, $class, $type) {
  // Returns the specified icon
}
```

--------------------------------

### Metronic Theme API Documentation

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Documentation for the Metronic Theme API, detailing how to interact with and customize the theme's functionalities.

```APIDOC
Theme API:
  This section details the Theme API for Metronic Laravel, covering various functionalities and customization options.

  Key Areas:
  - Theme Configuration: How to set up and manage theme settings.
  - Component Integration: Guidelines for integrating Metronic components into your Laravel application.
  - Customization: Methods for customizing the theme's appearance and behavior.
  - Utility Functions: Available utility functions for common tasks.
```

--------------------------------

### General Updates and Fixes

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

General updates including synchronizing with the latest HTML version, fixing menu click behavior, adjusting stepper functionality, and updating package dependencies.

```html
Synchronize the latest HTML version update - [Changelog](https://preview.keenthemes.com/html/metronic/docs/getting-started/changelog).
Synchronize the latest HTML version core assets update - [Changelog](https://preview.keenthemes.com/html/metronic/docs/getting-started/changelog).
Update header layout
Fixed menu click behavior.
Adjust stepper functionality.
Update package dependencies.
Fixed redirect links
Fixed aside menu collapse state
Fixed page breadcrumbs generator
```

--------------------------------

### Get HTML Attribute

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Retrieves an HTML attribute based on a given scope and attribute name. This utility is useful for dynamically setting attributes in HTML elements.

```php
helpers.getHtmlAttribute(scope, attribute)
```

--------------------------------

### Get Global Assets

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Retrieves global assets based on a specified type. This function can be used to fetch common assets like CSS, JS, or images.

```php
helpers.getGlobalAssets(type)
```

--------------------------------

### Using Default Layout Component

Source: https://preview.keenthemes.com/laravel/metronic/docs/views

Demonstrates how to apply the default layout to your web pages using the Blade component `x-default-layout`. This is typically used for standard web pages.

```blade
<x-default-layout>
    <!-- Your page content goes here -->
</x-default-layout>
```

--------------------------------

### Livewire Version Updates and Refactoring

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

Details updates to Livewire versions and refactoring of mutation handling. Includes implementation of `wire:current` directive for active link highlighting and conditional update routes.

```javascript
Refactor mutation handling in livewire.esm.js.
Implement wire:current directive for active link highlighting.
Modify Livewire update route to be conditional based on the production environment.
```

```laravel
Update Livewire to version 3.14.7.
Upgrade Livewire version 3.5.
Upgrade Livewire v3
```

--------------------------------

### Running Automated Tests

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Illustrates the commands for executing automated tests in the Metronic Laravel project. It covers both the standard PHPUnit command and the more user-friendly Artisan test command.

```bash
phpunit
php vendor/bin/phpunit
php artisan test
```

--------------------------------

### Metronic Laravel Assets Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Details on how Metronic Laravel manages assets, including CSS, JavaScript, and other frontend resources, and how to customize them.

```APIDOC
Assets:
  Metronic Laravel provides a robust system for managing frontend assets.

  Asset Handling:
  - Compilation: SCSS and JavaScript files are compiled using build tools.
  - Versioning: Assets are versioned to ensure cache busting.
  - Customization: Add or modify assets within the `resources/` directory.
```

--------------------------------

### Metronic Settings Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Information on managing application-level features like Dark Mode, RTL Mode, and Localization.

```APIDOC
Metronic Settings:
  Functionality: Manage application level features such as Dark Mode, RTL Mode, Localization, and more.
  Documentation Link: https://preview.keenthemes.com/laravel/metronic/docs/settings
```

--------------------------------

### Metronic Assets Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Information regarding the management of assets (CSS, JS, images) in Metronic.

```APIDOC
Assets:
  Description: Details on how assets are managed and utilized within the Metronic theme.
  Purpose:
    - Understanding asset inclusion, customization, and optimization.
  Related Sections:
    - Overview
    - Theme API
    - File Structure
```

--------------------------------

### Rendering Layout Partials

Source: https://preview.keenthemes.com/laravel/metronic/docs/views

Shows how to render partial templates within a view using the `@include` directive. Partials are distinguished by a leading underscore in their filenames.

```blade
@include 'drawers'
```

```blade
@include 'partials/drawers'
```

--------------------------------

### Compile Assets

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started

Compiles all frontend assets, including Sass, JavaScript, and media files, into the 'public' directory using the configured build tools (e.g., Webpack Mix).

```bash
npm run dev
```

--------------------------------

### Backend API Demo Integration

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Inclusion of a backend API demo for Angular CRUD operations.

```javascript
Include backend API demo for Angular CRUD
```

--------------------------------

### Metronic Laravel RTL Support

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Instructions on enabling and configuring Right-to-Left (RTL) support in Metronic Laravel for projects targeting right-to-left languages.

```APIDOC
RTL Support:
  Metronic Laravel fully supports Right-to-Left (RTL) layouts.

  Enabling RTL:
  - Configuration: Modify theme settings to enable RTL mode.
  - CSS Adjustments: The theme automatically applies necessary CSS changes for RTL.
  - Language Switching: Implement language switching functionality that also toggles RTL layout.
```

--------------------------------

### Metronic Theme Settings

Source: https://preview.keenthemes.com/laravel/metronic/docs/settings

Configuration options for the Metronic theme, including light, dark, and system modes.

```APIDOC
Theme Settings:
  - Light Mode: Enables the light theme.
  - Dark Mode: Enables the dark theme.
  - System Mode: Follows the system's preferred color scheme.
```

--------------------------------

### Metronic Laravel Settings

Source: https://preview.keenthemes.com/laravel/metronic/docs/file-structure

Information on theme configuration and settings for Metronic Laravel, allowing users to customize the theme according to their project requirements.

```APIDOC
Settings:
  Metronic Laravel provides extensive configuration options to customize the theme's appearance and behavior.

  Configuration Options:
  - Layout Options: Control sidebar, header, and footer configurations.
  - Color Schemes: Select and apply different color palettes.
  - Font Settings: Customize typography and font families.
  - Component Settings: Configure specific UI components.
```

--------------------------------

### Webpack and Build Process Improvements

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

Updates and fixes concerning the Webpack build process, including mix warnings, missing theme mode dropdowns, and issues with plugins like FormValidation and Draggable.

```webpack
Fixes webpack mix warning
Fixes missing theme mode dropdown
Fix webpack mix build NULL error on Windows.
Fix Typed.js plugin error in webpack
Fix webpack mix issue with latest draggable plugin issue
Fix theme mode option
Update FormValidation webpack build
```

--------------------------------

### Metronic Assets Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Details on generating pages with required plugins or assets using abstracted API methods.

```APIDOC
Metronic Assets Management:
  Functionality: Generate pages with required plugins or assets included using abstracted API methods.
  Documentation Link: https://preview.keenthemes.com/laravel/metronic/docs/assets
```

--------------------------------

### General Updates and Fixes

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

General updates including synchronizing with the latest HTML version, fixing menu click behavior, adjusting stepper functionality, and updating package dependencies.

```html
Synchronize the latest HTML version update - [Changelog](https://preview.keenthemes.com/html/metronic/docs/getting-started/changelog).
Synchronize the latest HTML version core assets update - [Changelog](https://preview.keenthemes.com/html/metronic/docs/getting-started/changelog).
Update header layout
Fixed menu click behavior.
Adjust stepper functionality.
Update package dependencies.
Fixed redirect links
Fixed aside menu collapse state
Fixed page breadcrumbs generator
```

--------------------------------

### Theme API - Vendor and Global Asset Management

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Functions for adding and retrieving vendor assets and global assets for the theme.

```APIDOC
addVendors(vendors)
  - Adds multiple vendor assets to the page.
  - Parameters:
    - vendors: An array of vendor names (refer to settings KT_THEME_VENDORS).

addVendor(vendor)
  - Adds a single vendor asset to the page.
  - Parameters:
    - vendor: The name of the vendor (refer to settings KT_THEME_VENDORS).

getVendors(type)
  - Retrieves vendor files based on type from settings.
  - Parameters:
    - type: The type of vendor files to retrieve (e.g., 'js', 'css').
  - Returns: An array of vendor file paths.

getGlobalAssets(type)
  - Retrieves global assets for the theme.
  - Parameters:
    - type: The type of global assets to retrieve (e.g., 'js', 'css').
  - Returns: An array of global asset paths.

getCustomJs
  - Gets custom JavaScript files configured in settings.
  - Returns: An array of custom JS file paths.

getCustomCss
  - Gets custom CSS files configured in settings.
  - Returns: An array of custom CSS file paths.
```

--------------------------------

### Laravel Version Upgrades and Configuration

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Information on upgrading the Laravel framework and related configuration adjustments, including composer.lock updates and source map consistency.

```laravel
Upgrade Laravel version 11
Upgrade laravel v11
Adjust related source maps and manifest for consistency.
Update composer.lock for package version upgrades.
```

--------------------------------

### Add/Get Vendors

Source: https://preview.keenthemes.com/laravel/metronic/docs/theme-api

Manages the inclusion of third-party vendor assets. Functions allow adding single or multiple vendors by name and retrieving vendor files based on type, referencing KT_THEME_VENDORS settings.

```php
helpers.addVendors(vendors)
helpers.addVendor(vendor)
helpers.getVendors(type)
```

--------------------------------

### Backend API Demo Integration

Source: https://preview.keenthemes.com/laravel/metronic/docs/changelog

Inclusion of a backend API demo for Angular CRUD operations.

```javascript
Include backend API demo for Angular CRUD
```

--------------------------------

### Metronic Laravel Settings Configuration

Source: https://preview.keenthemes.com/laravel/metronic/docs/settings

Defines the core settings for the Metronic theme in a Laravel application. This includes layout directories, theme modes (light, dark, system), direction (RTL/LTR), and asset configurations for favicons, fonts, CSS, and JS.

```APIDOC
Settings Configuration:

KT_THEME_LAYOUT_DIR:
  Type: mandatory
  Description: Specifies the directory location for layout partials. Default: `layout`.

KT_THEME_MODE_DEFAULT:
  Type: mandatory
  Description: Sets the default theme mode. Supported values: `light`, `dark`, `system`.

KT_THEME_MODE_SWITCH_ENABLED:
  Type: mandatory
  Description: Enables or disables the theme mode switch toggle. Default: `true`.

KT_THEME_DIRECTION:
  Type: mandatory
  Description: Sets the text writing direction. Supported values: `rtl`, `ltr`. Default: `ltr`.

KT_THEME_ASSETS:
  Type: mandatory
  Description: Configuration array for application assets (favicon, fonts, CSS, JS).
  favicon:
    Type: mandatory
    Description: Icon displayed in the address bar or tabs.
  fonts:
    Type: mandatory
    Description: Font settings for the application.
  css:
    Type: mandatory
    Description: Global CSS files included on all pages.
  js:
    Type: mandatory
    Description: Global JS files included on all pages.

KT_THEME_VENDORS:
  Type: optional
  Description: Lists available vendors in the package. Vendors can be added using `helpers.addVendor('vendor_name')`.
```

--------------------------------

### Metronic Laravel Theme API

Source: https://preview.keenthemes.com/laravel/metronic/docs/index

Provides access to Metronic's theme API for customization and integration within Laravel applications. This includes details on available functions and their usage.

```APIDOC
Theme API:
  - Access to Metronic's theme functionalities.
  - Enables customization and integration within Laravel projects.
  - Refer to the documentation for specific API endpoints and methods.
```

--------------------------------

### Adding Vendors in Metronic Laravel

Source: https://preview.keenthemes.com/laravel/metronic/docs/settings

Demonstrates how to add vendors to the Metronic Laravel package using the `helpers.addVendor` API function. This is useful for integrating third-party libraries or custom assets.

```PHP
helpers.addVendor('datatable');
```

--------------------------------

### Add Single Vendor Asset

Source: https://preview.keenthemes.com/laravel/metronic/docs/assets

Includes a single vendor asset into the project. Vendor names can be found in the `config/settings.yml` file under `KT_THEME_VENDORS`. This simplifies the inclusion of pre-defined third-party libraries.

```javascript
helpers.addVendor('datatables')
```

--------------------------------

### Metronic Laravel Changelog

Source: https://preview.keenthemes.com/laravel/metronic/docs/getting-started/changelog

Information on updates and changes in Metronic for Laravel, including version history and specific improvements.

```Markdown
### Metronic v8.3.1 - 26 June, 2025 
### Update:
  * Synchronize the latest HTML version update - [Changelog](https://preview.keenthemes.com/html/metronic/docs/getting-started/changelog).


###  Metronic v8.3.0 - 30 April, 2025 

```

--------------------------------

### Generate RTL CSS Files

Source: https://preview.keenthemes.com/laravel/metronic/docs/rtl

This snippet demonstrates the command to generate RTL (Right-to-Left) CSS files for a Laravel project using npm. It assumes the project is set up with a build process that supports RTL compilation.

```bash
npm run dev --rtl
```
Tokens:
Raw