IconsOptions | /deps/@unocss/preset-icons/browser.ts | netzo@0.4.78

interface IconsOptions

Re-export

import { type IconsOptions } from "https://deno.land/x/netzo@0.4.78/deps/@unocss/preset-icons/browser.ts";

Properties

optional

scale: number

Scale related to the current font size (1em).

optional

mode: "mask" | "background-img" | "auto"

Mode of generated CSS icons.

mask - use background color and the mask property for monochrome icons
background-img - use background image for the icons, colors are static
auto - smartly decide mode between mask and background-img per icon based on its style

optional

prefix: string | string[]

Class prefix for matching icon rules.

optional

extraProperties: Record<string, string>

Extra CSS properties applied to the generated CSS

optional

warn: boolean

Emit warning when missing icons are matched

optional

collections: Record<string,

| (() => Awaitable<IconifyJSON>)

| undefined

| CustomIconLoader

| InlineCollection

In Node.js environment, the preset will search for the installed iconify dataset automatically. When using in the browser, this options is provided to provide dataset with custom loading mechanism.

optional

layer: string

Rule layer

optional

customizations: Omit<IconCustomizations, "additionalProps" | "trimCustomSvg">

Custom icon customizations.

optional

autoInstall: boolean

Auto install icon sources package when the usages is detected

WARNING: only on node environment, on browser this option will be ignored.

optional

unit: string

Custom icon unit.

optional

cdn: string

Load icons from CDN. Should starts with https:// and ends with /

Recommends:

optional

customFetch: (url: string) => Promise<any>

Custom fetch function to provide the icon data.