@supersoniks/concorde 5.0.3 → 5.0.5

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.
Files changed (151) hide show
  1. package/.agents/skills/concorde-component-docs/SKILL.md +194 -0
  2. package/.agents/skills/concorde-component-docs/template.md +45 -0
  3. package/ai/cursor/rules/concorde-theme.mdc +1 -1
  4. package/ai/cursor/rules/concorde.mdc +1 -1
  5. package/ai/skills/concorde/SKILL.md +1 -1
  6. package/ai/skills/concorde-theme/SKILL.md +21 -10
  7. package/build-infos.json +1 -1
  8. package/concorde-core.bundle.js +515 -521
  9. package/concorde-core.es.js +5151 -5056
  10. package/dist/concorde-core.bundle.js +515 -521
  11. package/dist/concorde-core.es.js +5151 -5056
  12. package/dist/docs-mock-api-sw.js +2 -0
  13. package/dist/docs-mock-api-sw.js.map +2 -2
  14. package/docs/assets/index-CD4WyL6o.css +1 -0
  15. package/docs/assets/{index-BnK6OS7w.js → index-wVZpLVYW.js} +815 -808
  16. package/docs/crawl/core/components/ui/alert/alert.html +76 -5
  17. package/docs/crawl/core/components/ui/alert-messages/alert-messages.html +113 -5
  18. package/docs/crawl/core/components/ui/badge/badge.html +57 -8
  19. package/docs/crawl/core/components/ui/captcha/captcha.html +90 -8
  20. package/docs/crawl/core/components/ui/card/card.html +122 -12
  21. package/docs/crawl/core/components/ui/divider/divider.html +117 -31
  22. package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +232 -101
  23. package/docs/crawl/core/components/ui/form/form-actions/form-actions.html +95 -52
  24. package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +97 -38
  25. package/docs/crawl/core/components/ui/group/group.html +60 -38
  26. package/docs/crawl/core/components/ui/icon/icon.html +136 -47
  27. package/docs/crawl/core/components/ui/image/image.html +118 -6
  28. package/docs/crawl/core/components/ui/link/link.html +65 -7
  29. package/docs/crawl/core/components/ui/loader/loader.html +97 -23
  30. package/docs/crawl/core/components/ui/menu/menu.html +162 -90
  31. package/docs/crawl/core/components/ui/modal/modal.html +275 -50
  32. package/docs/crawl/core/components/ui/pop/pop.html +242 -124
  33. package/docs/crawl/core/components/ui/progress/progress.html +103 -30
  34. package/docs/crawl/core/components/ui/table/table.html +303 -171
  35. package/docs/crawl/core/components/ui/theme/theme.html +131 -0
  36. package/docs/crawl/core/components/ui/toast/toast.html +170 -59
  37. package/docs/crawl/core/components/ui/tooltip/tooltip.html +90 -29
  38. package/docs/crawl/docs/_decorators/ancestor-attribute.html +3 -2
  39. package/docs/crawl/docs/_getting-started/start.html +1 -1
  40. package/docs/crawl/docs/_getting-started/theming.html +311 -63
  41. package/docs/crawl/hubs/form-components.html +71 -49
  42. package/docs/crawl/index.html +7 -6
  43. package/docs/docs-mock-api-sw.js +2 -0
  44. package/docs/docs-mock-api-sw.js.map +2 -2
  45. package/docs/index.html +6 -4
  46. package/docs/llms-full.txt +1468 -405
  47. package/docs/llms.txt +23 -30
  48. package/docs/sitemap.xml +3 -0
  49. package/docs/src/core/components/ui/alert/alert.md +21 -2
  50. package/docs/src/core/components/ui/alert-messages/alert-messages.md +85 -0
  51. package/docs/src/core/components/ui/badge/badge.md +19 -6
  52. package/docs/src/core/components/ui/captcha/captcha.md +65 -6
  53. package/docs/src/core/components/ui/card/card.md +73 -10
  54. package/docs/src/core/components/ui/divider/divider.md +107 -13
  55. package/docs/src/core/components/ui/form/fieldset/fieldset.md +175 -99
  56. package/docs/src/core/components/ui/form/form-actions/form-actions.md +75 -52
  57. package/docs/src/core/components/ui/form/form-layout/form-layout.md +109 -34
  58. package/docs/src/core/components/ui/group/group.md +36 -36
  59. package/docs/src/core/components/ui/icon/icon.md +132 -43
  60. package/docs/src/core/components/ui/image/image.md +35 -3
  61. package/docs/src/core/components/ui/link/link.md +43 -5
  62. package/docs/src/core/components/ui/loader/loader.md +79 -22
  63. package/docs/src/core/components/ui/menu/menu.md +133 -92
  64. package/docs/src/core/components/ui/modal/modal.md +163 -47
  65. package/docs/src/core/components/ui/pop/pop.md +217 -123
  66. package/docs/src/core/components/ui/progress/progress.md +76 -30
  67. package/docs/src/core/components/ui/table/table.md +147 -171
  68. package/docs/src/core/components/ui/theme/theme.md +122 -0
  69. package/docs/src/core/components/ui/toast/toast.md +108 -58
  70. package/docs/src/core/components/ui/tooltip/tooltip.md +68 -26
  71. package/docs/src/docs/_decorators/ancestor-attribute.md +3 -2
  72. package/docs/src/docs/_getting-started/start.md +1 -1
  73. package/docs/src/docs/_getting-started/theming.md +223 -61
  74. package/docs/src/docs/search/docs-search.json +2504 -399
  75. package/docs/src/tsconfig.json +18 -0
  76. package/index.html +4 -2
  77. package/package.json +7 -1
  78. package/public/docs-mock-api-sw.js +2 -0
  79. package/public/docs-mock-api-sw.js.map +2 -2
  80. package/src/core/components/ui/_css/align.ts +1 -0
  81. package/src/core/components/ui/_css/type.ts +86 -8
  82. package/src/core/components/ui/_i18n/ui-aria-labels.ts +8 -0
  83. package/src/core/components/ui/alert/alert.md +21 -2
  84. package/src/core/components/ui/alert-messages/alert-messages.md +85 -0
  85. package/src/core/components/ui/badge/badge.md +19 -6
  86. package/src/core/components/ui/badge/badge.ts +8 -9
  87. package/src/core/components/ui/button/button.ts +5 -15
  88. package/src/core/components/ui/captcha/captcha.md +65 -6
  89. package/src/core/components/ui/card/card.md +73 -10
  90. package/src/core/components/ui/card/card.ts +24 -22
  91. package/src/core/components/ui/divider/divider.md +107 -13
  92. package/src/core/components/ui/divider/divider.ts +40 -33
  93. package/src/core/components/ui/form/fieldset/fieldset.md +175 -99
  94. package/src/core/components/ui/form/fieldset/fieldset.ts +15 -28
  95. package/src/core/components/ui/form/fieldset/legend.ts +13 -13
  96. package/src/core/components/ui/form/form-actions/form-actions.md +75 -52
  97. package/src/core/components/ui/form/form-actions/form-actions.ts +7 -5
  98. package/src/core/components/ui/form/form-layout/form-layout.md +109 -34
  99. package/src/core/components/ui/form/form-layout/form-layout.ts +27 -24
  100. package/src/core/components/ui/form/textarea/textarea.ts +4 -3
  101. package/src/core/components/ui/group/group.md +36 -36
  102. package/src/core/components/ui/group/group.ts +5 -10
  103. package/src/core/components/ui/icon/icon.md +132 -43
  104. package/src/core/components/ui/image/image.md +35 -3
  105. package/src/core/components/ui/link/link.md +43 -5
  106. package/src/core/components/ui/loader/loader.md +79 -22
  107. package/src/core/components/ui/loader/loader.ts +67 -27
  108. package/src/core/components/ui/loader/styles/fixed.ts +6 -11
  109. package/src/core/components/ui/menu/menu.md +133 -92
  110. package/src/core/components/ui/menu/menu.ts +53 -58
  111. package/src/core/components/ui/modal/modal.md +163 -47
  112. package/src/core/components/ui/modal/modal.ts +2 -4
  113. package/src/core/components/ui/pop/pop.md +217 -123
  114. package/src/core/components/ui/pop/pop.ts +0 -1
  115. package/src/core/components/ui/progress/progress.md +76 -30
  116. package/src/core/components/ui/progress/progress.ts +25 -56
  117. package/src/core/components/ui/table/table-caption.ts +2 -2
  118. package/src/core/components/ui/table/table-tbody.ts +3 -3
  119. package/src/core/components/ui/table/table-td.ts +23 -18
  120. package/src/core/components/ui/table/table-th.ts +8 -8
  121. package/src/core/components/ui/table/table-tr.ts +4 -4
  122. package/src/core/components/ui/table/table.md +147 -171
  123. package/src/core/components/ui/table/table.ts +20 -19
  124. package/src/core/components/ui/theme/theme-collection/auto.ts +15 -0
  125. package/src/core/components/ui/theme/theme-collection/core-variables.ts +8 -31
  126. package/src/core/components/ui/theme/theme-collection/dark.ts +1 -7
  127. package/src/core/components/ui/theme/theme-collection/light.ts +30 -26
  128. package/src/core/components/ui/theme/theme.md +122 -0
  129. package/src/core/components/ui/theme/theme.ts +30 -7
  130. package/src/core/components/ui/toast/toast-item.ts +6 -9
  131. package/src/core/components/ui/toast/toast.md +108 -58
  132. package/src/core/components/ui/toast/types.ts +1 -1
  133. package/src/core/components/ui/tooltip/tooltip.md +68 -26
  134. package/src/core/decorators/subscriber/ancestorAttribute.spec.ts +26 -0
  135. package/src/core/decorators/subscriber/ancestorAttribute.ts +3 -4
  136. package/src/core/utils/AncestorAttributeObserver.ts +183 -70
  137. package/src/docs/_decorators/ancestor-attribute.md +3 -2
  138. package/src/docs/_getting-started/start.md +1 -1
  139. package/src/docs/_getting-started/theming.md +223 -61
  140. package/src/docs/code.ts +125 -58
  141. package/src/docs/header/header.ts +62 -54
  142. package/src/docs/mock-api/router.ts +2 -0
  143. package/src/docs/navigation/navigation.ts +6 -3
  144. package/src/docs/search/docs-search.json +2504 -399
  145. package/src/docs/search/markdown-renderer.ts +6 -6
  146. package/src/docs/search/search.ts +4 -4
  147. package/src/docs/tailwind/css/tailwind.css +6 -5
  148. package/src/tsconfig.json +18 -0
  149. package/src/tsconfig.tsbuildinfo +1 -1
  150. package/tailwind.config.js +19 -0
  151. package/docs/assets/index--GpD7R7a.css +0 -1
