@pantoken/components 0.2.4 → 0.2.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 (2) hide show
  1. package/dist/index.d.mts +80 -56
  2. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -26,6 +26,30 @@ interface ComponentOptions {
26
26
  theme?: ComponentTheme;
27
27
  }
28
28
  //#endregion
29
+ //#region ../../node_modules/.pnpm/@cssdoc+core@0.7.9/node_modules/@cssdoc/core/dist/lite-CLGf1QSF.d.mts
30
+ /**
31
+ * What kind of CSS surface a record documents. `component` is a namespaced component class with
32
+ * `-modifier`s and parts; `utility` a single-purpose class family; `rule` bare-element/reset styling;
33
+ * `declaration` a custom-property / `@property` registration layer. The record-opening tag chooses it
34
+ * (`@component`/`@utility`/`@rule`/`@declaration`); `@name` is an alias for `component`.
35
+ */
36
+ type CssRecordKind = "component" | "utility" | "rule" | "declaration";
37
+ //#endregion
38
+ //#region src/lib/define.d.ts
39
+ /** A resolved record: `rules(prefix)` emits the doc block plus CSS body for the aggregator, and `css(options)` returns the standalone header-wrapped sheet. */
40
+ interface Definition {
41
+ name: string;
42
+ kind: CssRecordKind;
43
+ /** Doc block + CSS body at the given (already `ns()`-joined) prefix — concatenated by the aggregator. */
44
+ rules(this: void, prefix: string, options?: ComponentOptions): string;
45
+ /**
46
+ * The standalone, header-wrapped stylesheet — what the exported `xxxCss` returns. Declared `this: void`
47
+ * because it's a plain closure (no receiver): callers bind it as `export const buttonCss = button.css`,
48
+ * so the annotation tells the linter the free-floating reference is safe.
49
+ */
50
+ css(this: void, options?: ComponentOptions): string;
51
+ }
52
+ //#endregion
29
53
  //#region src/rules/prose.d.ts
30
54
  /** Options for {@link proseCss}. */
