Search documentation of phoenix_kit

# mix phoenix_kit.gen.user.dashboard (phoenix_kit v1.7.87)

Copy Markdown View Source

Igniter task that generates a user dashboard page with tab configuration.

## Usage

    mix phoenix_kit.gen.user.dashboard "Example"

## Arguments

- `tab_title` - The display title for the tab (e.g., "Example")

## Options

- `--url` - The URL path for the tab (optional, derived from title if not provided)
- `--category` - The category name (optional, defaults to "General")
- `--icon` - Heroicon name for the tab (optional, defaults to "hero-document")
- `--description` - Brief description for the tab (optional)
- `--category-icon` - Heroicon name for the category (optional, defaults to "hero-folder"). Only used when creating a new category.
- `--index` - Generate as main dashboard index (skips config, for overriding /dashboard)

## Examples

    # Simple - uses all defaults
    mix phoenix_kit.gen.user.dashboard "Example"

    # With custom category
    mix phoenix_kit.gen.user.dashboard "Example" --category="Farm Management"

    # With custom icon
    mix phoenix_kit.gen.user.dashboard "Example" --icon="hero-chart-bar"

    # Full control
    mix phoenix_kit.gen.user.dashboard "Example" --url="/custom/path" --icon="hero-user"

    # Generate as main dashboard index (overrides /dashboard)
    mix phoenix_kit.gen.user.dashboard "Dashboard" --url="/dashboard" --index --description="Welcome"