UNPKG

@alaskaairux/auro-icon

Version:

Auro custom auro-icon element

github.com/AlaskaAirlines/auro-icon

AlaskaAirlines/auro-icon

60 lines (45 loc) • 5.03 kB
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
# auro-alaska auro-alaska provides users a way to use the Alaska Airline logos. ## Properties | Property | Attribute | Type | Default | Description | |------------------|------------------|-----------|---------|--------------------------------------------------| | `hidden` | `hidden` | `Boolean` | | If present, the component will be hidden both visually and from screen readers | | `hiddenAudible` | `hiddenAudible` | `Boolean` | | If present, the component will be hidden from screen readers, but seen visually | | `hiddenVisually` | `hiddenVisually` | `Boolean` | | If present, the component will be hidden visually, but still read by screen readers | | `official` | `official` | `Boolean` | | Set value for alaska airlines logo with official tagline | | `onDark` | `onDark` | `Boolean` | false | Set value for on-dark version of auro-icon | ## Slots | Name | Description | |------|--------------------------------------------------| | | Hidden from visibility, used for a11y if icon description is needed | # auro-icon auro-icon provides users a way to use the Auro Icons by simply passing in the category and name. ## Attributes | Attribute | Type | Description | |--------------|-----------|-----------------------------| | `customSize` | `Boolean` | Allows for custom size use. | ## Properties | Property | Attribute | Type | Default | Description | |------------------|------------------|-----------|--------------------------------------------------|--------------------------------------------------| | `accent` | `accent` | `Boolean` | | Sets the icon to use the accent style. | | `advisory` | `advisory` | `Boolean` | | Sets the icon to use the advisory style. | | `ariaHidden` | `ariaHidden` | `String` | | Set aria-hidden value. Default is `true`. Option is `false`. | | `category` | `category` | `String` | | The category of the icon you are looking for. See https://auro.alaskaair.com/icons/usage. | | `customColor` | `customColor` | `Boolean` | | Removes primary selector. | | `disabled` | `disabled` | `Boolean` | | Sets the icon to use the disabled style. | | `emphasis` | `emphasis` | `Boolean` | | Sets the icon to use the emphasis style. | | `error` | `error` | `Boolean` | | Sets the icon to use the error style. | | `hidden` | `hidden` | `Boolean` | | If present, the component will be hidden both visually and from screen readers | | `hiddenAudible` | `hiddenAudible` | `Boolean` | | If present, the component will be hidden from screen readers, but seen visually | | `hiddenVisually` | `hiddenVisually` | `Boolean` | | If present, the component will be hidden visually, but still read by screen readers | | `label` | `label` | `Boolean` | | Exposes content in slot as icon label. | | `name` | `name` | `String` | | The name of the icon you are looking for without the file extension. See https://auro.alaskaair.com/icons/usage | | `onDark` | `onDark` | `Boolean` | false | Set value for on-dark version of auro-icon | | `primary` | `primary` | `Boolean` | | Sets the icon to use the baseline primary icon style. | | `success` | `success` | `Boolean` | | Sets the icon to use the success style. | | `uri` | `uri` | `String` | "https://unpkg.com/@alaskaairux/icons@latest/dist" | Set the uri for CDN used when fetching icons | | `warning` | `warning` | `Boolean` | | Sets the icon to use the warning style. | ## Slots | Name | Description | |------|--------------------------------------------------| | | Hidden from visibility, used for a11y if icon description is needed. |