31
55
  interface ProseOptions {
@@ -83,199 +107,199 @@ declare function focusOutlineCss(options?: {
83
107
  //#endregion
84
108
  //#region src/components/button.d.ts
85
109
  /** Standalone `button` stylesheet — the prefixed CSS for the action button, ready to ship as a `.css` file. */
86
- declare const buttonCss: (this: void, options?: ComponentOptions) => string;
110
+ declare const buttonCss: Definition["css"];
87
111
  //#endregion
88
112
  //#region src/components/alert.d.ts
89
113
  /** Standalone `alert` stylesheet — the prefixed CSS for the status message, ready to ship as a `.css` file. */
90
- declare const alertCss: (this: void, options?: ComponentOptions) => string;
114
+ declare const alertCss: Definition["css"];
91
115
  //#endregion
92
116
  //#region src/components/badge.d.ts
93
117
  /** Standalone `badge` stylesheet — the prefixed CSS for the count-and-status badge, ready to ship as a `.css` file. */
94
- declare const badgeCss: (this: void, options?: ComponentOptions) => string;
118
+ declare const badgeCss: Definition["css"];
95
119
  //#endregion
96
120
  //#region src/components/pill.d.ts
97
121
  /** Standalone `pill` stylesheet — the prefixed CSS for the status pill, ready to ship as a `.css` file. */
98
- declare const pillCss: (this: void, options?: ComponentOptions) => string;
122
+ declare const pillCss: Definition["css"];
99
123
  //#endregion
100
124
  //#region src/components/tag.d.ts
101
125
  /** Standalone `tag` stylesheet — the prefixed CSS for the chip, ready to ship as a `.css` file. */
102
- declare const tagCss: (this: void, options?: ComponentOptions) => string;
126
+ declare const tagCss: Definition["css"];
103
127
  //#endregion
104
128
  //#region src/components/avatar.d.ts
105
129
  /** Standalone `avatar` stylesheet — the prefixed CSS for the avatar, ready to ship as a `.css` file. */
106
- declare const avatarCss: (this: void, options?: ComponentOptions) => string;
130
+ declare const avatarCss: Definition["css"];
107
131
  //#endregion
108
132
  //#region src/components/tabs.d.ts
109
133
  /** Standalone `tabs` stylesheet — the prefixed CSS for the tabbed panels, ready to ship as a `.css` file. */
110
- declare const tabsCss: (this: void, options?: ComponentOptions) => string;
134
+ declare const tabsCss: Definition["css"];
111
135
  //#endregion
112
136
  //#region src/components/metric.d.ts
113
137
  /** Standalone `metric` stylesheet — the prefixed CSS for the statistic, ready to ship as a `.css` file. */
114
- declare const metricCss: (this: void, options?: ComponentOptions) => string;
138
+ declare const metricCss: Definition["css"];
115
139
  //#endregion
116
140
  //#region src/components/img.d.ts
117
141
  /** Standalone `img` stylesheet — the prefixed CSS for the styled image, ready to ship as a `.css` file. */
118
- declare const imgCss: (this: void, options?: ComponentOptions) => string;
142
+ declare const imgCss: Definition["css"];
119
143
  //#endregion
120
144
  //#region src/components/byline.d.ts
121
145
  /** Standalone `byline` stylesheet — the prefixed CSS for the media object, ready to ship as a `.css` file. */
122
- declare const bylineCss: (this: void, options?: ComponentOptions) => string;
146
+ declare const bylineCss: Definition["css"];
123
147
  //#endregion
124
148
  //#region src/components/table.d.ts
125
149
  /** Standalone `table` stylesheet — the prefixed CSS for the data table, ready to ship as a `.css` file. */
126
- declare const tableCss: (this: void, options?: ComponentOptions) => string;
150
+ declare const tableCss: Definition["css"];
127
151
  //#endregion
128
152
  //#region src/components/link.d.ts
129
153
  /** Standalone `link` stylesheet — the prefixed CSS for the hyperlink, ready to ship as a `.css` file. */
130
- declare const linkCss: (this: void, options?: ComponentOptions) => string;
154
+ declare const linkCss: Definition["css"];
131
155
  //#endregion
132
156
  //#region src/components/list.d.ts
133
157
  /** Standalone `list` stylesheet — the prefixed CSS for the spaced list, ready to ship as a `.css` file. */
134
- declare const listCss: (this: void, options?: ComponentOptions) => string;
158
+ declare const listCss: Definition["css"];
135
159
  //#endregion
136
160
  //#region src/components/checkbox.d.ts
137
161
  /** Standalone `checkbox` stylesheet — the prefixed CSS for the checkbox and switch, ready to ship as a `.css` file. */
138
- declare const checkboxCss: (this: void, options?: ComponentOptions) => string;
162
+ declare const checkboxCss: Definition["css"];
139
163
  //#endregion
140
164
  //#region src/components/radio.d.ts
141
165
  /** Standalone `radio` stylesheet — the prefixed CSS for the radio button, ready to ship as a `.css` file. */
142
- declare const radioCss: (this: void, options?: ComponentOptions) => string;
166
+ declare const radioCss: Definition["css"];
143
167
  //#endregion
144
168
  //#region src/components/spinner.d.ts
145
169
  /** Standalone `spinner` stylesheet — the prefixed CSS for the loading ring, ready to ship as a `.css` file. */
146
- declare const spinnerCss: (this: void, options?: ComponentOptions) => string;
170
+ declare const spinnerCss: Definition["css"];
147
171
  //#endregion
148
172
  //#region src/components/progress.d.ts
149
173
  /** Standalone `progress` stylesheet — the prefixed CSS for the progress bar, ready to ship as a `.css` file. */
150
- declare const progressCss: (this: void, options?: ComponentOptions) => string;
174
+ declare const progressCss: Definition["css"];
151
175
  //#endregion
152
176
  //#region src/components/menu.d.ts
153
177
  /** Standalone `menu` stylesheet — the prefixed CSS for the dropdown menu, ready to ship as a `.css` file. */
154
- declare const menuCss: (this: void, options?: ComponentOptions) => string;
178
+ declare const menuCss: Definition["css"];
155
179
  //#endregion
156
180
  //#region src/components/modal.d.ts
157
181
  /** Standalone `modal` stylesheet — the prefixed CSS for the dialog surface, ready to ship as a `.css` file. */
158
- declare const modalCss: (this: void, options?: ComponentOptions) => string;
182
+ declare const modalCss: Definition["css"];
159
183
  //#endregion
160
184
  //#region src/components/breadcrumb.d.ts
161
185
  /** Standalone `breadcrumb` stylesheet — the prefixed CSS for the breadcrumb trail, ready to ship as a `.css` file. */
162
- declare const breadcrumbCss: (this: void, options?: ComponentOptions) => string;
186
+ declare const breadcrumbCss: Definition["css"];
163
187
  //#endregion
164
188
  //#region src/components/billboard.d.ts
165
189
  /** Standalone `billboard` stylesheet — the prefixed CSS for the empty-state block, ready to ship as a `.css` file. */
166
- declare const billboardCss: (this: void, options?: ComponentOptions) => string;
190
+ declare const billboardCss: Definition["css"];
167
191
  //#endregion
168
192
  //#region src/components/rating.d.ts
169
193
  /** Standalone `rating` stylesheet — the prefixed CSS for the star rating, ready to ship as a `.css` file. */
170
- declare const ratingCss: (this: void, options?: ComponentOptions) => string;
194
+ declare const ratingCss: Definition["css"];
171
195
  //#endregion
172
196
  //#region src/components/toggle-group.d.ts
173
197
  /** Standalone `toggleGroup` stylesheet — the prefixed CSS for the bordered disclosure, ready to ship as a `.css` file. */
174
- declare const toggleGroupCss: (this: void, options?: ComponentOptions) => string;
198
+ declare const toggleGroupCss: Definition["css"];
175
199
  //#endregion
176
200
  //#region src/components/context-view.d.ts
177
201
  /** Standalone `contextView` stylesheet — the prefixed CSS for the caret callout, ready to ship as a `.css` file. */
178
- declare const contextViewCss: (this: void, options?: ComponentOptions) => string;
202
+ declare const contextViewCss: Definition["css"];
179
203
  //#endregion
180
204
  //#region src/components/progress-circle.d.ts
181
205
  /** Standalone `progressCircle` stylesheet — the prefixed CSS for the progress ring, ready to ship as a `.css` file. */
182
- declare const progressCircleCss: (this: void, options?: ComponentOptions) => string;
206
+ declare const progressCircleCss: Definition["css"];
183
207
  //#endregion
184
208
  //#region src/components/pagination.d.ts
185
209
  /** Standalone `pagination` stylesheet — the prefixed CSS for the page navigation, ready to ship as a `.css` file. */
186
- declare const paginationCss: (this: void, options?: ComponentOptions) => string;
210
+ declare const paginationCss: Definition["css"];
187
211
  //#endregion
188
212
  //#region src/components/truncate.d.ts
189
213
  /** Standalone `truncate` stylesheet — the prefixed CSS for the truncation utility, ready to ship as a `.css` file. */
190
- declare const truncateCss: (this: void, options?: ComponentOptions) => string;
214
+ declare const truncateCss: Definition["css"];
191
215
  //#endregion
192
216
  //#region src/components/toggle-details.d.ts
193
217
  /** Standalone `toggleDetails` stylesheet — the prefixed CSS for the details disclosure, ready to ship as a `.css` file. */
194
- declare const toggleDetailsCss: (this: void, options?: ComponentOptions) => string;
218
+ declare const toggleDetailsCss: Definition["css"];
195
219
  //#endregion
196
220
  //#region src/components/file-drop.d.ts
197
221
  /** Standalone `fileDrop` stylesheet — the prefixed CSS for the file dropzone, ready to ship as a `.css` file. */
198
- declare const fileDropCss: (this: void, options?: ComponentOptions) => string;
222
+ declare const fileDropCss: Definition["css"];
199
223
  //#endregion
200
224
  //#region src/components/side-nav-bar.d.ts
201
225
  /** Standalone `sideNavBar` stylesheet — the prefixed CSS for the navigation rail, ready to ship as a `.css` file. */
202
- declare const sideNavBarCss: (this: void, options?: ComponentOptions) => string;
226
+ declare const sideNavBarCss: Definition["css"];
203
227
  //#endregion
204
228
  //#region src/components/tree-browser.d.ts
205
229
  /** Standalone `treeBrowser` stylesheet — the prefixed CSS for the disclosure tree, ready to ship as a `.css` file. */
206
- declare const treeBrowserCss: (this: void, options?: ComponentOptions) => string;
230
+ declare const treeBrowserCss: Definition["css"];
207
231
  //#endregion
208
232
  //#region src/components/calendar.d.ts
209
233
  /** Standalone `calendar` stylesheet — the prefixed CSS for the month grid, ready to ship as a `.css` file. */
210
- declare const calendarCss: (this: void, options?: ComponentOptions) => string;
234
+ declare const calendarCss: Definition["css"];
211
235
  //#endregion
212
236
  //#region src/components/popover.d.ts
213
237
  /** Standalone `popover` stylesheet — the prefixed CSS for the popover surface, ready to ship as a `.css` file. */
214
- declare const popoverCss: (this: void, options?: ComponentOptions) => string;
238
+ declare const popoverCss: Definition["css"];
215
239
  //#endregion
216
240
  //#region src/components/tray.d.ts
217
241
  /** Standalone `tray` stylesheet — the prefixed CSS for the sliding tray, ready to ship as a `.css` file. */
218
- declare const trayCss: (this: void, options?: ComponentOptions) => string;
242
+ declare const trayCss: Definition["css"];
219
243
  //#endregion
220
244
  //#region src/components/tooltip.d.ts
221
245
  /** Standalone `tooltip` stylesheet — the prefixed CSS for the tooltip bubble, ready to ship as a `.css` file. */
222
- declare const tooltipCss: (this: void, options?: ComponentOptions) => string;
246
+ declare const tooltipCss: Definition["css"];
223
247
  //#endregion
224
248
  //#region src/components/range-input.d.ts
225
249
  /** Standalone `rangeInput` stylesheet — the prefixed CSS for the range slider, ready to ship as a `.css` file. */
226
- declare const rangeInputCss: (this: void, options?: ComponentOptions) => string;
250
+ declare const rangeInputCss: Definition["css"];
227
251
  //#endregion
228
252
  //#region src/components/heading.d.ts
229
253
  /** Standalone `heading` stylesheet — the prefixed CSS for the heading type, ready to ship as a `.css` file. */
230
- declare const headingCss: (this: void, options?: ComponentOptions) => string;
254
+ declare const headingCss: Definition["css"];
231
255
  //#endregion
232
256
  //#region src/components/text.d.ts
233
257
  /** Standalone `text` stylesheet — the prefixed CSS for the body typography, ready to ship as a `.css` file. */
234
- declare const textCss: (this: void, options?: ComponentOptions) => string;
258
+ declare const textCss: Definition["css"];
235
259
  //#endregion
236
260
  //#region src/components/close-button.d.ts
237
261
  /** Standalone `closeButton` stylesheet — the prefixed CSS for the close button, ready to ship as a `.css` file. */
238
- declare const closeButtonCss: (this: void, options?: ComponentOptions) => string;
262
+ declare const closeButtonCss: Definition["css"];
239
263
  //#endregion
240
264
  //#region src/components/text-input.d.ts
241
265
  /** Standalone `textInput` stylesheet — the prefixed CSS for the text input, ready to ship as a `.css` file. */
242
- declare const textInputCss: (this: void, options?: ComponentOptions) => string;
266
+ declare const textInputCss: Definition["css"];
243
267
  //#endregion
244
268
  //#region src/components/text-area.d.ts
245
269
  /** Standalone `textArea` stylesheet — the prefixed CSS for the textarea, ready to ship as a `.css` file. */
246
- declare const textAreaCss: (this: void, options?: ComponentOptions) => string;
270
+ declare const textAreaCss: Definition["css"];
247
271
  //#endregion
248
272
  //#region src/components/simple-select.d.ts
249
273
  /** Standalone `simpleSelect` stylesheet — the prefixed CSS for the native select, ready to ship as a `.css` file. */
250
- declare const simpleSelectCss: (this: void, options?: ComponentOptions) => string;
274
+ declare const simpleSelectCss: Definition["css"];
251
275
  //#endregion
252
276
  //#region src/components/input-group.d.ts
253
277
  /** Standalone `inputGroup` stylesheet — the prefixed CSS for the input group, ready to ship as a `.css` file. */
254
- declare const inputGroupCss: (this: void, options?: ComponentOptions) => string;
278
+ declare const inputGroupCss: Definition["css"];
255
279
  //#endregion
256
280
  //#region src/components/number-input.d.ts
257
281
  /** Standalone `numberInput` stylesheet — the prefixed CSS for the number input, ready to ship as a `.css` file. */
258
- declare const numberInputCss: (this: void, options?: ComponentOptions) => string;
282
+ declare const numberInputCss: Definition["css"];
259
283
  //#endregion
260
284
  //#region src/components/in-place-edit.d.ts
261
285
  /** Standalone `inPlaceEdit` stylesheet — the prefixed CSS for the in-place editor, ready to ship as a `.css` file. */
262
- declare const inPlaceEditCss: (this: void, options?: ComponentOptions) => string;
286
+ declare const inPlaceEditCss: Definition["css"];
263
287
  //#endregion
264
288
  //#region src/components/form-field-messages.d.ts
265
289
  /** Standalone `formFieldMessages` stylesheet — the prefixed CSS for the field messages, ready to ship as a `.css` file. */
266
- declare const formFieldMessagesCss: (this: void, options?: ComponentOptions) => string;
290
+ declare const formFieldMessagesCss: Definition["css"];
267
291
  //#endregion
268
292
  //#region src/components/form-field.d.ts
269
293
  /** Standalone `formField` stylesheet — the prefixed CSS for the form-field wrapper, ready to ship as a `.css` file. */
270
- declare const formFieldCss: (this: void, options?: ComponentOptions) => string;
294
+ declare const formFieldCss: Definition["css"];
271
295
  //#endregion
272
296
  //#region src/components/form-field-group.d.ts
273
297
  /** Standalone `formFieldGroup` stylesheet — the prefixed CSS for the fieldset group, ready to ship as a `.css` file. */
274
- declare const formFieldGroupCss: (this: void, options?: ComponentOptions) => string;
298
+ declare const formFieldGroupCss: Definition["css"];
275
299
  //#endregion
276
300
  //#region src/components/radio-input-group.d.ts
277
301
  /** Standalone `radioInputGroup` stylesheet — the prefixed CSS for the radio group, ready to ship as a `.css` file. */
278
- declare const radioInputGroupCss: (this: void, options?: ComponentOptions) => string;
302
+ declare const radioInputGroupCss: Definition["css"];
279
303
  //#endregion
280
304
  //#region src/components/select.d.ts
281
305
  /**
@@ -304,31 +328,31 @@ declare function selectCss(options?: ComponentOptions): string;
304
328
  //#endregion
305
329
  //#region src/utilities/view.d.ts
306
330
  /** The View utility as a standalone, header-wrapped stylesheet. */
307
- declare const viewCss: (this: void, options?: ComponentOptions) => string;
331
+ declare const viewCss: Definition["css"];
308
332
  //#endregion
309
333
  //#region src/utilities/spacing.d.ts
310
334
  /** The spacing utilities as a standalone, header-wrapped stylesheet. */
311
- declare const spacingUtilitiesCss: (this: void, options?: ComponentOptions) => string;
335
+ declare const spacingUtilitiesCss: Definition["css"];
312
336
  //#endregion
313
337
  //#region src/utilities/layout.d.ts
314
338
  /** The layout utilities as a standalone, header-wrapped stylesheet. */
315
- declare const layoutUtilitiesCss: (this: void, options?: ComponentOptions) => string;
339
+ declare const layoutUtilitiesCss: Definition["css"];
316
340
  //#endregion
317
341
  //#region src/utilities/responsive.d.ts
318
342
  /** The responsive-visibility utilities as a standalone, header-wrapped stylesheet. */
319
- declare const responsiveUtilitiesCss: (this: void, options?: ComponentOptions) => string;
343
+ declare const responsiveUtilitiesCss: Definition["css"];
320
344
  //#endregion
321
345
  //#region src/utilities/icon.d.ts
322
346
  /** The icon utility as a standalone, header-wrapped stylesheet. */
323
- declare const iconCss: (this: void, options?: ComponentOptions) => string;
347
+ declare const iconCss: Definition["css"];
324
348
  //#endregion
325
349
  //#region src/utilities/mask.d.ts
326
350
  /** The mask utility as a standalone, header-wrapped stylesheet. */
327
- declare const maskCss: (this: void, options?: ComponentOptions) => string;
351
+ declare const maskCss: Definition["css"];
328
352
  //#endregion
329
353
  //#region src/utilities/screen-reader-content.d.ts
330
354
  /** The screen-reader-content utility as a standalone, header-wrapped stylesheet. */
331
- declare const screenReaderContentCss: (this: void, options?: ComponentOptions) => string;
355
+ declare const screenReaderContentCss: Definition["css"];
332
356
  //#endregion
333
357
  //#region src/utilities/icon-glyphs.d.ts
334
358
  /** Options for {@link iconGlyphsCss}. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pantoken/components",
3
- "version": "0.2.4",
3
+ "version": "0.2.5",
4
4
  "description": "An InstUI-look CSS component library from the pantoken tokens: prose/content styling plus class-based components (button, alert, badge).",
5
5
  "homepage": "https://pantoken.iywahl.com",
6
6
  "bugs": "https://github.com/thedannywahl/pantoken/issues",