| 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 | * @see {@link: https://fontawesome.com/how-to-use/on-the-web/styling/fixed-width-icons}
|
|---|
| 20 | * @default false
|
|---|
| 21 | */
|
|---|
| 22 | fixedWidth?: boolean;
|
|---|
| 23 | /**
|
|---|
| 24 | * Whether components should lookup icon definitions in the global icon
|
|---|
| 25 | * library (the one available from
|
|---|
| 26 | * `import { library } from '@fortawesome/fontawesome-svg-core')`.
|
|---|
| 27 | *
|
|---|
| 28 | * See https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/usage/icon-library.md
|
|---|
| 29 | * for detailed description of library modes.
|
|---|
| 30 | *
|
|---|
| 31 | * - 'unset' - Components should lookup icon definitions in the global library
|
|---|
| 32 | * and emit warning if they find a definition there. This option is a default
|
|---|
| 33 | * to assist existing applications with a migration. Applications are expected
|
|---|
| 34 | * to switch to using {@link FaIconLibrary}.
|
|---|
| 35 | * - true - Components should lookup icon definitions in the global library.
|
|---|
| 36 | * Note that global icon library is deprecated and support for it will be
|
|---|
| 37 | * removed. This option can be used to temporarily suppress warnings.
|
|---|
| 38 | * - false - Components should not lookup icon definitions in the global
|
|---|
| 39 | * library. Library will throw an error if missing icon is found in the global
|
|---|
| 40 | * library.
|
|---|
| 41 | *
|
|---|
| 42 | * @deprecated This option is deprecated since 0.5.0. In 0.6.0 default will
|
|---|
| 43 | * be changed to false. In 0.8.0 the option will be removed together with the
|
|---|
| 44 | * support for the global icon library.
|
|---|
| 45 | *
|
|---|
| 46 | * @default false
|
|---|
| 47 | */
|
|---|
| 48 | globalLibrary: boolean | 'unset';
|
|---|
| 49 | }
|
|---|