@@ -1,44 +1,119 @@
1
- # Form-layout
1
+ # Form layout
2
+
3
+ **`sonic-form-layout`** arranges slotted form controls in a **responsive CSS grid** with consistent vertical spacing. Pair **`sonic-input`** · **`sonic-select`** and **`sonic-input-autocomplete`** fields side by side when the host is wider than **440px**; **textareas**, **toggles**, **dividers**, and **`sonic-form-actions`** span the full width. Wrap a **`form`** or **`sonic-fieldset`** body—no attributes are required.
4
+
5
+ ## Basic example
6
+
7
+ Typical registration-style form: short fields flow in two columns on wide layouts; long or grouped blocks stay full width.
8
+
9
+ <sonic-code>
10
+ <template>
11
+ <form>
12
+ <sonic-form-layout>
13
+ <sonic-input autocomplete="family-name" label="Last name" name="last_name"></sonic-input>
14
+ <sonic-input autocomplete="given-name" label="First name" name="first_name"></sonic-input>
15
+ <sonic-select autocomplete="sex" label="Gender" name="gender">
16
+ <option value="" selected="selected">— Select —</option>
17
+ <option value="prefer-not">Prefer not to say</option>
18
+ <option value="male">Male</option>
19
+ <option value="female">Female</option>
20
+ </sonic-select>
21
+ <sonic-input autocomplete="bday" label="Date of birth" name="birth_date" type="date"></sonic-input>
22
+ <sonic-divider></sonic-divider>
23
+ <sonic-input autocomplete="email" label="Email" name="email" type="email"></sonic-input>
24
+ <sonic-input
25
+ autocomplete="email"
26
+ label="Confirm email"
27
+ name="email_confirmation"
28
+ type="email"
29
+ ></sonic-input>
30
+ <sonic-input autocomplete="new-password" label="Password" name="password" type="password"></sonic-input>
31
+ <sonic-input
32
+ autocomplete="new-password"
33
+ label="Confirm password"
34
+ name="password_confirmation"
35
+ type="password"
36
+ ></sonic-input>
37
+ <sonic-divider></sonic-divider>
38
+ <sonic-textarea label="Message" rows="5"></sonic-textarea>
39
+ <sonic-switch>Enable optional feature</sonic-switch>
40
+ <sonic-checkbox>Subscribe to newsletter</sonic-checkbox>
41
+ <sonic-checkbox>
42
+ I accept the
43
+ <sonic-link href="#" class="underline">terms and conditions</sonic-link>
44
+ </sonic-checkbox>
45
+ <sonic-form-actions>
46
+ <sonic-button type="success">Submit</sonic-button>
47
+ </sonic-form-actions>
48
+ </sonic-form-layout>
49
+ </form>
50
+ </template>
51
+ </sonic-code>
52
+
53
+ ## Responsive columns
54
+
55
+ When the host **`offsetWidth`** is **greater than 440px**, the grid uses **two equal columns** with slightly larger gap (**1.75rem**). Below that breakpoint, fields stack in a **single column** (**1.5rem** gap).
56
+
57
+ If the slot contains **exactly one** direct **`sonic-input`**, **`sonic-select`**, or **`sonic-input-autocomplete`**, the layout stays **one column** even above the breakpoint so a lone field does not sit in half an empty row.
58
+
59
+ <sonic-code>
60
+ <template>
61
+ <div class="grid gap-8 md:grid-cols-2 mb-6">
62
+ <div>
63
+ <sonic-form-layout style="max-width: 20rem">
64
+ <sonic-divider align="left">Narrow host (single column)</sonic-divider>
65
+ <sonic-input label="Email" name="email_narrow" type="email"></sonic-input>
66
+ <sonic-input label="Confirm email" name="email_confirm_narrow" type="email"></sonic-input>
67
+ </sonic-form-layout>
68
+ </div>
69
+ </div>
70
+ <div>
71
+ <sonic-form-layout>
72
+ <sonic-divider align="left">Wide host (two columns for inputs)</sonic-divider>
73
+ <sonic-input label="Email" name="email_wide" type="email"></sonic-input>
74
+ <sonic-input label="Confirm email" name="email_confirm_wide" type="email"></sonic-input>
75
+ </sonic-form-layout>
76
+ </div>
77
+ </template>
78
+ </sonic-code>
79
+
80
+ ## Full-width slotted blocks
81
+
82
+ Everything except **`sonic-input`**, **`sonic-select`**, **`sonic-input-autocomplete`**, and slotted elements with class **`form-item-container`** is assigned **`grid-column: 1 / -1`**. Use this for **`sonic-textarea`**, **`sonic-checkbox`**, **`sonic-switch`**, **`sonic-form-actions`**, **`sonic-divider`**, and similar blocks.
83
+
84
+ Slotted **`sonic-divider`** sets **`--sc-divider-my: 0`** so divider spacing matches the grid rhythm. Slotted **`sonic-submit`** uses **`display: contents`** so submit controls participate in the grid without an extra wrapper box.
2
85
 
