validateIconName()

此函数属于 Iconify Utils 包。

函数 validateIconName() 用于验证图标名称。

用法

该函数包含以下参数：

• name，IconifyIconName|null。图标名称。
• allowSimpleName，boolean。可选参数。如果为 true，则不包含提供商和前缀的简单名称也被视为有效。

函数返回 boolean 类型的值。

示例

examples.ts

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

// Valid names: function returns `true`
validateIconName({
   provider: '',
   prefix: 'mdi-light',
   name: 'home',
});

validateIconName({
   provider: 'my-api',
   prefix: 'awesome-test',
   name: 'alert-outline',
});

validateIconName(
   {
       provider: '',
       prefix: '',
       name: 'home',
   },
   true
);

// Invalid names: function returns `false`
validateIconName({
   provider: '',
   prefix: '', // Empty prefix
   name: 'home',
});

validateIconName({
   provider: '',
   prefix: 'my_set', // `_` is not allowed
   name: 'home',
});

validateIconName(
   {
       provider: 'my-api',
       prefix: '', // prefix cannot be empty if provider is set, even if second option is `true`
       name: 'home',
   },
   true
);