Configuration reference

defaults

map

This section contains the default rendering options for the icons.

class

string

default:""

The default class names to apply to all rendered icons.

prefix

string

default:""

The default prefix for all icons.

For example, if you set the prefix to heroicons, you can render icons from the heroicons icon set using the following syntax:

+ <x-icon name="clock" />
- <x-icon name="heroicons:clock" />

cache

map

This section contains the configuration options for the icon cache.

disk

map

This section contains the configuration options for the icon cache disk.

driver

string

default:"local"

This value is the name of the disk to use for caching icons.

path

string

default:"icons"

This value is the path (relative to the disk root) where the icons will be stored.

name

string

default:"icon"

This value is the name that will be used to register the Blade component and directive.

Blade component: <x-{name}>
Blade directive: @{name}

iconify

map

This section contains the configuration options for the Iconify API.

url

string

default:"https://api.iconify.design"

The value is the base URL of the Iconify API.

timeout

integer

default:"5"

This value is the timeout in seconds for the Iconify API requests.

If the request times out, the component won’t be rendered.

request_options

map

default:"['timeout' => 5]"

This value is a map of http request options to be passed to the underlying Guzzle client for all requests to the Iconify API.

For example, you can set the timeout option to set a custom timeout.

'request_options' => [
    'timeout' => 10,
],

See the Guzzle documentation about the request options for more information.

Overview

Getting Started

Components

Commands

Reference

Configuration reference