ionicons/src/components.d.ts at c09b44728eae91c33a9300152c759720362b26b6 · ionic-team/ionicons · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* eslint-disable */
/* tslint:disable */
/**
 * This is an autogenerated file created by the Stencil compiler.
 * It contains typing information for all components that exist in this project.
 */
import { HTMLStencilElement, JSXBase } from '@stencil/core/internal';
import { IoniconName, IoniconSource } from './types/iconicons.d';
export { IoniconName, IoniconSource } from './types/iconicons.d';
export namespace Components {
  interface IonIcon {
    /**
     * The color to use for the background of the item.
     */
    color?: string;
    /**
     * Specifies whether the icon should horizontally flip when `dir` is `"rtl"`.
     */
    flipRtl?: boolean;
    /**
     * A combination of both `name` and `src`. If a `src` url is detected it will set the `src` property. Otherwise it assumes it's a built-in named SVG and set the `name` property.
     */
    icon?: IoniconSource;
    /**
     * Specifies which icon to use on `ios` mode.
     */
    ios?: string;
    /**
     * If enabled, ion-icon will be loaded lazily when it's visible in the viewport. Default, `false`.
     * @default false
     */
    lazy: boolean;
    /**
     * Specifies which icon to use on `md` mode.
     */
    md?: string;
    /**
     * The mode determines which platform styles to use.
     * @default getIonMode() as any
     */
    mode: any;
    /**
     * Specifies which icon to use from the built-in set of icons.
     */
    name?: IoniconName;
    /**
     * When set to `false`, SVG content that is HTTP fetched will not be checked if the response SVG content has any `<script>` elements, or any attributes that start with `on`, such as `onclick`.
     * @default true
     */
    sanitize: boolean;
    /**
     * The size of the icon. Available options are: `"small"` and `"large"`.
     */
    size?: string;
    /**
     * Specifies the exact `src` of an SVG file to use.
     */
    src?: string;
  }
}
declare global {
  interface HTMLIonIconElement extends Components.IonIcon, HTMLStencilElement {}
  var HTMLIonIconElement: {
    prototype: HTMLIonIconElement;
    new (): HTMLIonIconElement;
  };
  interface HTMLElementTagNameMap {
    'ion-icon': HTMLIonIconElement;
  }
}
declare namespace LocalJSX {
  interface IonIcon {
    /**
     * The color to use for the background of the item.
     */
    color?: string;
    /**
     * Specifies whether the icon should horizontally flip when `dir` is `"rtl"`.
     */
    flipRtl?: boolean;
    /**
     * A combination of both `name` and `src`. If a `src` url is detected it will set the `src` property. Otherwise it assumes it's a built-in named SVG and set the `name` property.
     */
    icon?: IoniconSource;
    /**
     * Specifies which icon to use on `ios` mode.
     */
    ios?: string;
    /**
     * If enabled, ion-icon will be loaded lazily when it's visible in the viewport. Default, `false`.
     * @default false
     */
    lazy?: boolean;
    /**
     * Specifies which icon to use on `md` mode.
     */
    md?: string;
    /**
     * The mode determines which platform styles to use.
     * @default getIonMode() as any
     */
    mode?: any;
    /**
     * Specifies which icon to use from the built-in set of icons.
     */
    name?: IoniconName;
    /**
     * When set to `false`, SVG content that is HTTP fetched will not be checked if the response SVG content has any `<script>` elements, or any attributes that start with `on`, such as `onclick`.
     * @default true
     */
    sanitize?: boolean;
    /**
     * The size of the icon. Available options are: `"small"` and `"large"`.
     */
    size?: string;
    /**
     * Specifies the exact `src` of an SVG file to use.
     */
    src?: string;
  }
  interface IntrinsicElements {
    'ion-icon': IonIcon;
  }
}
export { LocalJSX as JSX };
declare module '@stencil/core' {
  export namespace JSX {
    interface IntrinsicElements {
      'ion-icon': LocalJSX.IonIcon & JSXBase.HTMLAttributes<HTMLIonIconElement>;
    }
  }
}