3
86
  <sonic-code>
4
87
  <template>
5
- <form>
6
88
  <sonic-form-layout>
7
- <sonic-input autocomplete="family-name" label="Nom" name="nom"></sonic-input>
8
- <sonic-input autocomplete="given-name" label="Prénom" name="prenom"></sonic-input>
9
- <sonic-select autocomplete="sex" label="Sexe" name="sexe">
10
- <option value="" selected="selected">- Sélectionner -</option>
11
- <option value="-">Je préfère ne pas le dire</option>
12
- <option value="Homme">Homme</option>
13
- <option value="Femme">Femme</option>
14
- </sonic-select>
15
- <sonic-input autocomplete="bday" label="Date de naissance" name="date_naissance" type="date"></sonic-input>
16
- <sonic-divider></sonic-divider>
17
- <sonic-input autocomplete="email" label="e-mail" name="email" type="email"></sonic-input>
18
- <sonic-input
19
- autocomplete="email"
20
- label="Confirmer votre e-mail"
21
- name="email_confirmation"
22
- type="email"
23
- ></sonic-input>
24
- <sonic-input autocomplete="new-password" label="Mot de passe" name="password" type="password"></sonic-input>
25
- <sonic-input
26
- autocomplete="new-password"
27
- label="Confirmer votre mot de passe"
28
- name="password_confirmation"
29
- type="password"
30
- ></sonic-input>
31
- <sonic-divider></sonic-divider>
32
- <sonic-textarea label="Message" rows="5">
33
- </sonic-textarea>
34
- <sonic-switch>Activer une superbe option</sonic-switch>
35
- <sonic-checkbox>Inscription à la newsletter</sonic-checkbox>
36
- <sonic-checkbox>J'ai lu et accepte les <sonic-link href="#" class="underline">Conditions générales de ventes</sonic-link></sonic-checkbox>
89
+ <sonic-input label="Subject" name="subject"></sonic-input>
90
+ <sonic-textarea label="Details" rows="4"></sonic-textarea>
37
91
  <sonic-form-actions>
