@ignite-ember/ui-css 0.0.0-stage → 0.2.0

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 (5) hide show
  1. package/LICENSE +202 -0
  2. package/NOTICE +5 -0
  3. package/README.md +194 -2
  4. package/igni-ui.css +1766 -0
  5. package/package.json +39 -4
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ igni
2
+ Copyright 2026 Ignite Ember
3
+
4
+ This product includes software developed at Ignite Ember
5
+ (https://ignite-ember.sh/).
package/README.md CHANGED
@@ -1,3 +1,195 @@
1
- # Temporary Holding Version
1
+ # igni-ui
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **Full documentation:** [ignite-ember.sh/docs/sdk/ui-css](https://ignite-ember.sh/docs/sdk/ui-css) — guides and the complete API reference, a page per topic.
4
+
5
+ The controls an extension draws with, so a surface built outside igni looks like one built inside it.
6
+
7
+ This is the CSS-only package, `@ignite-ember/ui-css`. The React
8
+ components that draw with it are `@ignite-ember/ui-react`; the bridge
9
+ that themes it is `@ignite-ember/extension-bridge`. You need this
10
+ stylesheet whichever of the other two you use — a component without it
11
+ renders unstyled, and an unstyled button is not a subtle difference.
12
+
13
+ ## Using it
14
+
15
+ Bundle `igni-ui.css` into your extension. Do not link it from igni's origin — your page runs under its own origin with `default-src 'self'`, so a cross-origin stylesheet is refused, and that refusal is deliberate.
16
+
17
+ ```html
18
+ <link rel="stylesheet" href="./igni-ui.css" />
19
+ <body class="igni-root">
20
+ <button class="btn btn-primary">Index this repository</button>
21
+ </body>
22
+ ```
23
+
24
+ Then connect. The bridge applies the live theme before your first paint:
25
+
26
+ ```ts
27
+ import { connect } from "@ignite-ember/extension-bridge";
28
+
29
+ const igni = await connect(); // tokens are on :root by now
30
+ const status = await igni.rpc("ext.acme.scanner.status");
31
+ ```
32
+
33
+ That is the whole setup. No build step is required beyond whatever bundles your own code.
34
+
35
+ ## How theming works
36
+
37
+ Every value in the stylesheet is a token with a fallback.
38
+
39
+ The fallback is igni's dark palette. It is what you see if you open your page on its own, outside igni — so development does not require the app running.
40
+
41
+ Inside igni, the bridge pushes the **live computed values** at handshake and again whenever they change. Your page follows dark mode, light mode, and whatever a group's policy pack has branded, without you writing a line for any of it.
42
+
43
+ Values are pushed rather than baked in, on purpose. `theme.css` defines these across forty-five blocks — a `:root`, a light override, and a `prefers-color-scheme` block per feature. Any second copy of that is wrong within a release.
44
+
45
+ The published token list is in `packages/extension-bridge/src/tokens.ts`, and it is **under the compatibility floor**: removing or repurposing one of those is a breaking change. Tokens not on that list — `--rail-width`, `--sidebar-w`, `--crumb-row-h` — describe igni's own chrome and are ours to change. An extension positioning itself against those would break the first time we moved something.
46
+
47
+ ## The floor
48
+
49
+ Some of this file is promised, and the rest is not. Knowing which is
50
+ which is the difference between a stylesheet you can build on and one
51
+ you have to read every release.
52
+
53
+ **The promised part is the token list.** The tokens published in
54
+ `packages/extension-bridge/src/tokens.ts` are under igni's compatibility
55
+ floor: removing one, renaming it, or giving it a different meaning is
56
+ a breaking change under `docs/EXTENSIBILITY.md` §8. `npm install
57
+ @ignite-ember/extension-bridge` and read that list — it is the
58
+ authoritative one, and the fallbacks in this file are checked against it
59
+ and against `theme.css` by a test.
60
+
61
+ **The promised part is also the class names** the published React
62
+ components render. `btn`, `btn-primary`, `ui-row`, `ui-card` and the
63
+ rest are what a component's `className` is, so a page built out of the
64
+ components and a page built out of the classes by hand look the same.
65
+
66
+ **Everything else is ours to change.** A token that is not on the list
67
+ — `--rail-width`, `--sidebar-w`, `--crumb-row-h` — describes igni's
68
+ own chrome and describes the app's layout, not a control. A class that
69
+ no published component renders is a candidate for removal. An
70
+ extension that positioned itself against either would break the first
71
+ time we moved something, and we would not have warned you, because we
72
+ did not promise it.
73
+
74
+ So: build against the published tokens and the published classes. For
75
+ anything else, the stylesheet is a starting point, not a contract.
76
+
77
+ ## What is here
78
+
79
+ Buttons (`btn`, with `-primary`, `-danger`, `-sm`, `-xs`, `-quiet`), chips, panels, fields, dialogs and the overlay behind them.
80
+
81
+ These are the same class names igni itself uses, so a surface built here reads as part of the app rather than beside it.
82
+
83
+ **They are copies, not one file**, and two tests now hold them to each other.
84
+
85
+ `ui-react/styled.test.ts` reads every `className=` expression in the published package and fails on the first name this file does not define. It also checks every fallback value here, `:root` and inline, against `theme.css`. Generating this file from `theme.css` is still the better fix and is still not done; until it is, these are what stop a difference being invisible.
86
+
87
+ They were written after finding two, neither of which was drift in the sense of a value slowly diverging:
88
+
89
+ - **Seven components were never covered at all.** `OverflowMenu`, `Tooltip`, `Skeleton`, `Monogram`, `MarkdownInline`, `MenuIcon` and the mermaid block named thirty-two classes between them that only `theme.css` defined. Inside the app they looked right — the one environment they are promised for is the one nobody rendered them in. The reference extension did not catch it either, because it happens to import only from `primitives`, which was the covered half.
90
+ - **Eighteen of fifty token fallbacks were a different value from the theme they claim to copy.** Radii at 6/10/14 against the app's 8/12/18, every semantic colour a different hue, a different UI font stack. Standalone is how an extension author develops before they ever mount the thing, so that is what they were tuning against.
91
+
92
+ `btn-warn` — a typed `variant="warn"` rendering as a plain button because the class existed in the app and not here — is the case the scanner cannot see by reading source, since no line contains the string `btn-warn`; it only exists as `btn-${variant}` at runtime. Those names are enumerated explicitly in the test for that reason.
93
+
94
+ Treat a difference as a bug and report it.
95
+
96
+ ## The spacing scale
97
+
98
+ `--space-1` through `--space-16` — 2, 4, 6, 8, 10, 12, 14, 16, 20, 24, 32.
99
+
100
+ Use them for `gap`, `margin` and `padding` and your layout sits on the same rhythm as the app around it, rather than next to it.
101
+
102
+ They are not an invention. They are the steps igni already used, written as literals in 375 places. 85% of gaps and 83% of margins landed on them exactly, which is why adopting them changed nothing on screen — and why the ~60 that stayed literal (`5px`, `3px`, `7px`, `18px`) are now visible as deviations rather than hidden among the rest.
103
+
104
+ ## The type scale
105
+
106
+ `--text-2xs` through `--text-4xl` — 10, 11, 12, 13, 14, 17, 20, 30, 42.
107
+
108
+ Nine steps, down from twenty-two hardcoded sizes that included every half-step from 9px to 15px. `11.5px`, `12px` and `12.5px` between them accounted for 272 declarations: one size written three ways, not three sizes.
109
+
110
+ Collapsed by role rather than by ratio, because the clusters were already there. No value moved by more than 1px, and 98% of font sizes now name a step.
111
+
112
+ One deliberate exception survives, labelled where it lives: a digit inside a 12px circle stays at 7px, because 10px overflows it. A constrained space is a real exception. The half-pixel sizes were not.
113
+
114
+ ## Shape
115
+
116
+ `--radius-sm` 6, `--radius` 10, `--radius-lg` 14, plus `--radius-pill` and `--radius-circle` for the two shapes that are not sizes.
117
+
118
+ `9999px` and `999px` were both in use for pills — identical to a renderer, two things to a reader. Now one.
119
+
120
+ **Padding is 62% on the scale, and the rest is probably right.** The values that stayed literal are overwhelmingly *odd* — 1, 3, 5, 7, 9, 11, 13px — which is the signature of optical correction against a 1px border rather than drift. Forcing them onto even steps would move things by a pixel for no reason. They are visible as literals now, which is the right state for a deliberate exception.
121
+
122
+ ## Primitives
123
+
124
+ `ui-row`, `ui-actions`, `ui-list`, `ui-toolbar`, `ui-card`, `ui-item`, `ui-badge`, `ui-empty`, `ui-table`.
125
+
126
+ These were decided, not extracted. There was very little duplication to extract: the 231 classes named `-row`, `-card`, `-actions` share almost nothing — `*-row` agreed only on `display: flex`, and deduplicating all fourteen patterns saved 84 declarations out of 17,789 lines. They did not repeat, they diverged, each feature choosing its own gaps and paddings because there was no scale to choose from.
127
+
128
+ So where the existing uses agreed, the agreement became the value. Where they split, the split is resolved once with a reason rather than per feature. `ui-empty` is the clearest: its colour was split exactly eight and eight between `--fg-faint` and `--fg-muted`. Both clear WCAG AA since F138, so the tie breaks on meaning — an empty state is text you must read to know what to do next, which makes it content rather than de-emphasised chrome.
129
+
130
+ There is deliberately **no `ui-title`**. Titles varied across four type steps, and that variation is the design — a heading level, not drift. Use the type scale and a weight.
131
+
132
+ **Remaining:** igni's own 231 feature classes still carry their own copies. The primitives exist and are what an extension builds against; migrating the app onto them moves pixels in 64 files, and is worth doing behind the visual suite rather than blind.
133
+
134
+ ## Writing your own CSS
135
+
136
+ The stylesheet is the vocabulary, not the layout. It has no page shell,
137
+ no split pane, no scroll container — those are shapes, and a shape is
138
+ cheap to write and expensive to promise.
139
+
140
+ Write your own on top, in your own file, against the tokens:
141
+
142
+ ```css
143
+ .notes {
144
+ display: grid;
145
+ gap: var(--space-4);
146
+ padding: var(--space-6);
147
+ background: var(--bg-surface);
148
+ border: 1px solid var(--border-soft);
149
+ border-radius: var(--radius);
150
+ }
151
+ ```
152
+
153
+ Three rules that follow from the way this file is built:
154
+
155
+ - **Write against tokens, never against colours.** `var(--fg-muted)`,
156
+ not `#b8b5ad`. A literal colour is a value that does not follow dark
157
+ mode, light mode, or a group's branding — and it is a value the
158
+ bridge cannot push over.
159
+ - **Do not edit the published stylesheet.** It is a published artifact;
160
+ your edit is lost the next time you install. Layer yours after it.
161
+ - **Do not redefine a token to mean something else.** Overriding
162
+ `--space-4` to `3px` changes every gap in the app's vocabulary, in
163
+ your page, at once. If you need a different value, use your own
164
+ variable and point the class at it.
165
+
166
+ The reference pages on the site list every token this file defines and
167
+ every class it names, with where each is used — so before you write a
168
+ rule, it is worth checking that the class you were about to invent
169
+ already exists.
170
+
171
+ ## Installing
172
+
173
+ This stylesheet is `@ignite-ember/ui-css` on npm; the bridge and the React
174
+ components are `@ignite-ember/extension-bridge` and `@ignite-ember/ui-react`:
175
+
176
+ ```bash
177
+ npm install @ignite-ember/ui-css @ignite-ember/extension-bridge @ignite-ember/ui-react
178
+ ```
179
+
180
+ ```ts
181
+ import "@ignite-ember/ui-css";
182
+ ```
183
+
184
+ Each release's tarballs are also attached to igni's GitHub release
185
+ (`sdk-v<version>`), for a build that cannot reach npmjs.
186
+
187
+ ## What an extension still cannot do
188
+
189
+ Worth knowing before you design around it:
190
+
191
+ - **Be installed.** Calling your own backend works — `ext.<your-id>.<method>` is a real namespace, authorised against your manifest's `permissions.rpc` and routed to your service as an MCP tool call. What does not exist yet is the pipeline that starts your sidecar or registers your endpoint, so there is nothing to route *to* outside a test.
192
+ - **Receive a push.** The host sends `hello`, `theme` and `result`. Following a long-running job means polling an RPC on an interval.
193
+ - **Be mounted.** Nothing renders `ExtensionFrame` in the app yet, and no manifest loader exists.
194
+
195
+ These are named here rather than left to be discovered three days into a build.