stringToIcon()

此函数属于 Iconify Utils 包。

函数 stringToIcon() 将图标名称字符串转换为 IconifyIconName 对象。

用法

函数具有以下参数：

• value，string。图标名称。
• validate，boolean。可选。如果为 true，将使用 validateIconName() 验证图标名称。
• allowSimpleName，boolean。可选。如果为 true，则不带前缀的简单名称将被视为有效。
• provider，string。可选。如果缺少提供商，则添加到图标名称中的 API 提供商。

函数在成功时返回类型为 IconifyIconName 的图标名称，失败时返回 null。

示例

examples.ts

tsimport { stringToIcon } from '@iconify/utils';

// { provider: '', prefix: 'mdi', name: 'home' }
console.log(stringToIcon('mdi:home'));

/* {
 provider: 'custom-api',
 prefix: 'icon-set-prefix',
 name: 'some-icon'
} */
console.log(stringToIcon('@custom-api:icon-set-prefix:some-icon'));

// { provider: '', prefix: 'mdi', name: 'home' }
console.log(stringToIcon('mdi-home'));

// null
console.log(stringToIcon('alert'));

// null
console.log(stringToIcon('alert', true));

// { provider: '', prefix: '', name: 'alert' }
console.log(stringToIcon('alert', true, true));

// { provider: '', prefix: '', name: 'alert' } - provider is ignored because there is no prefix
console.log(stringToIcon('alert', true, true, 'test'));

// { provider: 'test', prefix: 'some-icon-set', name: 'alert' }
console.log(stringToIcon('some-icon-set:alert', true, true, 'test'));