38
- <sonic-button type="success">Valider</sonic-button>
92
+ <sonic-button type="primary">Send</sonic-button>
39
93
  </sonic-form-actions>
40
94
  </sonic-form-layout>
41
- </form >
42
95
  </template>
43
96
  </sonic-code>
44
97
 
98
+ ## Custom column wrapper
99
+
100
+ Add class **`form-item-container`** on a slotted wrapper (for example a **`div`**) when a field is not a direct **`sonic-input`** / **`sonic-select`** / **`sonic-input-autocomplete`** but should still share the two-column flow with short inputs.
101
+
102
+ <sonic-code>
103
+ <template>
104
+ <sonic-form-layout>
105
+ <sonic-input label="City" name="city"></sonic-input>
106
+ <div class="form-item-container">
107
+ <sonic-input label="Postal code" name="postal_code"></sonic-input>
108
+ </div>
109
+ </sonic-form-layout>
110
+ </template>
111
+ </sonic-code>
112
+
113
+ ## API reference
114
+
115
+ No public attributes — layout follows slotted children and host width.
116
+
117
+ | Slot | Description |
118
+ |------|-------------|
119
+ | *(default)* | Form fields and blocks in visual order; column vs full-width rules apply per slotted tag or **`form-item-container`** class |
@@ -1,6 +1,11 @@
1
1
  # Group
2
2
 
3
+ **`sonic-group`** lays out slotted **`sonic-button`** · **`sonic-input`** and **`sonic-select`** controls in a single horizontal row with **shared corner radius** (first / middle / last items). Optional **`label`** and **`description`** follow form field styling. Use it for **button groups**, **radio rows**, or **input + action** toolbars.
4
+
3
5
  ## Radio group
6
+
7
+ Pair with **`sonic-button`** **`radio`** and a shared **`name`**; ancestor **`formDataProvider`** stores the selected **`value`**.
8
+
4
9
  <sonic-code>
5
10
  <template>
6
11
  <sonic-group formDataProvider="subscriptionData">
@@ -12,10 +17,13 @@
12
17
  </sonic-code>
13
18
 
14
19
  ## Button group
20
+
21
+ Adjacent link or action buttons without merging into one control.
22
+
15
23
  <sonic-code>
16
24
  <template>
17
25
  <sonic-group>
18
- <sonic-button type="info" target="_blank" href="https://wwws.airfrance.fr/">🗼Air France</sonic-button>
26
+ <sonic-button type="info" target="_blank" href="https://wwws.airfrance.fr/">🗼 Air France</sonic-button>
19
27
  <sonic-button type="success" target="_blank" href="https://www.airtahitinui.com/">🌴 Air Tahiti</sonic-button>
