@urbicon-ui/shared-types 6.25.0 → 6.26.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.
- package/README.md +3 -5
- package/package.json +5 -17
package/README.md
CHANGED
|
@@ -20,21 +20,19 @@ Each subpath is consumable on its own so consumers pull in only what they need:
|
|
|
20
20
|
|
|
21
21
|
| Subpath | Contents |
|
|
22
22
|
|---|---|
|
|
23
|
-
| `.` | Barrel — re-exports everything below except `documentation-core` |
|
|
23
|
+
| `.` | Barrel — re-exports everything below except `documentation-core` and `globals`. Includes the component model: `ComponentInfo`, `ComponentStats`, `PropInfo`, `PropSource`, `PropExample`, `VariantInfo`, `VariantExample`, `InheritanceInfo`, `CrossReference`, `PackageInfo` |
|
|
24
24
|
| `./documentation` | `ComponentMetadata`, `DeprecationInfo`, `ComponentBadge`, `SectionOrder`, `LLMConfig` |
|
|
25
25
|
| `./docs-config` | `SvelteDocsConfig`, `DocsPlaygroundConfig`, `VariantsConfig`, `ExamplesConfig`, `ApiConfig`, `OverviewConfig`, `UsageConfig`, `DocsMetadata` |
|
|
26
|
-
| `./
|
|
27
|
-
| `./component-core` | Shared component-core types — the framework-agnostic core of the component model |
|
|
26
|
+
| `./documentation-core` | `DocumentationSection`, `SectionContent`, `ComponentDocumentation`, `DocumentationMetadata` and the section-structure config types |
|
|
28
27
|
| `./examples` | `ComponentExample`, `UsagePattern`, `ExampleCollection`, `ExampleGroup` |
|
|
29
28
|
| `./playground` | `PlaygroundConfig`, `ControlDefinition`, `ControlType`, `ControlOption`, `ControlCondition`, `CodeGenerator`, `CodeGeneratorConfig`, `ImportStatement`, `PlaygroundExample`, `PlaygroundMetadata`, `PlaygroundFeature` |
|
|
30
29
|
| `./navigation` | `NavigationItem`, `NavigationMetadata`, `NavigationState`, `NavigationBadge`, `TableOfContents`, `TOCItem`, `TOCSettings`, `Breadcrumb`, `BreadcrumbItem`, `BreadcrumbSettings`, `SiteNavigation`, `NavigationContext`, `NavigationSearchResult`, `SearchMatch` |
|
|
31
30
|
| `./globals` | Monorepo-wide branded types and constants |
|
|
32
|
-
| `./utilities` | Helper types |
|
|
33
31
|
|
|
34
32
|
## Usage
|
|
35
33
|
|
|
36
34
|
```typescript
|
|
37
|
-
import type { PropInfo, ComponentInfo } from '@urbicon-ui/shared-types
|
|
35
|
+
import type { PropInfo, ComponentInfo } from '@urbicon-ui/shared-types';
|
|
38
36
|
import type { PlaygroundConfig } from '@urbicon-ui/shared-types/playground';
|
|
39
37
|
|
|
40
38
|
const button: ComponentInfo = {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@urbicon-ui/shared-types",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.26.0",
|
|
4
4
|
"description": "Shared TypeScript types for the Urbicon UI design system",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -26,24 +26,16 @@
|
|
|
26
26
|
"import": "./dist/index.js"
|
|
27
27
|
},
|
|
28
28
|
"./docs-config": {
|
|
29
|
-
"types": "./dist/
|
|
30
|
-
"import": "./dist/
|
|
29
|
+
"types": "./dist/docs-config.d.ts",
|
|
30
|
+
"import": "./dist/docs-config.js"
|
|
31
31
|
},
|
|
32
32
|
"./documentation": {
|
|
33
33
|
"types": "./dist/documentation.d.ts",
|
|
34
34
|
"import": "./dist/documentation.js"
|
|
35
35
|
},
|
|
36
36
|
"./documentation-core": {
|
|
37
|
-
"types": "./dist/documentation.d.ts",
|
|
38
|
-
"import": "./dist/documentation.js"
|
|
39
|
-
},
|
|
40
|
-
"./components": {
|
|
41
|
-
"types": "./dist/components.d.ts",
|
|
42
|
-
"import": "./dist/components.js"
|
|
43
|
-
},
|
|
44
|
-
"./component-core": {
|
|
45
|
-
"types": "./dist/component-core.d.ts",
|
|
46
|
-
"import": "./dist/component-core.js"
|
|
37
|
+
"types": "./dist/documentation-core.d.ts",
|
|
38
|
+
"import": "./dist/documentation-core.js"
|
|
47
39
|
},
|
|
48
40
|
"./examples": {
|
|
49
41
|
"types": "./dist/examples.d.ts",
|
|
@@ -57,10 +49,6 @@
|
|
|
57
49
|
"types": "./dist/navigation.d.ts",
|
|
58
50
|
"import": "./dist/navigation.js"
|
|
59
51
|
},
|
|
60
|
-
"./utilities": {
|
|
61
|
-
"types": "./dist/utilities.d.ts",
|
|
62
|
-
"import": "./dist/utilities.js"
|
|
63
|
-
},
|
|
64
52
|
"./globals": {
|
|
65
53
|
"types": "./dist/globals.d.ts",
|
|
66
54
|
"import": "./dist/globals.js"
|