Skip to content

Latest commit

 

History

History
76 lines (68 loc) · 3.02 KB

config-reference.mdx

File metadata and controls

76 lines (68 loc) · 3.02 KB
title sidebarTitle description icon
Configuration reference
Configuration
Unicon configuration reference
gear
This section contains the default rendering options for the icons. The default class names to apply to all rendered icons. 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:

        ```diff
        + <x-icon name="clock" />
        - <x-icon name="heroicons:clock" />
        ```
    </ParamField>
</Expandable>
This section contains the configuration options for the icon cache. This section contains the configuration options for the icon cache disk. This value is the name of the disk to use for caching icons. This value is the path (relative to the disk root) where the icons will be stored. This value is the name that will be used to register the Blade component and directive.
- Blade component: `<x-{name}>`
- Blade directive: `@{name}`
This section contains the configuration options for the Iconify API. The value is the base URL of the Iconify API. This value is the timeout in seconds for the Iconify API requests.
       If the request times out, the component won't be rendered.
   </ParamField>
   <ParamField path="request_options" type="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.

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

        See the Guzzle documentation about the [request options](https://docs.guzzlephp.org/en/stable/request-options.html)
        for more information.
   </ParamField>