20
28
  <sonic-button type="danger" target="_blank" href="https://www.aircorsica.com/">💣 Air Corsica</sonic-button>
21
29
  </sonic-group>
@@ -23,53 +31,45 @@
23
31
  </sonic-code>
24
32
 
25
33
  ## Input actions prefix
34
+
35
+ Action control before the field. **`label`** or **`description`** on **`sonic-group`** annotate the row.
36
+
26
37
  <sonic-code>
27
38
  <template>
28
- <div class="grid grid-cols-3 gap-3">
29
- <sonic-group>
30
- <sonic-button type="info" shape="square">
31
- <sonic-icon library="iconoir" library="iconoir" name="info-empty"></sonic-icon>
32
- </sonic-button>
33
- <sonic-input placeholder="placeholder" ></sonic-input>
34
- </sonic-group>
35
- <sonic-group label="Label">
36
- <sonic-button type="info" shape="square">
37
- <sonic-icon library="iconoir" library="iconoir" name="info-empty"></sonic-icon>
38
- </sonic-button>
39
- <sonic-input ></sonic-input>
40
- </sonic-group>
41
- <sonic-group description="Description">
39
+ <sonic-group label="Label" description="Description">
42
40
  <sonic-button type="info" shape="square">
43
- <sonic-icon library="iconoir" library="iconoir" name="info-empty"></sonic-icon>
41
+ <sonic-icon library="iconoir" name="info-empty"></sonic-icon>
44
42
  </sonic-button>
45
- <sonic-input ></sonic-input>
43
+ <sonic-input></sonic-input>
46
44
  </sonic-group>
47
- </div>
48
45
  </template>
49
46
  </sonic-code>
50
47
 
51
48
  ## Input actions suffix
49
+
50
+ Field first, action after (submit, validate, etc.).
51
+
52
52
  <sonic-code>
53
53
  <template>
54
- <div class="grid grid-cols-3 gap-3">
55
- <sonic-group>
56
- <sonic-input placeholder="placeholder" ></sonic-input>
57
- <sonic-button type="primary" shape="square">
58
- <sonic-icon library="iconoir" library="iconoir" name="check"></sonic-icon>
59
- </sonic-button>
60
- </sonic-group>
61
- <sonic-group label="Label">
62
- <sonic-input ></sonic-input>
63
- <sonic-button type="primary" shape="square">
64
- <sonic-icon library="iconoir" library="iconoir" name="check"></sonic-icon>
65
- </sonic-button>
66
- </sonic-group>
67
- <sonic-group description="Description">
68
- <sonic-input ></sonic-input>
54
+ <sonic-group label="Label" description="Description">
55
+ <sonic-input></sonic-input>
69
56
  <sonic-button type="primary" shape="square">
70
- <sonic-icon library="iconoir" library="iconoir" name="check"></sonic-icon>
57
+ <sonic-icon library="iconoir" name="check"></sonic-icon>
71
58
  </sonic-button>
72
59
  </sonic-group>
73
- </div>
74
60
  </template>
75
- </sonic-code>
61
+ </sonic-code>
62
+
63
+ ## API reference
64
+
65
+ | Attribute | Values | Description |
66
+ |----------|---------|-------------|
67
+ | `label` | string (HTML) | Label above the row; **`slot="label"`** overrides / extends |
68
+ | `description` | string (HTML) | Help text below the row; **`slot="description"`** overrides / extends |
69
+ | `alignItems` | CSS align-items (default `center`) | Cross-axis alignment of the main flex row |
70
+
71
+ | Slot | Description |
72
+ |------|-------------|
73
+ | *(default)* | **`sonic-button`** · **`sonic-input`** · **`sonic-select`** in visual order |
74
+ | `label` | Custom label markup |
75
+ | `description` | Custom description markup |
@@ -1,125 +1,214 @@
1
1
  # Icon
2
2
 
3
+ **`sonic-icon`** renders inline SVG icons from the **bundled core set** or from **CDN libraries**. Set **`name`** (and **`library`** / **`prefix`** when needed); scale with **`size`**. Icons inherit **`currentColor`** and are **`aria-hidden`** by default—keep visible text nearby or label the control that contains them.
3
4
 
4
- ## Custom
5
+ ## Core library
5
6
 
6
- <p >Icons located in the following folder : <span class="text-info">/svg/$prefix/$name.svg<span></p>
7
+ Omit **`library`** to use the bundled set in `icons.json`. Available **`name`** values: `cancel` · `check` · `check-circled-outline` · `emoji-puzzled` · `info-empty` · `loader` · `minus-small` · `more-horiz` · `more-vert` · `nav-arrow-down` · `warning-circled-outline`.
7
8
 
8
- <sonic-code customIconLibraryPath="/svg/$prefix/$name.svg"
9
- customIconDefaultPrefix="regular">
9
+ <sonic-code>
10
10
  <template>
