@xplortech/apollo-icons 0.2.2 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts ADDED
@@ -0,0 +1,689 @@
1
+ // This file is auto-generated. Do not edit manually.
2
+
3
+ export interface SVGOptions {
4
+ width?: number;
5
+ height?: number;
6
+ class?: string;
7
+ 'aria-label'?: string;
8
+ }
9
+
10
+ export interface IconHeight {
11
+ width: number;
12
+ path: string;
13
+ options: {
14
+ version: string;
15
+ width: number;
16
+ height: number;
17
+ viewBox: string;
18
+ class: string;
19
+ 'aria-hidden': string;
20
+ }
21
+ }
22
+
23
+ export interface Icon {
24
+ symbol: string;
25
+ keywords: string[];
26
+ heights: Record<string, IconHeight>;
27
+ toSVG(options?: SVGOptions): string;
28
+ }
29
+
30
+ export type IconName =
31
+ | 'aaland-islands'
32
+ | 'add-magic'
33
+ | 'adjust-contrast-2'
34
+ | 'afghanistan'
35
+ | 'alarm-clock'
36
+ | 'albania'
37
+ | 'algeria'
38
+ | 'andorra'
39
+ | 'angola'
40
+ | 'anguilla'
41
+ | 'antarctica'
42
+ | 'antigua-barbuda'
43
+ | 'argentina'
44
+ | 'armenia'
45
+ | 'arrow-bold-left'
46
+ | 'arrow-bold-left-1'
47
+ | 'arrow-bold-right'
48
+ | 'arrow-bold-right-1'
49
+ | 'arrow-diagonal-out-2'
50
+ | 'arrow-down'
51
+ | 'arrow-down-left'
52
+ | 'arrow-down-right'
53
+ | 'arrow-down-to-line'
54
+ | 'arrow-left'
55
+ | 'arrow-left-to-line'
56
+ | 'arrow-right'
57
+ | 'arrow-right-to-line'
58
+ | 'arrow-rotate-anticlockwise-1'
59
+ | 'arrow-rotate-clockwise-1'
60
+ | 'arrow-up'
61
+ | 'arrow-up-from-line'
62
+ | 'arrow-up-left'
63
+ | 'arrow-up-right'
64
+ | 'arrows-expand'
65
+ | 'aruba'
66
+ | 'australia'
67
+ | 'austria'
68
+ | 'award-2'
69
+ | 'azerbaijan'
70
+ | 'bag-shopping-2'
71
+ | 'bahamas'
72
+ | 'bahrain'
73
+ | 'ball-basket-2'
74
+ | 'ball-golf'
75
+ | 'ball-tennis'
76
+ | 'ball-volleyball'
77
+ | 'bangladesh'
78
+ | 'banking-mobile'
79
+ | 'barbados'
80
+ | 'basque'
81
+ | 'belarus'
82
+ | 'belgium'
83
+ | 'belize'
84
+ | 'bell'
85
+ | 'bell-slash'
86
+ | 'benin'
87
+ | 'bermuda'
88
+ | 'bhutan'
89
+ | 'bicycle-2'
90
+ | 'blog'
91
+ | 'bolivia'
92
+ | 'bolt-lightning'
93
+ | 'bolt-lightning-slash'
94
+ | 'book-wrench-1'
95
+ | 'bookmark'
96
+ | 'bookmark-slash'
97
+ | 'bosnia-herzegovina'
98
+ | 'botswana'
99
+ | 'box-archive'
100
+ | 'brazil'
101
+ | 'british-virgin-islands'
102
+ | 'brunei'
103
+ | 'brush-2'
104
+ | 'bug-slash'
105
+ | 'bulgaria'
106
+ | 'bullhorn'
107
+ | 'burkina-faso'
108
+ | 'burundi'
109
+ | 'calendar'
110
+ | 'calendar-alert'
111
+ | 'calendar-check-out'
112
+ | 'calendar-clock'
113
+ | 'calendar-days'
114
+ | 'calendar-grid'
115
+ | 'calendar-minus'
116
+ | 'calendar-pen'
117
+ | 'calendar-plus'
118
+ | 'calendar-refresh'
119
+ | 'calendar-search'
120
+ | 'calendar-settings'
121
+ | 'cambodia'
122
+ | 'camera'
123
+ | 'cameroon'
124
+ | 'canada'
125
+ | 'canary-islands'
126
+ | 'cape-verde'
127
+ | 'car-ventilation'
128
+ | 'caret-down'
129
+ | 'caret-expand-y'
130
+ | 'caret-left'
131
+ | 'caret-right'
132
+ | 'caret-up'
133
+ | 'cart-shopping'
134
+ | 'cayman-islands'
135
+ | 'central-african-republic'
136
+ | 'chad'
137
+ | 'chart-column'
138
+ | 'chart-line'
139
+ | 'chart-pie'
140
+ | 'check-2'
141
+ | 'chevron-down'
142
+ | 'chevron-left'
143
+ | 'chevron-right'
144
+ | 'chevron-up'
145
+ | 'chile'
146
+ | 'china'
147
+ | 'circle-bolt'
148
+ | 'circle-caret-right'
149
+ | 'circle-check'
150
+ | 'circle-check-1'
151
+ | 'circle-dollar'
152
+ | 'circle-dollar-in'
153
+ | 'circle-dollar-out'
154
+ | 'circle-info'
155
+ | 'circle-minus'
156
+ | 'circle-minus-1'
157
+ | 'circle-pause'
158
+ | 'circle-plus'
159
+ | 'circle-plus-1'
160
+ | 'circle-question'
161
+ | 'circle-user'
162
+ | 'circle-warning'
163
+ | 'circle-xmark'
164
+ | 'circle-xmark-1'
165
+ | 'clipboard'
166
+ | 'clock'
167
+ | 'clock-minus'
168
+ | 'clock-plus'
169
+ | 'code'
170
+ | 'colombia'
171
+ | 'comoros'
172
+ | 'compass'
173
+ | 'compose-2'
174
+ | 'cook-islands'
175
+ | 'copy'
176
+ | 'costa-rica'
177
+ | 'credit-card'
178
+ | 'croatia'
179
+ | 'cuba'
180
+ | 'cube'
181
+ | 'curacao'
182
+ | 'currency-dollar'
183
+ | 'cyprus'
184
+ | 'czechia'
185
+ | 'deaf'
186
+ | 'democratic-republic-congo'
187
+ | 'denmark'
188
+ | 'djibouti'
189
+ | 'dominica'
190
+ | 'dominican-republic'
191
+ | 'dots'
192
+ | 'dots-vertical'
193
+ | 'double-chevron-down'
194
+ | 'double-chevron-left'
195
+ | 'double-chevron-right'
196
+ | 'double-chevron-up'
197
+ | 'droplet'
198
+ | 'droplet-slash'
199
+ | 'dumbbell'
200
+ | 'east-timor'
201
+ | 'ecuador'
202
+ | 'egypt'
203
+ | 'el-salvador'
204
+ | 'england'
205
+ | 'envelope'
206
+ | 'envelope-alert'
207
+ | 'envelope-ban'
208
+ | 'envelope-check'
209
+ | 'envelope-minus'
210
+ | 'envelope-plus'
211
+ | 'equatorial-guinea'
212
+ | 'eritrea'
213
+ | 'estonia'
214
+ | 'eswatini'
215
+ | 'ethiopia'
216
+ | 'europe'
217
+ | 'export'
218
+ | 'eye'
219
+ | 'eye-dropper'
220
+ | 'eye-slash'
221
+ | 'facial-recognition'
222
+ | 'falkland-islands'
223
+ | 'faroe-islands'
224
+ | 'fiji'
225
+ | 'file'
226
+ | 'file-ban-1'
227
+ | 'file-clock'
228
+ | 'file-content-2'
229
+ | 'file-plus'
230
+ | 'fingerprint'
231
+ | 'finland'
232
+ | 'flag-3'
233
+ | 'flame'
234
+ | 'flame-slash'
235
+ | 'floppy-disk'
236
+ | 'folder-2'
237
+ | 'forklift'
238
+ | 'france'
239
+ | 'french-guiana'
240
+ | 'french-polynesia'
241
+ | 'gabon'
242
+ | 'gambia'
243
+ | 'gear-3'
244
+ | 'gears'
245
+ | 'georgia'
246
+ | 'germany'
247
+ | 'ghana'
248
+ | 'gibraltar'
249
+ | 'gift'
250
+ | 'globe-2'
251
+ | 'greece'
252
+ | 'greenland'
253
+ | 'grenada'
254
+ | 'grid'
255
+ | 'grid-plus'
256
+ | 'grip-dots'
257
+ | 'grip-dots-vertical'
258
+ | 'guadeloupe'
259
+ | 'guatemala'
260
+ | 'guernsey'
261
+ | 'guinea'
262
+ | 'guinea-bissau'
263
+ | 'guyana'
264
+ | 'haiti'
265
+ | 'hawaii'
266
+ | 'headphones-4'
267
+ | 'headset'
268
+ | 'heart-2'
269
+ | 'history'
270
+ | 'honduras'
271
+ | 'hong-kong'
272
+ | 'hours-24'
273
+ | 'house-4'
274
+ | 'humidity-2'
275
+ | 'hungary'
276
+ | 'iceland'
277
+ | 'india'
278
+ | 'indonesia'
279
+ | 'invoice-dollar'
280
+ | 'iran'
281
+ | 'iraq'
282
+ | 'ireland'
283
+ | 'isle-of-man'
284
+ | 'israel'
285
+ | 'italy'
286
+ | 'ivory-coast'
287
+ | 'jamaica'
288
+ | 'japan'
289
+ | 'jersey'
290
+ | 'jordan'
291
+ | 'kazakhstan'
292
+ | 'kenya'
293
+ | 'key'
294
+ | 'kiribati'
295
+ | 'kosovo'
296
+ | 'kurdistan'
297
+ | 'kuwait'
298
+ | 'kyrgyzstan'
299
+ | 'laos'
300
+ | 'latvia'
301
+ | 'layers-3'
302
+ | 'leaf'
303
+ | 'lebanon'
304
+ | 'lesotho'
305
+ | 'liberia'
306
+ | 'libya'
307
+ | 'liechtenstein'
308
+ | 'lightbulb'
309
+ | 'lightbulb-sparkle-1'
310
+ | 'link'
311
+ | 'lithuania'
312
+ | 'loader-4'
313
+ | 'lock'
314
+ | 'lock-open'
315
+ | 'luxembourg'
316
+ | 'macau'
317
+ | 'madagascar'
318
+ | 'magnifier'
319
+ | 'magnifier-minus'
320
+ | 'magnifier-plus'
321
+ | 'malawi'
322
+ | 'malaysia'
323
+ | 'maldives'
324
+ | 'mali'
325
+ | 'malta'
326
+ | 'map'
327
+ | 'marshall-islands'
328
+ | 'martinique'
329
+ | 'mauritania'
330
+ | 'mauritius'
331
+ | 'menu'
332
+ | 'message'
333
+ | 'message-arrow-right'
334
+ | 'message-check'
335
+ | 'message-clock'
336
+ | 'message-lock'
337
+ | 'message-plus'
338
+ | 'message-writing'
339
+ | 'messages'
340
+ | 'mexico'
341
+ | 'micronesia'
342
+ | 'microphone-3'
343
+ | 'microphone-3-off'
344
+ | 'minus'
345
+ | 'mobile-2'
346
+ | 'mobile-signal'
347
+ | 'moldova'
348
+ | 'monaco'
349
+ | 'money-bill'
350
+ | 'mongolia'
351
+ | 'montenegro'
352
+ | 'moon'
353
+ | 'morocco'
354
+ | 'mozanbique'
355
+ | 'myanmar'
356
+ | 'namibia'
357
+ | 'nauru'
358
+ | 'nepal'
359
+ | 'netherlands'
360
+ | 'netherlands-antilles'
361
+ | 'new-caledonia'
362
+ | 'new-zealand'
363
+ | 'nicaragua'
364
+ | 'niger'
365
+ | 'nigeria'
366
+ | 'niue'
367
+ | 'north-korea'
368
+ | 'north-macedonia'
369
+ | 'northen-ireland'
370
+ | 'norway'
371
+ | 'octagon-warning'
372
+ | 'office-3'
373
+ | 'oman'
374
+ | 'open-in-new-window'
375
+ | 'open-rect-arrow-in'
376
+ | 'open-rect-arrow-out'
377
+ | 'ordered-list'
378
+ | 'ordered-list-1'
379
+ | 'pakistan'
380
+ | 'palau'
381
+ | 'palestine'
382
+ | 'panama'
383
+ | 'paperclip-2'
384
+ | 'papua-new-guinea'
385
+ | 'paraguay'
386
+ | 'pen-2'
387
+ | 'percentage'
388
+ | 'person-biking'
389
+ | 'peru'
390
+ | 'philippines'
391
+ | 'phone'
392
+ | 'phone-call-cross'
393
+ | 'phone-plus'
394
+ | 'phone-slash'
395
+ | 'photo'
396
+ | 'pin'
397
+ | 'pin-1'
398
+ | 'pin-3'
399
+ | 'pin-check'
400
+ | 'pin-circle'
401
+ | 'pin-circle-filled'
402
+ | 'pin-clock'
403
+ | 'pin-filled'
404
+ | 'pin-pen'
405
+ | 'pin-plus'
406
+ | 'pinwheel'
407
+ | 'plus'
408
+ | 'pointer'
409
+ | 'poland'
410
+ | 'portugal'
411
+ | 'pos'
412
+ | 'power-drill'
413
+ | 'power-off'
414
+ | 'print'
415
+ | 'puerto-rico'
416
+ | 'qatar'
417
+ | 'receipt'
418
+ | 'recycle'
419
+ | 'refresh'
420
+ | 'repeat-3'
421
+ | 'republic-congo'
422
+ | 'restaurant-menu'
423
+ | 'rocket'
424
+ | 'romania'
425
+ | 'russia'
426
+ | 'rwanda'
427
+ | 'safety-helmet'
428
+ | 'saint-kitts-nevis'
429
+ | 'saint-lucia'
430
+ | 'saint-vincent-grenadines'
431
+ | 'samoa'
432
+ | 'san-marino'
433
+ | 'sao-tome-principe'
434
+ | 'saudi-arabia'
435
+ | 'scale'
436
+ | 'scotland'
437
+ | 'search-content'
438
+ | 'senegal'
439
+ | 'serbia'
440
+ | 'settings-wrench'
441
+ | 'seychelles'
442
+ | 'shoe-sneakers'
443
+ | 'sidebar-left-hide'
444
+ | 'sidebar-left-show'
445
+ | 'sidebar-right-hide'
446
+ | 'sidebar-right-show'
447
+ | 'sierra-leone'
448
+ | 'signature-2'
449
+ | 'singapore'
450
+ | 'sint-maarten'
451
+ | 'sliders-3'
452
+ | 'sliders-3-vertical'
453
+ | 'slovakia'
454
+ | 'slovenia'
455
+ | 'solomon-islands'
456
+ | 'somalia'
457
+ | 'south-africa'
458
+ | 'south-georgia-sandwich-islands'
459
+ | 'south-korea'
460
+ | 'south-sudan'
461
+ | 'spain'
462
+ | 'sri-lanka'
463
+ | 'star'
464
+ | 'star-1'
465
+ | 'star-half'
466
+ | 'subscription-2'
467
+ | 'sudan'
468
+ | 'suitcase-2'
469
+ | 'sun'
470
+ | 'sun-cloud-bolt'
471
+ | 'sun-cloud-showers'
472
+ | 'sun-cloud-snow'
473
+ | 'suriname'
474
+ | 'sweden'
475
+ | 'switzerland'
476
+ | 'syria'
477
+ | 'tag'
478
+ | 'taiwan'
479
+ | 'tajikistan'
480
+ | 'tanzania'
481
+ | 'thailand'
482
+ | 'timeline-vertical-2'
483
+ | 'togo'
484
+ | 'tonga'
485
+ | 'trash'
486
+ | 'triangle-warning'
487
+ | 'trinidad-tobago'
488
+ | 'trophy'
489
+ | 'truck'
490
+ | 'truck-check'
491
+ | 'truck-clock'
492
+ | 'truck-fast'
493
+ | 'truck-pin'
494
+ | 'tunisia'
495
+ | 'turkey'
496
+ | 'turkmenistan'
497
+ | 'turks-and-caicos-islands'
498
+ | 'tuvalu'
499
+ | 'uganda'
500
+ | 'ukraine'
501
+ | 'united-arab-emirates'
502
+ | 'united-kingdom'
503
+ | 'united-states'
504
+ | 'united-states-virgin-islands'
505
+ | 'unordered-list-2'
506
+ | 'uruguay'
507
+ | 'user'
508
+ | 'user-plus'
509
+ | 'user-star'
510
+ | 'user-substitution'
511
+ | 'users-3'
512
+ | 'uzbekistan'
513
+ | 'vanuatu'
514
+ | 'vatican-city'
515
+ | 'venezuela'
516
+ | 'video'
517
+ | 'vietnam'
518
+ | 'volume'
519
+ | 'volume-disabled'
520
+ | 'volume-down'
521
+ | 'volume-minus'
522
+ | 'volume-off'
523
+ | 'volume-plus'
524
+ | 'volume-up'
525
+ | 'volume-xmark'
526
+ | 'wales'
527
+ | 'western-sahara'
528
+ | 'wind'
529
+ | 'wrench'
530
+ | 'wrench-screwdriver'
531
+ | 'wrench-screwdriver-1'
532
+ | 'xmark'
533
+ | 'yemen'
534
+ | 'yoga'
535
+ | 'yoga-mat'
536
+ | 'zambia'
537
+ | 'zimbabwe';
538
+
539
+ /**
540
+ * Deprecated apollo icon names that map to nucleo names.
541
+ * These names are deprecated and will be removed in the next major release.
542
+ * @deprecated Use the corresponding IconName instead
543
+ */
544
+ export type ApolloName =
545
+ | 'ai'
546
+ | 'alert-circle'
547
+ | 'alert-hex'
548
+ | 'alert-triangle'
549
+ | 'apps'
550
+ | 'archive'
551
+ | 'award'
552
+ | 'briefcase'
553
+ | 'calendar-month'
554
+ | 'calendar-week'
555
+ | 'cash-register'
556
+ | 'check'
557
+ | 'check-circle'
558
+ | 'check-circle-fill'
559
+ | 'chevrons-down'
560
+ | 'chevrons-left'
561
+ | 'chevrons-right'
562
+ | 'chevrons-up'
563
+ | 'circle-slash'
564
+ | 'code-square'
565
+ | 'comment'
566
+ | 'comment-alt'
567
+ | 'comment-check'
568
+ | 'comment-closed'
569
+ | 'comment-discussion'
570
+ | 'comment-minus'
571
+ | 'comment-plus'
572
+ | 'comment-x'
573
+ | 'dash'
574
+ | 'dollar-bill'
575
+ | 'dollar-sign'
576
+ | 'download'
577
+ | 'drag'
578
+ | 'dumbbells'
579
+ | 'duplicate'
580
+ | 'edit'
581
+ | 'expand'
582
+ | 'eye-closed'
583
+ | 'eye-droper'
584
+ | 'flag'
585
+ | 'folder'
586
+ | 'gear'
587
+ | 'globe'
588
+ | 'graph'
589
+ | 'graph-bar'
590
+ | 'heart'
591
+ | 'home'
592
+ | 'image'
593
+ | 'info'
594
+ | 'kebab-horizontal'
595
+ | 'kebab-vertical'
596
+ | 'law'
597
+ | 'layers'
598
+ | 'left-align'
599
+ | 'light-bulb'
600
+ | 'line'
601
+ | 'link-external'
602
+ | 'list-ordered'
603
+ | 'list-unordered'
604
+ | 'loader'
605
+ | 'location'
606
+ | 'mail'
607
+ | 'mail-check'
608
+ | 'mail-closed'
609
+ | 'mail-minus'
610
+ | 'mail-plus'
611
+ | 'mail-x'
612
+ | 'megaphone'
613
+ | 'minus-circle'
614
+ | 'navigation'
615
+ | 'organization'
616
+ | 'package'
617
+ | 'paperclip'
618
+ | 'pencil'
619
+ | 'people'
620
+ | 'percent'
621
+ | 'person'
622
+ | 'person-add'
623
+ | 'person-circle'
624
+ | 'phone-minus'
625
+ | 'phone-pause'
626
+ | 'phone-x'
627
+ | 'pie-chart'
628
+ | 'pin-circle-filled'
629
+ | 'play'
630
+ | 'plus-circle'
631
+ | 'printer'
632
+ | 'question'
633
+ | 'refresh-cw'
634
+ | 'repeat'
635
+ | 'right-align'
636
+ | 'rotate-ccw'
637
+ | 'rotate-cw'
638
+ | 'save'
639
+ | 'search'
640
+ | 'share'
641
+ | 'shopping-bag'
642
+ | 'shopping-cart'
643
+ | 'sign-in'
644
+ | 'sign-out'
645
+ | 'signature'
646
+ | 'sliders-h'
647
+ | 'sliders-v'
648
+ | 'sort'
649
+ | 'star-fill'
650
+ | 'star-half-fill'
651
+ | 'three-bars'
652
+ | 'time-reverse'
653
+ | 'tools'
654
+ | 'trashcan'
655
+ | 'triangle-down'
656
+ | 'triangle-left'
657
+ | 'triangle-right'
658
+ | 'triangle-up'
659
+ | 'unlock'
660
+ | 'upload'
661
+ | 'video-camera'
662
+ | 'x'
663
+ | 'x-circle'
664
+ | 'x-circle-fill'
665
+ | 'zoom-in'
666
+ | 'zoom-out';
667
+
668
+ /**
669
+ * Combined type for any valid icon name (nucleo or apollo).
670
+ * Apollo names are deprecated and will trigger a console warning.
671
+ */
672
+ export type AnyIconName = IconName | ApolloName;
673
+
674
+ declare const octicons: {[K in IconName]: Icon} & {
675
+ /**
676
+ * Returns all icons that have the specified tag/keyword
677
+ */
678
+ getIconsByTag(tag: string): Icon[];
679
+ /**
680
+ * Get an icon by name, with fallback to aliased names.
681
+ * Logs deprecation warning when apollo names are used.
682
+ * @param name - Icon name (nucleo or apollo)
683
+ * @returns The icon object or undefined if not found
684
+ */
685
+ getIcon(name: AnyIconName): Icon | undefined;
686
+ }
687
+
688
+ export default octicons;
689
+ export {octicons};