1 | import { IconDefinition, IconPrefix } from '@fortawesome/fontawesome-common-types';
|
2 | export declare class FaConfig {
|
3 | /**
|
4 | * Default prefix to use, when one is not provided with the icon name.
|
5 | *
|
6 | * @default 'fas'
|
7 | */
|
8 | defaultPrefix: IconPrefix;
|
9 | /**
|
10 | * Provides a fallback icon to use whilst main icon is being loaded asynchronously.
|
11 | * When value is null, then fa-icon component will throw an error if icon input is missing.
|
12 | * When value is not null, then the provided icon will be used as a fallback icon if icon input is missing.
|
13 | *
|
14 | * @default null
|
15 | */
|
16 | fallbackIcon: IconDefinition;
|
17 | /**
|
18 | * Set icons to the same fixed width.
|
19 | *
|
20 | * @see {@link: https://fontawesome.com/how-to-use/on-the-web/styling/fixed-width-icons}
|
21 | * @default false
|
22 | */
|
23 | fixedWidth?: boolean;
|
24 | /**
|
25 | * Whether components should lookup icon definitions in the global icon
|
26 | * library (the one available from
|
27 | * `import { library } from '@fortawesome/fontawesome-svg-core')`.
|
28 | *
|
29 | * See https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/usage/icon-library.md
|
30 | * for detailed description of library modes.
|
31 | *
|
32 | * - 'unset' - Components should lookup icon definitions in the global library
|
33 | * and emit warning if they find a definition there. This option is a default
|
34 | * to assist existing applications with a migration. Applications are expected
|
35 | * to switch to using {@link FaIconLibrary}.
|
36 | * - true - Components should lookup icon definitions in the global library.
|
37 | * Note that global icon library is deprecated and support for it will be
|
38 | * removed. This option can be used to temporarily suppress warnings.
|
39 | * - false - Components should not lookup icon definitions in the global
|
40 | * library. Library will throw an error if missing icon is found in the global
|
41 | * library.
|
42 | *
|
43 | * @deprecated This option is deprecated since 0.5.0. In 0.6.0 default will
|
44 | * be changed to false. In 0.8.0 the option will be removed together with the
|
45 | * support for the global icon library.
|
46 | *
|
47 | * @default false
|
48 | */
|
49 | globalLibrary: boolean | 'unset';
|
50 | }
|