11
- <sonic-scope customIconLibraryPath="/svg/$prefix/$name.svg"
12
- customIconDefaultPrefix="regular">
13
- <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
14
- <div class="text-center">
15
- <sonic-icon library="custom" prefix="regular" name="plane"></sonic-icon>
16
- <br>
17
- <div class="text-xs mt-1">regular</div>
18
- </div>
19
- <div class="text-center">
20
- <sonic-icon library="custom" prefix="solid" name="plane"></sonic-icon>
21
- <br>
22
- <div class="text-xs mt-1">solid</div>
23
- </div>
24
- <div class="text-center">
25
- <sonic-icon library="custom" name="plane"></sonic-icon>
26
- <br>
27
- <div class="text-xs mt-1">default prefix</div>
28
- </div>
11
+ <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
12
+ <div class="text-center">
13
+ <sonic-icon name="cancel" size="lg"></sonic-icon>
14
+ <div class="text-xs mt-1">cancel</div>
29
15
  </div>
30
- </sonic-scope>
16
+ <div class="text-center">
17
+ <sonic-icon name="check" size="lg"></sonic-icon>
18
+ <div class="text-xs mt-1">check</div>
19
+ </div>
20
+ <div class="text-center">
21
+ <sonic-icon name="check-circled-outline" size="lg"></sonic-icon>
22
+ <div class="text-xs mt-1">check-circled-outline</div>
23
+ </div>
24
+ <div class="text-center">
25
+ <sonic-icon name="emoji-puzzled" size="lg"></sonic-icon>
26
+ <div class="text-xs mt-1">emoji-puzzled</div>
27
+ </div>
28
+ <div class="text-center">
29
+ <sonic-icon name="info-empty" size="lg"></sonic-icon>
30
+ <div class="text-xs mt-1">info-empty</div>
31
+ </div>
32
+ <div class="text-center">
33
+ <sonic-icon name="loader" size="lg"></sonic-icon>
34
+ <div class="text-xs mt-1">loader</div>
35
+ </div>
36
+ <div class="text-center">
37
+ <sonic-icon name="minus-small" size="lg"></sonic-icon>
38
+ <div class="text-xs mt-1">minus-small</div>
39
+ </div>
40
+ <div class="text-center">
41
+ <sonic-icon name="more-horiz" size="lg"></sonic-icon>
42
+ <div class="text-xs mt-1">more-horiz</div>
43
+ </div>
44
+ <div class="text-center">
45
+ <sonic-icon name="more-vert" size="lg"></sonic-icon>
46
+ <div class="text-xs mt-1">more-vert</div>
47
+ </div>
48
+ <div class="text-center">
49
+ <sonic-icon name="nav-arrow-down" size="lg"></sonic-icon>
50
+ <div class="text-xs mt-1">nav-arrow-down</div>
51
+ </div>
52
+ <div class="text-center">
53
+ <sonic-icon name="warning-circled-outline" size="lg"></sonic-icon>
54
+ <div class="text-xs mt-1">warning-circled-outline</div>
55
+ </div>
56
+ </div>
31
57
  </template>
32
58
  </sonic-code>
33
59
 
60
+ ## External libraries
61
+
62
+ Set **`library`** to load SVGs from a built-in CDN template. **`prefix`** falls back to each library’s default when omitted (`outline` for **`heroicons`**, **`regular`** for **`fontAwesome`** and **`material`**, and so on).
34
63
 
35
- ## External
36
64
  <sonic-code>
37
65
  <template>
38
66
  <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
39
67
  <sonic-link href="https://heroicons.com/" target="_blank" class="text-center underline">
40
68
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="lg"></sonic-icon>
41
- <br>
69
+ <br />
42
70
  <div class="text-xs mt-1">heroicons</div>
43
71
  </sonic-link>
44
72
  <sonic-link href="https://iconoir.com/" target="_blank" class="text-center underline">
45
- <sonic-icon library="iconoir" name="2x2-cell" size="lg"></sonic-icon>
46
- <br>
73
+ <sonic-icon library="iconoir" name="2x2-cell" size="lg"></sonic-icon>
74
+ <br />
47
75
  <div class="text-xs mt-1">iconoir</div>
48
76
  </sonic-link>
49
77
  <sonic-link href="https://materialdesignicons.com/" target="_blank" class="text-center underline">
50
78
  <sonic-icon library="material" prefix="outline" name="email" size="lg"></sonic-icon>
51
- <br>
79
+ <br />
52
80
  <div class="text-xs mt-1">material design</div>
53
81
  </sonic-link>
54
82
  <sonic-link href="https://fontawesome.com/search?o=r&m=free&s=regular" target="_blank" class="text-center underline">
55
83
  <sonic-icon library="fontAwesome" prefix="regular" name="user" size="lg"></sonic-icon>
56
- <br>
84
+ <br />
57
85
  <div class="text-xs mt-1">fontAwesome regular</div>
58
86
  </sonic-link>
59
87
  <sonic-link href="https://fontawesome.com/search?o=r&m=free&s=solid" target="_blank" class="text-center underline">
60
88
  <sonic-icon library="fontAwesome" prefix="solid" name="book" size="lg"></sonic-icon>
61
- <br>
89
+ <br />
62
90
  <div class="text-xs mt-1">fontAwesome solid</div>
63
91
  </sonic-link>
64
92
  <sonic-link href="https://feathericons.com/" target="_blank" class="text-center underline">
65
- <sonic-icon library="feathers" name="activity" size="lg"></sonic-icon>
66
- <br>
93
+ <sonic-icon library="feathers" name="activity" size="lg"></sonic-icon>
94
+ <br />
67
95
  <div class="text-xs mt-1">feathers</div>
68
96
  </sonic-link>
69
97
  <sonic-link href="https://lucide.dev/" target="_blank" class="text-center underline">
70
- <sonic-icon library="lucide" name="album" size="lg"></sonic-icon>
71
- <br>
98
+ <sonic-icon library="lucide" name="album" size="lg"></sonic-icon>
99
+ <br />
72
100
  <div class="text-xs mt-1">lucide</div>
73
101
  </sonic-link>
74
102
  </div>
75
103
  </template>
76
104
  </sonic-code>
77
105
 
106
+ ## Custom library
107
+
108
+ Use **`library="custom"`** with SVG files on your origin. On an ancestor (for example **`sonic-scope`** or **`sonic-code`**), set **`customIconLibraryPath`** to a URL template with **`$prefix`** and **`$name`** placeholders, and optionally **`customIconDefaultPrefix`** when **`prefix`** is omitted.
109
+
110
+ <sonic-code
111
+ customIconLibraryPath="/svg/$prefix/$name.svg"
112
+ customIconDefaultPrefix="regular"
113
+ >
114
+ <template>
115
+ <sonic-scope
116
+ customIconLibraryPath="/svg/$prefix/$name.svg"
117
+ customIconDefaultPrefix="regular"
118
+ >
119
+ <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
120
+ <div class="text-center">
121
+ <sonic-icon library="custom" prefix="regular" name="plane"></sonic-icon>
122
+ <br />
123
+ <div class="text-xs mt-1">regular</div>
124
+ </div>
125
+ <div class="text-center">
126
+ <sonic-icon library="custom" prefix="solid" name="plane"></sonic-icon>
127
+ <br />
128
+ <div class="text-xs mt-1">solid</div>
129
+ </div>
130
+ <div class="text-center">
131
+ <sonic-icon library="custom" name="plane"></sonic-icon>
132
+ <br />
133
+ <div class="text-xs mt-1">default prefix</div>
134
+ </div>
135
+ </div>
136
+ </sonic-scope>
137
+ </template>
138
+ </sonic-code>
139
+
78
140
  ## Size
141
+
142
+ Omit **`size`** for the default scale (`1em` height). Larger steps use **`3xl`**.
143
+
79
144
  <sonic-code>
80
145
  <template>
81
- <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
146
+ <div class="grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-4 gap-8">
82
147
  <div class="text-center">
83
148
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="2xs"></sonic-icon>
84
- <br>
149
+ <br />
85
150
  <div class="text-xs mt-1">2xs</div>
86
151
  </div>
87
152
  <div class="text-center">
88
153
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="xs"></sonic-icon>
89
- <br>
154
+ <br />
90
155
  <div class="text-xs mt-1">xs</div>
91
156
  </div>
92
157
  <div class="text-center">
93
158
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="sm"></sonic-icon>
94
- <br>
159
+ <br />
95
160
  <div class="text-xs mt-1">sm</div>
96
161
  </div>
97
162
  <div class="text-center">
98
163
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap"></sonic-icon>
99
- <br>
164
+ <br />
100
165
  <div class="text-xs mt-1">default</div>
101
166
  </div>
102
167
  <div class="text-center">
103
168
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="lg"></sonic-icon>
104
- <br>
169
+ <br />
105
170
  <div class="text-xs mt-1">lg</div>
106
171
  </div>
107
172
  <div class="text-center">
108
173
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="xl"></sonic-icon>
109
- <br>
174
+ <br />
110
175
  <div class="text-xs mt-1">xl</div>
111
176
  </div>
112
177
  <div class="text-center">
113
178
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="2xl"></sonic-icon>
114
- <br>
179
+ <br />
115
180
  <div class="text-xs mt-1">2xl</div>
116
181
  </div>
117
182
  <div class="text-center">
118
183
  <sonic-icon library="heroicons" prefix="outline" name="academic-cap" size="3xl"></sonic-icon>
119
- <br>
184
+ <br />
120
185
  <div class="text-xs mt-1">3xl</div>
121
186
  </div>
122
187
  </div>
123
188
  </template>
124
189
  </sonic-code>
125
190
 
191
+ ## Accessibility
192
+
193
+ On connect, the host sets **`aria-hidden="true"`**. Treat icons as decorative unless the surrounding control already has an accessible name. Do not rely on **`sonic-icon`** alone for meaning—use visible text or **`aria-label`** on the parent button / link.
194
+
195
+ <sonic-code>
196
+ <template>
197
+ <sonic-button type="neutral" variant="outline" shape="circle" aria-label="User profile">
198
+ <sonic-icon library="iconoir" name="user"></sonic-icon>
199
+ </sonic-button>
200
+ </template>
201
+ </sonic-code>
202
+
203
+ ## API reference
204
+
205
+ | Attribute | Values | Description |
206
+ |----------|---------|-------------|
207
+ | `name` | string | Icon id in the core bundle or in the remote library |
208
+ | `library` | `heroicons` · `iconoir` · `feathers` · `lucide` · `material` · `fontAwesome` · `custom` | CDN or custom template; omit for bundled core icons |
209
+ | `prefix` | string | Library-specific variant; defaults per library when empty |
210
+ | `size` | `2xs` · `xs` · `sm` · `lg` · `xl` · `2xl` · `3xl` (default `md`) | `em`-based SVG scale on the host |
211
+
212
+ Ancestor attributes (for **`library="custom"`** only): **`customIconLibraryPath`** (URL template with **`$prefix`** and **`$name`**) and **`customIconDefaultPrefix`**. May be set on **`sonic-scope`**, theme roots, or globally in the document.
213
+
214
+ No slots — the component inlines fetched or bundled SVG markup.
@@ -1,6 +1,6 @@
1
1
  # Image
2
2
 
3
- Responsive **`<img>`** wrapper: aspect ratio, `object-fit: cover`, rounded corners, and optional fade-in on load. The host uses a light placeholder background (`--sc-placeholder-bg`) until the file is ready. Default **`loading`** is `lazy`; set **`loading="eager"`** for above-the-fold heroes.
3
+ **`sonic-image`** wraps a responsive **`<img>`** with aspect ratio, `object-fit: cover`, optional rounded corners, and load transitions. The host shows a placeholder background (`--sc-placeholder-bg`) until the asset loads. Default **`loading`** is `lazy`; use **`loading="eager"`** for above-the-fold heroes.
4
4
 
5
5
  ## Rounded
6
6
 
@@ -149,7 +149,7 @@ Click **Add image** to append small thumbnails and replay the transition. **Clea
149
149
  img.ratio = '1/1';
150
150
  img.rounded = 'md';
151
151
  img.loading = 'eager';
152
- img.style.width = '5rem';
152
+ img.style.width = '8rem';
153
153
  img.src = 'https://picsum.photos/seed/' + Date.now() + '/120/120';
154
154
  host.appendChild(img);
155
155
  })()"
@@ -166,7 +166,7 @@ Click **Add image** to append small thumbnails and replay the transition. **Clea
166
166
  img.ratio = '1/1';
167
167
  img.rounded = 'md';
168
168
  img.loading = 'eager';
169
- img.style.width = '5rem';
169
+ img.style.width = '8rem';
170
170
  img.src = 'https://picsum.photos/seed/' + Date.now() + '/120/120';
171
171
  host.appendChild(img);
172
172
  })()"
@@ -199,3 +199,35 @@ Always set meaningful **`alt`** text (empty string only for decorative images).
199
199
  ></sonic-image>
200
200
  </template>
201
201
  </sonic-code>
202
+
203
+ ## API reference
204
+
205
+ | Attribute | Values | Description |
206
+ |----------|---------|-------------|
207
+ | `src` | URL | Image URL passed to `<img src>` |
208
+ | `alt` | string | Accessible description; use `""` only for decorative images |
209
+ | `loading` | `lazy` (default), `eager` | Native lazy loading |
210
+ | `ratio` | CSS ratio, `auto` (default) | Host `aspect-ratio` on the image (ignored when `cover` is set) |
211
+ | `rounded` | `none` (default), boolean, `base`, `sm`, `md`, `lg`, `xl`, `full` | Corner radius from theme tokens; `full` is a circle (often with `ratio="1/1"`) |
212
+ | `objectPosition` | CSS position | Maps to `object-position` (default `center center`) |
213
+ | `imageRendering` | CSS value | Maps to `image-rendering` (default `auto`) |
214
+ | `cover` | boolean | Absolutely fills a positioned parent; host aspect ratio is ignored |
215
+ | `transition` | `fade`, `fade-scale-out` | Opacity (and scale) animation after `load`; remount to replay on `src` change |
216
+
217
+ No slots — content is driven entirely by attributes on the inner `<img>`.
218
+
219
+ ## API reference
220
+
221
+ | Attribute | Values | Description |
222
+ |----------|---------|-------------|
223
+ | `src` | URL | Image URL passed to `<img src>` |
224
+ | `alt` | string | Accessible description; use `""` only for decorative images |
225
+ | `loading` | `lazy` (default), `eager` | Native lazy loading |
226
+ | `ratio` | CSS ratio, `auto` (default) | Host `aspect-ratio` on the image (ignored when `cover` is set) |
227
+ | `rounded` | `none` (default), boolean, `base`, `sm`, `md`, `lg`, `xl`, `full` | Corner radius from theme tokens; `full` is a circle (often with `ratio="1/1"`) |
228
+ | `objectPosition` | CSS position | Maps to `object-position` (default `center center`) |
229
+ | `imageRendering` | CSS value | Maps to `image-rendering` (default `auto`) |
230
+ | `cover` | boolean | Absolutely fills a positioned parent; host aspect ratio is ignored |
231
+ | `transition` | `fade`, `fade-scale-out` | Opacity (and scale) animation after `load`; remount to replay on `src` change |
232
+
233
+ No slots — content is driven entirely by attributes on the inner `<img>`.